tflori/orm

» API Reference » ORM\EntityFetcher\AppliesFilters

ORM\EntityFetcher\AppliesFilters

Table of Contents

• Abstract
• Methods
  • $appliesFilters->filter - Apply an additional $filter before executing
  • AppliesFilters::getGlobalFilters - Get the filters registered for $class
  • AppliesFilters::registerGlobalFilter - Register $filter globally for $class
  • $appliesFilters->withoutFilter - Exclude $filterClass for this fetcher

Abstract

Methods

ORM\EntityFetcher\AppliesFilters::filter

public function filter(
    string|\ORM\EntityFetcher\FilterInterface|callable $filter, 
): $this

Apply an additional $filter before executing

Parameters

ORM\EntityFetcher\AppliesFilters::filter

↑ top

ORM\EntityFetcher\AppliesFilters::getGlobalFilters

public static function getGlobalFilters(string $class): array

Get the filters registered for $class

A filter can be registered for the super class too.

Parameters

ORM\EntityFetcher\AppliesFilters::getGlobalFilters

↑ top

ORM\EntityFetcher\AppliesFilters::registerGlobalFilter

public static function registerGlobalFilter(
    mixed $class, 
    string|\ORM\EntityFetcher\FilterInterface|callable $filter, 
): mixed

Register $filter globally for $class

A registered filter will be applied in all entity fetchers for the class if not excluded by $fetcher->withoutFilter(Filter::class).

Parameters

ORM\EntityFetcher\AppliesFilters::registerGlobalFilter

↑ top

ORM\EntityFetcher\AppliesFilters::withoutFilter

public function withoutFilter(string $filterClass): $this

Exclude $filterClass for this fetcher

Parameters

ORM\EntityFetcher\AppliesFilters::withoutFilter

↑ top