W3cubDocs

/CakePHP 4.4

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
See: \Cake\Database\Query::identifier()

Property Summary

Method Summary

  • __construct() public

    Constructor

  • getCollation() public

    Returns the collation.

  • getIdentifier() public

    Returns the identifier this expression represents

  • setCollation() public

    Sets the collation.

  • setIdentifier() public

    Sets the identifier this expression represents

  • sql() public

    Converts the Node into a SQL string fragment.

  • traverse() public

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

Method Detail

__construct() public 

__construct(string $identifier, string|null $collation = null)

Constructor

Parameters

string $identifier

The identifier this expression represents

string|null $collation optional

The identifier collation

getCollation() public 

getCollation(): string|null

Returns the collation.

Returns

string|null

getIdentifier() public 

getIdentifier(): string

Returns the identifier this expression represents

Returns

string

setCollation() public 

setCollation(string $collation): void

Sets the collation.

Parameters

string $collation

Identifier collation

Returns

void

setIdentifier() public 

setIdentifier(string $identifier): void

Sets the identifier this expression represents

Parameters

string $identifier

The identifier

Returns

void

sql() public 

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

Converts the Node into a SQL string fragment.

Parameters

Cake\Database\ValueBinder $binder

Returns

string

traverse() public 

traverse(Closure $callback): $this

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

Parameters

Closure $callback

Returns

$this

Property Detail

$_identifier protected

Holds the identifier string

Type

string

$collation protected

Type

string|null

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