search
extends searchWrapper
in package
Module search wrapper object
Tags
Table of Contents
- COMBINATION_AND = 0
- COMBINATION_OR = 1
- COMBINATION_STR_AND = 'and'
- COMBINATION_STR_OR = 'or'
- $status : string
- $text : string
- $cache : cache
- Cache object
- $cacheModule : string
- Cache Modul
- $cacheName : string
- Cache name
- $config : config
- Config object
- $data : array<string|int, mixed>
- Data array
- $events : events
- Event list
- $fieldOrder : array<string|int, mixed>
- Field order array
- $filterParams : array<string|int, mixed>
- Search conditions array
- $isMultiple : bool
- Multiple search flag
- $language : language
- Sprachobjekt
- $notifications : notifications
- Notifications
- $permissions : permissions
- Permissions
- $queryAssignResult : queryAssignResult
- Query assign result object
- $session : session
- Session objekt
- __construct() : void
- Konstruktor
- getCacheName() : string
- Cache-Name zurückgeben
- getCondition() : string
- Returns condition for given value
- getData() : array<string|int, mixed>
- Returns search data
- getDefaultOrder() : string
- Retrun deafult order field
- hasParams() : bool
- Funktion liefert Informationen zurpck, ob Suchparameter vorhanden
- isMultiple() : bool
- Is multiple flag set
- prepareFilterParams() : queryAssignResult
- Parse and assigns UI filter params array to queries
- prepareOrder() : void
- Prepare order string
- prepareValues() : void
- Prepare values
- setFilterParams() : $this
- Set filter params
- setMultiple() : $this
- Sets multiple lag
- getDB() : database
- Get database layer instance
- getOrderFields() : array<string|int, mixed>
- Returns field whitelist for ordering
- assignCondition() : void
- Assigns filter params conditions
- assignFieldAndValue() : void
- Assigns fields annd values from filter params
Constants
COMBINATION_AND
public
mixed
COMBINATION_AND
= 0
COMBINATION_OR
public
mixed
COMBINATION_OR
= 1
COMBINATION_STR_AND
public
mixed
COMBINATION_STR_AND
= 'and'
COMBINATION_STR_OR
public
mixed
COMBINATION_STR_OR
= 'or'
Properties
$status
public
string
$status
search by module status
$text
public
string
$text
search by module name or key
$cache
Cache object
protected
cache
$cache
$cacheModule
Cache Modul
protected
string
$cacheModule
= ''
Tags
$cacheName
Cache name
protected
string
$cacheName
= false
$config
Config object
protected
config
$config
$data
Data array
protected
array<string|int, mixed>
$data
$events
Event list
protected
events
$events
$fieldOrder
Field order array
protected
array<string|int, mixed>
$fieldOrder
= []
$filterParams
Search conditions array
protected
array<string|int, mixed>
$filterParams
Tags
$isMultiple
Multiple search flag
protected
bool
$isMultiple
= false
Tags
$language
Sprachobjekt
protected
language
$language
$notifications
Notifications
protected
notifications
$notifications
Tags
$permissions
Permissions
protected
permissions
$permissions
Tags
$queryAssignResult
Query assign result object
protected
queryAssignResult
$queryAssignResult
Tags
$session
Session objekt
protected
session
$session
Methods
__construct()
Konstruktor
public
__construct() : void
Return values
void —getCacheName()
Cache-Name zurückgeben
public
getCacheName([string $addName = '' ]) : string
Parameters
- $addName : string = ''
Return values
string —getCondition()
Returns condition for given value
public
getCondition(string $condition, string $query) : string
Parameters
- $condition : string
- $query : string
Return values
string —getData()
Returns search data
public
getData() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDefaultOrder()
Retrun deafult order field
public
getDefaultOrder() : string
Tags
Return values
string —hasParams()
Funktion liefert Informationen zurpck, ob Suchparameter vorhanden
public
hasParams() : bool
Return values
bool —isMultiple()
Is multiple flag set
public
isMultiple() : bool
Tags
Return values
bool —prepareFilterParams()
Parse and assigns UI filter params array to queries
public
final prepareFilterParams() : queryAssignResult
Return values
queryAssignResult —prepareOrder()
Prepare order string
public
prepareOrder(string $field, string $order) : void
Parameters
- $field : string
- $order : string
Tags
Return values
void —prepareValues()
Prepare values
public
prepareValues(array<string|int, mixed> &$filter) : void
Parameters
- $filter : array<string|int, mixed>
Tags
Return values
void —setFilterParams()
Set filter params
public
setFilterParams(array<string|int, mixed> $filterParams) : $this
Parameters
- $filterParams : array<string|int, mixed>
Tags
Return values
$this —setMultiple()
Sets multiple lag
public
setMultiple([bool $isMultiple = true ]) : $this
Parameters
- $isMultiple : bool = true
Tags
Return values
$this —getDB()
Get database layer instance
protected
getDB() : database
Tags
Return values
database —getOrderFields()
Returns field whitelist for ordering
protected
getOrderFields() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —assignCondition()
Assigns filter params conditions
private
assignCondition(filterParam $obj) : void
Parameters
- $obj : filterParam
Return values
void —assignFieldAndValue()
Assigns fields annd values from filter params
private
assignFieldAndValue(filterParam $obj) : void
Parameters
- $obj : filterParam