PHP Класс Bolt\Storage\Query\Filter

@author Ross Riley
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$expression Doctrine\DBAL\Query\Expression\CompositeExpression
$key
$parameters array

Открытые методы

Метод Описание
getExpression ( ) : string Gets the compiled expression as a string. This will look something like (alias.key = :placeholder).
getExpressionObject ( ) : CompositeExpression Returns the actual object of the expression. This is generally only needed for on the fly modification, to get the compiled expression use getExpression().
getKey ( ) : string Getter for key.
getParameters ( ) : array Returns the array of parameters attached to this filter. These are normally used to replace placeholders at compile time.
hasParameter ( string $param ) : boolean Helper method to check if parameters are set for a specific key.
setExpression ( CompositeExpression $expression ) Allows replacing the expression object with a modified one.
setKey ( string $key ) Sets the key that this filter affects.
setParameter ( string $param, mixed $value ) Allows setting a parameter for a single key.
setParameters ( array $parameters ) Setter method to replace parameters.

Описание методов

getExpression() публичный Метод

Gets the compiled expression as a string. This will look something like (alias.key = :placeholder).
public getExpression ( ) : string
Результат string

getExpressionObject() публичный Метод

Returns the actual object of the expression. This is generally only needed for on the fly modification, to get the compiled expression use getExpression().
public getExpressionObject ( ) : CompositeExpression
Результат Doctrine\DBAL\Query\Expression\CompositeExpression

getKey() публичный Метод

Getter for key.
public getKey ( ) : string
Результат string

getParameters() публичный Метод

Returns the array of parameters attached to this filter. These are normally used to replace placeholders at compile time.
public getParameters ( ) : array
Результат array

hasParameter() публичный Метод

Helper method to check if parameters are set for a specific key.
public hasParameter ( string $param ) : boolean
$param string
Результат boolean

setExpression() публичный Метод

Allows replacing the expression object with a modified one.
public setExpression ( CompositeExpression $expression )
$expression Doctrine\DBAL\Query\Expression\CompositeExpression

setKey() публичный Метод

Sets the key that this filter affects.
public setKey ( string $key )
$key string

setParameter() публичный Метод

Allows setting a parameter for a single key.
public setParameter ( string $param, mixed $value )
$param string
$value mixed

setParameters() публичный Метод

Setter method to replace parameters.
public setParameters ( array $parameters )
$parameters array

Описание свойств

$expression защищенное свойство

protected CompositeExpression,Doctrine\DBAL\Query\Expression $expression
Результат Doctrine\DBAL\Query\Expression\CompositeExpression

$key защищенное свойство

protected $key

$parameters защищенное свойство

protected array $parameters
Результат array