Revision: Tue, 16 Aug 2022 19:49:12 GMT

Scope

Every query generated for the entity selection (directly or via relation) might pass through the defined scope. Scopes are used to define global query limits or/and filter entity by one of its relations.

Scope schema

In some cases, you can disable scope usage on root query to get access to unfiltered entities. Use $select->scope(null) to do that.

Example

A simple example can demonstrate how to only select entities which are not marked as deleted:

use Cycle\ORM\Select;

class NotDeletedScope implements Select\ScopeInterface
{
    public function apply(Select\QueryBuilder $query)
    {
        $query->where('deleted_at', '=', null);
    }
}

Scope can be assigned to any entity via schema, in case of annotated extension:

use Cycle\Annotated\Annotation\Entity;

#[Entity(scope: NotDeletedScope::class)]
class User
{
    // ...
}
Edit this page