MetaFox

SearchScope extends BaseScope
in package

Class SearchScope.

Table of Contents

Properties

$aliasJoinedTable  : string|null
$fields  : array<string|int, string>
$joinedField  : string|null
$joinedTable  : string|null
$searchText  : string
$table  : string|null
$tableField  : string|null

Methods

__construct()  : mixed
SearchScope constructor.
apply()  : mixed
applyQueryBuilder()  : void
getAliasJoinedTable()  : string|null
getFields()  : array<string|int, string>
getJoinedField()  : string|null
getJoinedTable()  : string|null
getSearchText()  : string
getTable()  : string|null
getTableField()  : string|null
likeOperator()  : string
return the case-insensitive LIKE operator bases on the current database driver.
setAliasJoinedTable()  : $this
setFields()  : SearchScope
setJoinedField()  : $this
setJoinedTable()  : $this
setSearchText()  : SearchScope
setTable()  : SearchScope
setTableField()  : $this
alias()  : string

Properties

$aliasJoinedTable

private string|null $aliasJoinedTable = null

$joinedField

private string|null $joinedField = null

$joinedTable

private string|null $joinedTable = null

Methods

__construct()

SearchScope constructor.

public __construct([string|null $query = null ][, array<string|int, mixed> $fields = [] ][, string|null $table = null ][, string|null $tableField = null ]) : mixed
Parameters
$query : string|null = null
$fields : array<string|int, mixed> = []
$table : string|null = null
$tableField : string|null = null

apply()

public apply(Builder $builder, Model $model) : mixed
Parameters
$builder : Builder
$model : Model

applyQueryBuilder()

public applyQueryBuilder(Builder $builder) : void
Parameters
$builder : Builder

getAliasJoinedTable()

public getAliasJoinedTable() : string|null
Return values
string|null

getFields()

public getFields() : array<string|int, string>
Return values
array<string|int, string>

getJoinedField()

public getJoinedField() : string|null
Return values
string|null

getJoinedTable()

public getJoinedTable() : string|null
Return values
string|null

getSearchText()

public getSearchText() : string
Return values
string

getTable()

public getTable() : string|null
Return values
string|null

getTableField()

public getTableField() : string|null
Return values
string|null

likeOperator()

return the case-insensitive LIKE operator bases on the current database driver.

public likeOperator() : string
Return values
string

setAliasJoinedTable()

public setAliasJoinedTable(string $alias) : $this
Parameters
$alias : string
Return values
$this

setJoinedField()

public setJoinedField(string $field) : $this
Parameters
$field : string
Return values
$this

setJoinedTable()

public setJoinedTable(string $table) : $this
Parameters
$table : string
Return values
$this

setTableField()

public setTableField(string $field) : $this
Parameters
$field : string
Return values
$this

alias()

protected alias(string $table, string $column) : string
Parameters
$table : string
$column : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results