#[Scope]

About 346 wordsAbout 1 min

annotationsbehavioreloquent-scope

Stage

BEHAVIOR — runs after all control, transform, and validate attributes, directly before the filter method executes.

Automatically applies an Eloquent local scope on the query builder, passing the payload value to the scope. This allows you to reuse your model's scope methods directly from filter attributes.

Parameters

Parameter	Type	Required	Description
`$scope`	`string`	✅	The scope name (without the `scope` prefix on the model)

Usage

Model with Scope

// App\Models\Post
class Post extends Model
{
    public function scopeActive(Builder $query, $value = null): Builder
    {
        return $query->where('status', $value ?? 'active');
    }

    public function scopePopular(Builder $query, $minViews = 100): Builder
    {
        return $query->where('views', '>=', $minViews);
    }
}

Filter Class

use Kettasoft\Filterable\Engines\Foundation\Attributes\Annotations\Scope;

#[Scope('active')]
protected function status(Payload $payload)
{
    // The scope is applied automatically before this method runs.
    // The scope receives $payload->value as its argument.
    // This method body also executes after the scope.
}

Using Popular Scope

#[Scope('popular')]
protected function minViews(Payload $payload)
{
    // Calls: $query->popular($payload->value)
    // e.g., $query->where('views', '>=', 500)
}

How It Works

The attribute checks that the scope method exists on the model (scope{Name}).
It calls $query->{scopeName}($payload->value) on the query builder.
It sets scope_applied = true in the attribute context state.
The filter method still executes after the scope is applied.

Behavior

Scenario	Result
Scope exists on the model	Scope is applied, then filter method executes
Scope does not exist	`InvalidArgumentException` (caught by engine pipeline)

Combining with Other Attributes

#[SkipIf('empty')]
#[Trim]
#[Sanitize('lowercase')]
#[In('active', 'pending', 'archived')]
#[Scope('active')]
protected function status(Payload $payload)
{
    // 1. Skip if empty
    // 2. Trim whitespace
    // 3. Lowercase
    // 4. Validate against allowed values
    // 5. Apply the 'active' scope with the value
    // 6. Filter method body runs
}