Search_Controller_Hostcms
extends Search_Controller_Driver
in package
Search.
Tags
Table of Contents
- $_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
- __construct() : mixed
- Constructor.
- addAllowedProperties() : self
- Add additional allowed properties
- addAllowedProperty() : self
- Add additional allowed property
- asObject() : self
- Set object
- deleteSearchPage() : self
- Delete search page
- find() : array<string|int, mixed>
- Find
- getPageCount() : string
- Get pages count
- indexingSearchPages() : bool
- Indexing search pages
- set() : self
- Run when writing data to inaccessible properties
- setConfig() : self
- Set config
- setUnlimitedProperties() : self
- Set unlimitedProperties
- truncate() : self
- Remove all indexed data
- _foundRows() : self
- Set found rows
Properties
$_allowedProperties
Allowed object properties
protected
array<string|int, mixed>
$_allowedProperties
= array()
$_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() : mixed
Return values
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
self —addAllowedProperty()
Add additional allowed property
public
addAllowedProperty(string $property) : self
Parameters
- $property : string
-
property name
Return values
self —asObject()
Set object
public
asObject(mixed $objectName) : self
Parameters
- $objectName : mixed
Return values
self —deleteSearchPage()
Delete search page
public
deleteSearchPage(int $module, int $module_value_type, int $module_value_id) : self
Parameters
- $module : int
-
module's number, 0-15
- $module_value_type : int
-
value type, 0-15
- $module_value_id : int
-
entity id, 0-16777216
Return values
self —find()
Find
public
find(string $query) : array<string|int, mixed>
Parameters
- $query : string
-
Search query
Tags
Return values
array<string|int, mixed> —Array of Search_Page_Model
getPageCount()
Get pages count
public
getPageCount(int $site_id) : string
Parameters
- $site_id : int
-
site ID
Return values
string —count of pages
indexingSearchPages()
Indexing search pages
public
indexingSearchPages(array<string|int, mixed> $aPages) : bool
Parameters
- $aPages : array<string|int, mixed>
-
list of search pages
Return values
bool —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
self —setConfig()
Set config
public
setConfig(array<string|int, mixed> $aConfig) : self
Parameters
- $aConfig : array<string|int, mixed>
Return values
self —setUnlimitedProperties()
Set unlimitedProperties
public
setUnlimitedProperties([bool $value = TRUE ]) : self
Parameters
- $value : bool = TRUE
-
default TRUR
Return values
self —truncate()
Remove all indexed data
public
truncate() : self
Return values
self —_foundRows()
Set found rows
protected
_foundRows() : self