FilterObject
in package
implements
FilterObjectInterface, ThingInterface
Class FilterObject
Tags
Table of Contents
Interfaces
- FilterObjectInterface
- Interface FilterObjectInterface
- ThingInterface
- Interface ThingInterface
Properties
- $defaultArgs : array<string|int, mixed>
- $filter : FilterInterface
Methods
- __construct() : mixed
- creates a new FilterObject.
- addAttributeFilter() : void
- addClassification() : void
- addContentId() : void
- addCreatedAt() : void
- addDeletedAt() : void
- addFilterId() : void
- addGeoBox() : void
- addGeoPerimeter() : void
- addGeoShapes() : void
- addLinked() : void
- addModifiedAt() : void
- addSchedule() : void
- addSearch() : void
- addUnion() : void
- addWatchListId() : void
- getArguments() : array<string|int, mixed>
- getFilter() : array<string|int, mixed>
- setFilter() : void
- getValueObject() : mixed
Properties
$defaultArgs
protected
static array<string|int, mixed>
$defaultArgs
= ['attribute' => ['type' => 'value', 'valid' => ['Array'], 'doc' => 'set attribute filter', 'fn' => [__CLASS__, 'addModifiedAt(array $dateRange, bool $exclude = false)', 'addCreatedAt(array $dateRange, bool $exclude = false)', 'addDeletedAt(array $dateRange, bool $exclude = false)', 'addSchedule(array $dateRange, bool $exclude = false)'], 'default' => []], 'classifications' => ['type' => 'value', 'valid' => ['Array'], 'doc' => 'set classification filter', 'fn' => [__CLASS__, 'addClassification(array $classification, bool $withSubtree = false, bool $exclude = false)'], 'default' => []], 'contentId' => ['type' => 'value', 'valid' => ['Array'], 'doc' => 'set contentId filter', 'fn' => [__CLASS__, 'addContentId(array $contentId, bool $exclude = false)'], 'default' => []], 'filterId' => ['type' => 'value', 'valid' => ['Array'], 'doc' => 'set filterId filter', 'fn' => [__CLASS__, 'addFilterId(array $filterId, bool $exclude = false)'], 'default' => []], 'geo' => ['type' => 'value', 'valid' => ['Array'], 'doc' => 'set geographic filter', 'fn' => [__CLASS__, 'addGeoBox(array $box, bool $exclude = false)', 'addGeoPerimeter(array $location, bool $exclude = false)', 'addGeoShapes(array $shape, bool $exclude = false)'], 'default' => []], 'linked' => ['type' => 'value', 'valid' => ['Array'], 'doc' => 'set linked filter. FilterObject must be used.', 'fn' => [__CLASS__, 'addLinked(string $linkedAttribute, FilterObject $filterObject)'], 'default' => []], 'search' => ['type' => 'value', 'valid' => ['string'], 'doc' => 'set fulltext search', 'fn' => [__CLASS__, 'addSearch(string $search)'], 'default' => []], 'union' => ['type' => 'value', 'valid' => ['Array'], 'doc' => 'set union filter. FilterObject must be used.', 'fn' => [__CLASS__, 'addUnion(array $filterObject)'], 'default' => []], 'watchListId' => ['type' => 'value', 'valid' => ['Array'], 'doc' => 'set watchListId filter', 'fn' => [__CLASS__, 'addWatchListId(array $watchListId, bool $exclude = false)'], 'default' => []]]
$filter
private
FilterInterface
$filter
Methods
__construct()
creates a new FilterObject.
public
__construct([array<string|int, mixed> $args = [] ][, FilterFactoryInterface|null $filterFactory = null ]) : mixed
Parameters
- $args : array<string|int, mixed> = []
- $filterFactory : FilterFactoryInterface|null = null
addAttributeFilter()
public
addAttributeFilter(string $min, string $max, string $attribute) : void
APIYes
Parameters
- $min : string
- $max : string
- $attribute : string
addClassification()
public
addClassification(array<string|int, mixed> $classification[, bool|null $withSubtree = false ][, bool|null $exclude = false ]) : void
APIYes
Parameters
- $classification : array<string|int, mixed>
- $withSubtree : bool|null = false
- $exclude : bool|null = false
addContentId()
public
addContentId(array<string|int, mixed> $contentId[, bool|null $exclude = false ]) : void
APIYes
Parameters
- $contentId : array<string|int, mixed>
- $exclude : bool|null = false
addCreatedAt()
public
addCreatedAt(array<string|int, mixed> $dateRange[, bool|null $exclude = false ]) : void
APIYes
Parameters
- $dateRange : array<string|int, mixed>
- $exclude : bool|null = false
addDeletedAt()
public
addDeletedAt(array<string|int, mixed> $dateRange[, bool|null $exclude = false ]) : void
APIYes
Parameters
- $dateRange : array<string|int, mixed>
- $exclude : bool|null = false
addFilterId()
public
addFilterId(array<string|int, mixed> $filterId[, bool|null $exclude = false ]) : void
APIYes
Parameters
- $filterId : array<string|int, mixed>
- $exclude : bool|null = false
addGeoBox()
public
addGeoBox(array<string|int, mixed> $box[, bool|null $exclude = false ]) : void
APIYes
Parameters
- $box : array<string|int, mixed>
- $exclude : bool|null = false
addGeoPerimeter()
public
addGeoPerimeter(array<string|int, mixed> $location[, bool|null $exclude = false ]) : void
APIYes
Parameters
- $location : array<string|int, mixed>
- $exclude : bool|null = false
addGeoShapes()
public
addGeoShapes(array<string|int, mixed> $shape[, bool|null $exclude = false ]) : void
APIYes
Parameters
- $shape : array<string|int, mixed>
- $exclude : bool|null = false
addLinked()
public
addLinked(string $linkedAttribute, FilterObjectInterface $filterObject) : void
APIYes
Parameters
- $linkedAttribute : string
- $filterObject : FilterObjectInterface
addModifiedAt()
public
addModifiedAt(array<string|int, mixed> $dateRange[, bool|null $exclude = false ]) : void
APIYes
Parameters
- $dateRange : array<string|int, mixed>
- $exclude : bool|null = false
addSchedule()
public
addSchedule(array<string|int, mixed> $dateRange[, bool|null $exclude = false ]) : void
APIYes
Parameters
- $dateRange : array<string|int, mixed>
- $exclude : bool|null = false
addSearch()
public
addSearch(string $search) : void
APIYes
Parameters
- $search : string
addUnion()
public
addUnion(array<string|int, FilterObjectInterface> $filterObject) : void
APIYes
Parameters
- $filterObject : array<string|int, FilterObjectInterface>
addWatchListId()
public
addWatchListId(array<string|int, mixed> $watchListId[, bool|null $exclude = false ]) : void
APIYes
Parameters
- $watchListId : array<string|int, mixed>
- $exclude : bool|null = false
getArguments()
public
static getArguments() : array<string|int, mixed>
APIYes
Return values
array<string|int, mixed>getFilter()
public
getFilter() : array<string|int, mixed>
APIYes
Return values
array<string|int, mixed>setFilter()
public
setFilter(array<string|int, mixed> $filter) : void
APIYes
Parameters
- $filter : array<string|int, mixed>
getValueObject()
private
getValueObject(mixed $value, string $type) : mixed
Parameters
- $value : mixed
- $type : string
Attributes
- #[ReturnTypeWillChange]