MutableSearchDemand extends SearchDemand
FinalYes
Holds necessary data to query data from a search provider
for internal use only, no public API
Table of Contents
Constants
- DEFAULT_LIMIT = 20
Properties
- $demandProperties : array<string|int, DemandProperty>
Methods
- __construct() : mixed
- freeze() : SearchDemand
- fromRequest() : static
- fromSearchDemand() : self
- getLimit() : int
- getOffset() : int
- getPageId() : int
- getProperties() : array<string|int, DemandProperty>
- getProperty() : DemandProperty|null
- getQuery() : string
- getSearchProviders() : array<string|int, SearchProviderInterface>>
- setProperty() : self
Constants
DEFAULT_LIMIT
public
mixed
DEFAULT_LIMIT
= 20
Properties
$demandProperties
protected
array<string|int, DemandProperty>
$demandProperties
= []
Methods
__construct()
public
final __construct([array<string|int, DemandProperty> $demandProperties = [] ]) : mixed
Parameters
- $demandProperties : array<string|int, DemandProperty> = []
freeze()
public
freeze() : SearchDemand
Return values
SearchDemandfromRequest()
public
static fromRequest(ServerRequestInterface $request) : static
Parameters
- $request : ServerRequestInterface
Return values
staticfromSearchDemand()
public
static fromSearchDemand(SearchDemand $searchDemand) : self
Parameters
- $searchDemand : SearchDemand
Return values
selfgetLimit()
public
getLimit() : int
Return values
intgetOffset()
public
getOffset() : int
Return values
intgetPageId()
public
getPageId() : int
Return values
intgetProperties()
public
getProperties() : array<string|int, DemandProperty>
Return values
array<string|int, DemandProperty>getProperty()
public
getProperty(DemandPropertyName $demandPropertyName) : DemandProperty|null
Parameters
- $demandPropertyName : DemandPropertyName
Return values
DemandProperty|nullgetQuery()
public
getQuery() : string
Return values
stringgetSearchProviders()
public
getSearchProviders() : array<string|int, SearchProviderInterface>>
Return values
array<string|int, SearchProviderInterface>>setProperty()
public
setProperty(DemandPropertyName $name, mixed $value) : self
Parameters
- $name : DemandPropertyName
- $value : mixed