Class ValuesExpression
An expression object to contain values being inserted.
Helps generate SQL with the correct number of placeholders and bind values correctly into the statement.
Property Summary
Method Summary
-
__construct() public
Constructor
-
add() public
Add a row of data to be inserted.
-
columns() public
Sets the columns to be inserted. If no params are passed, then it returns the currently stored columns
-
defaultTypes() public
Allows setting default types when chaining query
-
query() public
Sets the query object to be used as the values expression to be evaluated to insert records in the table. If no params are passed, then it returns the currently stored query
-
sql() public
Convert the values into a SQL string with placeholders.
-
traverse() public
Traverse the values expression.
-
typeMap() public
Creates a new TypeMap if $typeMap is an array, otherwise returns the existing type map or exchanges it for the given one.
-
values() public
Sets the values to be inserted. If no params are passed, then it returns the currently stored values
Method Detail
__construct() ¶ public
__construct(array $columns, Cake\Database\TypeMap $typeMap)Constructor
Parameters
-
array$columns The list of columns that are going to be part of the values.
-
Cake\Database\TypeMap$typeMap A dictionary of column -> type names
add() ¶ public
add(array|Cake\Database\Query $data): voidAdd a row of data to be inserted.
Parameters
-
array|Cake\Database\Query$data Array of data to append into the insert, or a query for doing INSERT INTO .. SELECT style commands
Returns
voidThrows
Cake\Database\ExceptionWhen mixing array + Query data types.
columns() ¶ public
columns(array|null $cols = null): array|$thisSets the columns to be inserted. If no params are passed, then it returns the currently stored columns
Parameters
-
array|null$cols optional arrays with columns to be inserted
Returns
array|$thisdefaultTypes() ¶ public
defaultTypes(array|null $types = null): $this|arrayAllows setting default types when chaining query
Parameters
-
array|null$types optional The array of types to set.
Returns
$this|arrayquery() ¶ public
query(Cake\Database\Query|null $query = null): Cake\Database\QuerySets the query object to be used as the values expression to be evaluated to insert records in the table. If no params are passed, then it returns the currently stored query
Parameters
-
Cake\Database\Query|null$query optional The query to set/get
Returns
Cake\Database\Querysql() ¶ public
sql(Cake\Database\ValueBinder $generator): stringConvert the values into a SQL string with placeholders.
Parameters
-
Cake\Database\ValueBinder$generator Placeholder generator object
Returns
stringtraverse() ¶ public
traverse(callable $visitor): voidTraverse the values expression.
This method will also traverse any queries that are to be used in the INSERT values.
Parameters
-
callable$visitor The visitor to traverse the expression with.
Returns
voidtypeMap() ¶ public
typeMap(array|Cake\Database\TypeMap|null $typeMap = null): $this|Cake\Database\TypeMapCreates a new TypeMap if $typeMap is an array, otherwise returns the existing type map or exchanges it for the given one.
Parameters
-
array|Cake\Database\TypeMap|null$typeMap optional Creates a TypeMap if array, otherwise sets the given TypeMap
Returns
$this|Cake\Database\TypeMapvalues() ¶ public
values(array|null $values = null): array|$thisSets the values to be inserted. If no params are passed, then it returns the currently stored values
Parameters
-
array|null$values optional arrays with values to be inserted
Returns
array|$this