Arikaim CMS

Search
in package

Database search session helper

Table of Contents

Methods

apply()  : Builder
Apply search conditions and return model object
applyCondition()  : Builder
Apply search condition
clearSearch()  : void
Remove all search condirtions
deleteSearchCondition()  : void
Delete search condition
getSearch()  : array<string|int, mixed>
Return current search text
getSearchCondition()  : array<string|int, mixed>|null
Return search field
getSearchConditions()  : array<string|int, mixed>
Return search field
getSearchValue()  : mixed|null
Return search value
setSearch()  : void
Set search data
setSearchCondition()  : void
Set search field value
setSearchConditions()  : void
Set search conditions

Methods

apply()

Apply search conditions and return model object

public static apply(Builder|Model $builder[, string|null $namespace = null ]) : Builder
Parameters
$builder : Builder|Model
$namespace : string|null = null
Return values
Builder

applyCondition()

Apply search condition

public static applyCondition(Builder $builder, array<string|int, mixed> $condition[, string|null $namespace = null ]) : Builder
Parameters
$builder : Builder
$condition : array<string|int, mixed>
$namespace : string|null = null
Return values
Builder

clearSearch()

Remove all search condirtions

public static clearSearch([string|null $namespace = null ]) : void
Parameters
$namespace : string|null = null

deleteSearchCondition()

Delete search condition

public static deleteSearchCondition(string $field[, string|null $namespace = null ]) : void
Parameters
$field : string
$namespace : string|null = null

getSearch()

Return current search text

public static getSearch([string|null $namespace = null ]) : array<string|int, mixed>
Parameters
$namespace : string|null = null
Return values
array<string|int, mixed>

getSearchCondition()

Return search field

public static getSearchCondition(string $field[, string|null $namespace = null ]) : array<string|int, mixed>|null
Parameters
$field : string
$namespace : string|null = null
Return values
array<string|int, mixed>|null

getSearchConditions()

Return search field

public static getSearchConditions([string|null $namespace = null ]) : array<string|int, mixed>
Parameters
$namespace : string|null = null
Return values
array<string|int, mixed>

getSearchValue()

Return search value

public static getSearchValue(string $field[, string|null $namespace = null ][, mixed $default = null ]) : mixed|null
Parameters
$field : string
$namespace : string|null = null
$default : mixed = null
Return values
mixed|null

setSearch()

Set search data

public static setSearch(array<string|int, mixed> $searchData[, string|null $namespace = null ]) : void
Parameters
$searchData : array<string|int, mixed>
$namespace : string|null = null

setSearchCondition()

Set search field value

public static setSearchCondition(string $field[, string|null $namespace = null ][, string|null $operator = null ][, string|null $queryOperator = null ][, mixed $searchFieldName = 'search_text' ]) : void
Parameters
$field : string
$namespace : string|null = null
$operator : string|null = null
$queryOperator : string|null = null
$searchFieldName : mixed = 'search_text'

setSearchConditions()

Set search conditions

public static setSearchConditions(array<string|int, mixed> $conditions[, string|null $namespace = null ]) : void
Parameters
$conditions : array<string|int, mixed>
$namespace : string|null = null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results