Group Scope

group - filter using a group of multiple items, usually by a related model or an array of predefined options.

To filter by a model, specify the modelClass and nameFrom properties to specify which model and attribute to use.

roles:
    label: Role
    type: group
    nameFrom: name
    modelClass: October\Test\Models\Role

The following properties are available for the filter.

To filter by an array, specify an options property.

status:
    label: Role
    type: group
    options:
        developer: Developer
        publisher: Publisher

You may pass custom SQL to the conditions as a string where :value contains the filtered value.

status:
    label: Role
    type: group
    conditions: role in (:value)
    # ...

You may also pass a default value as an array with selected keys.

status:
    # ...
    default:
        - developer
        - publisher

# PHP Interface

You may define a custom modelScope in the model using the following example.

roles:
    label: Role
    type: group
    nameFrom: name
    modelClass: October\Test\Models\Role
    modelScope: groupFilter

The scopeGroupFilter method definition where the value is found in $scope->value.

public function scopeGroupFilter($query, $scope)
{
    return $query->whereHas('roles', function($q) use ($scope) {
        $q->whereIn('id', $scope->value);
    });
}

You may dynamically supply options by passing a model method to the optionsMethod property.

roles:
    label: Role
    type: group
    nameFrom: name
    modelClass: October\Test\Models\Role
    optionsMethod: getRoleGroupOptions

The getRoleGroupOptions method definition.

public function getRoleGroupOptions()
{
    return $this->whereNull('parent_id')->pluck('name', 'id')->all();
}

The optionsScope property allows you to apply a scope to the default query that locates the available options.

roles:
    label: Role
    type: group
    nameFrom: name
    modelClass: October\Test\Models\Role
    optionsScope: applyRoleOptionsFilter

public function scopeApplyRoleOptionsFilter($query)
{
    return $query->where('id', '<>', 1);
}