Interface LaravelUi5\OData\Service\Contracts\EntitySetSourceInterface

Formal contract for SQL-backed entity set data sources.

Implementations provide the base query for an entity set, including any implicit filters (tenant scoping, user permissions, etc.). OData system query options ($filter, $orderby, $top, $skip) are applied on top by the resolver — they never override the base query's constraints.

Implementations are resolved from the Laravel container so that dependencies (e.g., the current tenant or authenticated user) are injected automatically.

Example:

final readonly class PartnerValueHelpSource implements EntitySetSourceInterface { public function __construct(private TenantContext $tenant) {}

public function query(): Builder { return DB::table('partner_value_help') ->where('tenant_id', $this->tenant->id); } }

Methods