Class IdentifierExpression

Represents a single identifier name in the database.

Identifier values are unsafe with user supplied data. Values will be quoted when identifier quoting is enabled.

Namespace: Cake\Database\Expression

Properties summary

Method Summary

  • __construct() public

    Constructor

  • getIdentifier() public

    Returns the identifier this expression represents

  • setIdentifier() public

    Sets the identifier this expression represents

  • 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

__construct() public 

__construct(string $identifier)

Constructor

Parameters

string $identifier

The identifier this expression represents

getIdentifier() public 

getIdentifier()

Returns the identifier this expression represents

Returns

string

setIdentifier() public 

setIdentifier(string $identifier)

Sets the identifier this expression represents

Parameters

string $identifier

The identifier

sql() public 

sql(\Cake\Database\ValueBinder $generator)

Converts the expression to its string representation

Parameters

\Cake\Database\ValueBinder $generator

Placeholder generator object

Returns

string

traverse() public 

traverse(\Closure $visitor)

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

\Closure $visitor

The callable to apply to all nodes.

Returns

$this

Property Detail

$_identifier protected

Holds the identifier string

Type

string

© 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/4.0/class-Cake.Database.Expression.IdentifierExpression.html