W3cubDocs

/CakePHP 3.8

Class BetweenExpression

An expression object that represents a SQL BETWEEN snippet

Cake\Database\Expression\BetweenExpression implements Cake\Database\ExpressionInterface, Cake\Database\Expression\FieldInterface uses Cake\Database\Type\ExpressionTypeCasterTrait , Cake\Database\Expression\FieldTrait

Properties summary

  • $_from protected
    mixed
    The first value in the expression
  • $_to protected
    mixed
    The second value in the expression
  • $_type protected
    mixed
    The data type for the from and to arguments

Inherited Properties

Method Summary

  • __clone() public
    Do a deep clone of this expression.
  • __construct() public
    Constructor
  • _bindValue() protected
    Registers a value in the placeholder generator and returns the generated placeholder
  • sql() public
    Converts the expression to its string representation
  • traverse() public

    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.

Method Detail

__clone()source public

__clone( )

Do a deep clone of this expression.

__construct()source public

__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 optional null
The data type name to bind the values with.

_bindValue()source protected

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

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

sql()source public

sql( Cake\Database\ValueBinder $generator )

Converts the expression to its string representation

Parameters

Cake\Database\ValueBinder $generator
Placeholder generator object

Returns

string

Implementation of

Cake\Database\ExpressionInterface::sql()

traverse()source public

traverse( callable $callable )

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
$visitor The callable to apply to all nodes.

Implementation of

Cake\Database\ExpressionInterface::traverse()

Methods used from Cake\Database\Type\ExpressionTypeCasterTrait

_castToExpression()source protected

_castToExpression( mixed $value , string $type )

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()source protected

_requiresToExpressionCasting( array $types )

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

Methods used from Cake\Database\Expression\FieldTrait

getField()source public

getField( )

Returns the field name

Returns

string|Cake\Database\ExpressionInterface

setField()source public

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

Sets the field name

Parameters

string|Cake\Database\ExpressionInterface $field
The field to compare with.

Properties detail

$_fromsource

protected mixed

The first value in the expression

$_tosource

protected mixed

The second value in the expression

$_typesource

protected mixed

The data type for the from and to arguments

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.8/class-Cake.Database.Expression.BetweenExpression.html