\Cake\Database\ExpressionBetweenExpression

An expression object that represents a SQL BETWEEN snippet

Summary

Methods

Properties

Constants

setField()
getField()
__construct()
sql()
traverse()
__clone()

No public properties found

No constants found

_castToExpression()
_requiresToExpressionCasting()
_bindValue()

$_field
$_from
$_to
$_type

N/A

No private methods found

No private properties found

N/A

Properties

$_field

$_field : string|\Cake\Database\ExpressionInterface

The field name or expression to be used in the left hand side of the operator

Type

string|\Cake\Database\ExpressionInterface

$_from

$_from : mixed

The first value in the expression

Type

mixed

$_to

$_to : mixed

The second value in the expression

Type

mixed

$_type

$_type : mixed

The data type for the from and to arguments

Type

mixed

Methods

setField()

setField(string|\Cake\Database\ExpressionInterface  $field) : void

Sets the field name

Parameters

string|\Cake\Database\ExpressionInterface

$field

The field to compare with.

getField()

getField() : string|\Cake\Database\ExpressionInterface

Returns the field name

Returns

string|\Cake\Database\ExpressionInterface

__construct()

__construct(string|\Cake\Database\ExpressionInterface  $field, mixed  $from, mixed  $to, string|null  $type = null)

Constructor

Parameters

string\|\Cake\Database\ExpressionInterface	$field	The field name to compare for values in between the range.
mixed	$from	The initial value of the range.
mixed	$to	The ending value in the comparison range.
string\|null	$type	The data type name to bind the values with.

sql()

sql(\Cake\Database\ValueBinder  $generator) : string

Converts the expression to its string representation

Parameters

\Cake\Database\ValueBinder

$generator

Placeholder generator object

Returns

string

traverse()

traverse(callable  $callable) : void

Iterates over each part of the expression recursively for every level of the expressions tree and executes the $visitor callable passing as first parameter the instance of the expression currently being iterated.

Parameters

callable

$callable

__clone()

__clone() : void

Do a deep clone of this expression.

_castToExpression()

_castToExpression(mixed  $value, string  $type) : mixed

Conditionally converts the passed value to an ExpressionInterface object if the type class implements the ExpressionTypeInterface. Otherwise, returns the value unmodified.

Parameters

mixed	$value	The value to converto to ExpressionInterface
string	$type	The type name

Returns

mixed

_requiresToExpressionCasting()

_requiresToExpressionCasting(array  $types) : array

Returns an array with the types that require values to be casted to expressions, out of the list of type names passed as parameter.

Parameters

array

$types

List of type names

Returns

array

_bindValue()

_bindValue(mixed  $value, \Cake\Database\ValueBinder  $generator, string  $type) : string

Registers a value in the placeholder generator and returns the generated placeholder

Parameters

mixed	$value	The value to bind
\Cake\Database\ValueBinder	$generator	The value binder to use
string	$type	The type of $value

Returns

string —

generated placeholder