W3cubDocs

/CakePHP 4.1

Class IdentifierQuoter

Contains all the logic related to quoting identifiers in a Query object

Namespace: Cake\Database

Properties summary

  • $_driver protected
    \Cake\Database\Driver

    The driver instance used to do the identifier quoting

Method Summary

  • __construct() public

    Constructor

  • _basicQuoter() protected

    A generic identifier quoting function used for various parts of the query

  • _quoteComparison() protected

    Quotes identifiers in expression objects implementing the field interface

  • _quoteIdentifierExpression() protected

    Quotes identifiers in "order by" expression objects

  • _quoteInsert() protected

    Quotes the table name and columns for an insert query

  • _quoteJoins() protected

    Quotes both the table and alias for an array of joins as stored in a Query object

  • _quoteOrderBy() protected

    Quotes identifiers in "order by" expression objects

  • _quoteParts() protected

    Quotes all identifiers in each of the clauses of a query

  • _quoteUpdate() protected

    Quotes the table name for an update query

  • quote() public

    Iterates over each of the clauses in a query looking for identifiers and quotes them

  • quoteExpression() public

    Quotes identifiers inside expression objects

Method Detail

__construct() public

__construct(\Cake\Database\Driver $driver)

Constructor

Parameters

\Cake\Database\Driver $driver

The driver instance used to do the identifier quoting

_basicQuoter() protected

_basicQuoter(array $part)

A generic identifier quoting function used for various parts of the query

Parameters

array $part

the part of the query to quote

Returns

array

_quoteComparison() protected

_quoteComparison(\Cake\Database\Expression\FieldInterface $expression)

Quotes identifiers in expression objects implementing the field interface

Parameters

\Cake\Database\Expression\FieldInterface $expression

The expression to quote.

_quoteIdentifierExpression() protected

_quoteIdentifierExpression(\Cake\Database\Expression\IdentifierExpression $expression)

Quotes identifiers in "order by" expression objects

Parameters

\Cake\Database\Expression\IdentifierExpression $expression

The identifiers to quote.

_quoteInsert() protected

_quoteInsert(\Cake\Database\Query $query)

Quotes the table name and columns for an insert query

Parameters

\Cake\Database\Query $query

The insert query to quote.

_quoteJoins() protected

_quoteJoins(array $joins)

Quotes both the table and alias for an array of joins as stored in a Query object

Parameters

array $joins

The joins to quote.

Returns

array

_quoteOrderBy() protected

_quoteOrderBy(\Cake\Database\Expression\OrderByExpression $expression)

Quotes identifiers in "order by" expression objects

Strings with spaces are treated as literal expressions and will not have identifiers quoted.

Parameters

\Cake\Database\Expression\OrderByExpression $expression

The expression to quote.

_quoteParts() protected

_quoteParts(\Cake\Database\Query $query)

Quotes all identifiers in each of the clauses of a query

Parameters

\Cake\Database\Query $query

The query to quote.

_quoteUpdate() protected

_quoteUpdate(\Cake\Database\Query $query)

Quotes the table name for an update query

Parameters

\Cake\Database\Query $query

The update query to quote.

quote() public

quote(\Cake\Database\Query $query)

Iterates over each of the clauses in a query looking for identifiers and quotes them

Parameters

\Cake\Database\Query $query

The query to have its identifiers quoted

Returns

\Cake\Database\Query

quoteExpression() public

quoteExpression(\Cake\Database\ExpressionInterface $expression)

Quotes identifiers inside expression objects

Parameters

\Cake\Database\ExpressionInterface $expression

The expression object to walk and quote.

Property Detail

$_driver protected

The driver instance used to do the identifier quoting

Type

\Cake\Database\Driver

© 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.1/class-Cake.Database.IdentifierQuoter.html