Search by scope

[jaulz]

It would be nice if there was a way to specify a scope on a search property that would be used instead of using operators.

[LastDragon-ru]

Do you mean Eloquent Model scope or just a set of predefined operators?

[jaulz]

I thought we can just take the value as it is (string, integer etc.) and pass it to the scope method of the query builder as the first parameter. No need to introspect anything because the scope name is passed to the directive.

Custom operators have the downside that they are global and I just need it for one type.

[LastDragon-ru]

I thought we can just take the value as it is (string, integer etc.) and ...

The main problem is the point (1). There are several ways how to assign Type to Model (directories, @model, maybe something else). Also, there is @namespace directive that seems may affect how the class resolves (I'm even not sure that this directive supported now...).

Custom operators have the downside that they are global and I just need it for one type.

Actually, you can use Operator::isAvailable($source) to limit the type. But I agree, this is more side effect rather than expected usage.

lara-asp/packages/graphql/src/Builder/Contracts/Operator.php

Line 19 in 31279fa

public function isAvailable(TypeProvider $provider, TypeSource $source, Context $context): bool;

Will be good to be able to add different operators directly in graphql schema. Current version allows to add Object operator (like relationship) to a type definition (or to a field). But I'm not sure how it should look for Extra operators to avoid any conflicts and confusions (with Object and other types).

[jaulz]

Hmm, I still don't understand why we need to access any model at generation phase. If you take my example:

type TagFilters {
  name: String @searchByScope(name: "ofName")
}

I indicated that the value is a string and that the scope ofName should be used. Now, couldn't we simply use the existing builder? Something like this:

if ($node->hasDirective('searchByScope')) {
  $directive = $node->getDirective('searchByScope');
  $scopeName = $directive->getAttribute('ofName');
  $value = $node->getValue();
  
  $builder->{$scopeName}($value);
} else {
  // Cover the existing cases
}

At generation phase we can just leave the filters that are annotated with @searchByScope and leave the type as it is.

[LastDragon-ru]

Hmm, I still don't understand why we need to access any model at generation phase

The whole idea of this library is to provide deterministic and error free schema :) In your example the client should know the scopes or it will get an error.

I feel it might be something like:

items(
   where: {
     anyOf: [
        scope: { ofName: { name: "a" } }
        scope: { ofName: { name: "b" } }
     ],
   }
) { ... } 

[jaulz]

Okay, now I got your point 😊 Though, I must admit that I don't really like that approach since it exposes internal information. The user shouldn't know whether it's a scope or not. He should just pass a value to a field and the framework should work according to the definition of the developer (e.g. via operator or via @searchByScope).