Class IdentifierQuoter
Contains all the logic related to quoting identifiers in a Query object
Property 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<string, mixed> $part): array<string, mixed>
A generic identifier quoting function used for various parts of the query
Parameters
-
array<string, mixed>
$part the part of the query to quote
Returns
array<string, mixed>
_quoteComparison() ¶ protected
_quoteComparison(Cake\Database\Expression\FieldInterface $expression): void
Quotes identifiers in expression objects implementing the field interface
Parameters
-
Cake\Database\Expression\FieldInterface
$expression The expression to quote.
Returns
void
_quoteIdentifierExpression() ¶ protected
_quoteIdentifierExpression(Cake\Database\Expression\IdentifierExpression $expression): void
Quotes identifiers in "order by" expression objects
Parameters
-
Cake\Database\Expression\IdentifierExpression
$expression The identifiers to quote.
Returns
void
_quoteInsert() ¶ protected
_quoteInsert(Cake\Database\Query $query): void
Quotes the table name and columns for an insert query
Parameters
-
Cake\Database\Query
$query The insert query to quote.
Returns
void
_quoteJoins() ¶ protected
_quoteJoins(array $joins): array<string, array>
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<string, array>
_quoteOrderBy() ¶ protected
_quoteOrderBy(Cake\Database\Expression\OrderByExpression $expression): void
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.
Returns
void
_quoteParts() ¶ protected
_quoteParts(Cake\Database\Query $query): void
Quotes all identifiers in each of the clauses of a query
Parameters
-
Cake\Database\Query
$query The query to quote.
Returns
void
_quoteUpdate() ¶ protected
_quoteUpdate(Cake\Database\Query $query): void
Quotes the table name for an update query
Parameters
-
Cake\Database\Query
$query The update query to quote.
Returns
void
quote() ¶ public
quote(Cake\Database\Query $query): Cake\Database\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): void
Quotes identifiers inside expression objects
Parameters
-
Cake\Database\ExpressionInterface
$expression The expression object to walk and quote.
Returns
void
Property Detail
$_driver ¶ protected
The driver instance used to do the identifier quoting
Type
Cake\Database\Driver