Search_Controller_Driver
extends Core_Servant_Properties
in package
AbstractYes
Search.
Tags
Table of Contents
Properties
- $_allowedProperties : array<string|int, mixed>
- Allowed object properties
- $_asObject : string
- $_config : array<string|int, mixed>
- Config
- $_propertiesValues : array<string|int, mixed>
- Properties values
- $_unlimitedProperties : bool
- Object has unlimited number of properties
Methods
- __construct() : mixed
- Constructor
- addAllowedProperties() : self
- Add additional allowed properties
- addAllowedProperty() : self
- Add additional allowed property
- asObject() : self
- Set object
- find() : array<string|int, mixed>
- Find
- set() : self
- Run when writing data to inaccessible properties
- setConfig() : self
- Set config
- setUnlimitedProperties() : self
- Set unlimitedProperties
- truncate() : self
- Remove all indexed data
- getPageCount() : string
- Get pages count
Properties
$_allowedProperties
Allowed object properties
protected
array<string|int, mixed>
$_allowedProperties
= array(
'site',
'offset',
'page',
'limit',
'modules',
'inner',
'total',
'orderField',
// weight, datetime
'orderDirection',
)
$_asObject
protected
string
$_asObject
= 'Search_Page_Model'
$_config
Config
protected
array<string|int, mixed>
$_config
= array()
$_propertiesValues
Properties values
protected
array<string|int, mixed>
$_propertiesValues
= array()
$_unlimitedProperties
Object has unlimited number of properties
protected
bool
$_unlimitedProperties
= \FALSE
Methods
__construct()
Constructor
public
__construct(array<string|int, mixed> $aConfig) : mixed
Parameters
- $aConfig : array<string|int, mixed>
addAllowedProperties()
Add additional allowed properties
public
addAllowedProperties(array<string|int, mixed> $array) : self
Parameters
- $array : array<string|int, mixed>
-
array of properties' names
Return values
selfaddAllowedProperty()
Add additional allowed property
public
addAllowedProperty(string $property) : self
Parameters
- $property : string
-
property name
Return values
selfasObject()
Set object
public
asObject(mixed $objectName) : self
Parameters
- $objectName : mixed
Return values
selffind()
Find
public
abstract find(string $query) : array<string|int, mixed>
Parameters
- $query : string
-
Search query
Tags
Return values
array<string|int, mixed> —Array of Search_Page_Model
set()
Run when writing data to inaccessible properties
public
set(string $property, string $value) : self
Parameters
- $property : string
-
property name
- $value : string
-
property value
Return values
selfsetConfig()
Set config
public
setConfig(array<string|int, mixed> $aConfig) : self
Parameters
- $aConfig : array<string|int, mixed>
Return values
selfsetUnlimitedProperties()
Set unlimitedProperties
public
setUnlimitedProperties([bool $value = TRUE ]) : self
Parameters
- $value : bool = TRUE
-
default TRUR
Return values
selftruncate()
Remove all indexed data
public
abstract truncate() : self
Return values
selfgetPageCount()
Get pages count
protected
abstract getPageCount(int $site_id) : string
Parameters
- $site_id : int
-
site ID
Return values
string —count of pages