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.

Namespace: Cake\Database\Expression

Property Summary

$_castedExpressions protected

bool

Whether or not values have been casted to expressions already.
$_columns protected

array

List of columns to ensure are part of the insert.
$_query protected

Cake\Database\Query|null

The Query object to use as a values expression
$_typeMap protected

Cake\Database\TypeMap
$_values protected

array

Array of values to insert.

Method Summary

__construct() public

Constructor
_castToExpression() protected

Conditionally converts the passed value to an ExpressionInterface object if the type class implements the ExpressionTypeInterface. Otherwise, returns the value unmodified.
_columnNames() protected

Get the bare column names.
_processExpressions() protected

Converts values that need to be casted to expressions
_requiresToExpressionCasting() protected

Returns an array with the types that require values to be casted to expressions, out of the list of type names passed as parameter.
add() public

Add a row of data to be inserted.
columns() public deprecated

Sets the columns to be inserted. If no params are passed, then it returns the currently stored columns.
defaultTypes() public deprecated

Allows setting default types when chaining query
getColumns() public

Gets the columns to be inserted.
getDefaultTypes() public

Gets default types of current type map.
getQuery() public

Gets the query object to be used as the values expression to be evaluated to insert records in the table.
getTypeMap() public

Returns the existing type map.
getValues() public

Gets the values to be inserted.
query() public deprecated

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
setColumns() public

Sets the columns to be inserted.
setDefaultTypes() public

Overwrite the default type mappings for fields in the implementing object.
setQuery() public

Sets the query object to be used as the values expression to be evaluated to insert records in the table.
setTypeMap() public

Creates a new TypeMap if $typeMap is an array, otherwise exchanges it for the given one.
setValues() public

Sets the values to be inserted.
sql() public

Convert the values into a SQL string with placeholders.
traverse() public

Traverse the values expression.
typeMap() public deprecated

Creates a new TypeMap if $typeMap is an array, otherwise returns the existing type map or exchanges it for the given one.
values() public deprecated

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

_castToExpression() ¶ protected

_castToExpression(mixed $value, string $type): mixed

Conditionally converts the passed value to an ExpressionInterface object if the type class implements the ExpressionTypeInterface. Otherwise, returns the value unmodified.

Parameters

mixed $value: The value to converto to ExpressionInterface
string $type: The type name

Returns

mixed

_columnNames() ¶ protected

_columnNames(): array

Get the bare column names.

Because column names could be identifier quoted, we need to strip the identifiers off of the columns.

Returns

array

_processExpressions() ¶ protected

_processExpressions(): void

Converts values that need to be casted to expressions

Returns

void

_requiresToExpressionCasting() ¶ protected

_requiresToExpressionCasting(array $types): array

Returns an array with the types that require values to be casted to expressions, out of the list of type names passed as parameter.

Parameters

array $types: List of type names

Returns

array

add() ¶ public

add(arrayCake\Database\Query $data): void

Add a row of data to be inserted.

Parameters

arrayCake\Database\Query $data: Array of data to append into the insert, or a query for doing INSERT INTO .. SELECT style commands

Returns

void

Throws

Cake\Database\Exception
When mixing array + Query data types.

columns() ¶ public

columns(array|null $cols = null): array|$this

Sets the columns to be inserted. If no params are passed, then it returns the currently stored columns.

Parameters

array|null $cols optional: Array with columns to be inserted.

Returns

array|$this

defaultTypes() ¶ public

defaultTypes(array|null $types = null): $this|array

Allows setting default types when chaining query

Parameters

array|null $types optional: The array of types to set.

Returns

$this|array

getColumns() ¶ public

getColumns(): array

Gets the columns to be inserted.

Returns

array

getDefaultTypes() ¶ public

getDefaultTypes(): array

Gets default types of current type map.

Returns

array

getQuery() ¶ public

getQuery(): Cake\Database\Query|null

Gets the query object to be used as the values expression to be evaluated to insert records in the table.

Returns

Cake\Database\Query|null

getTypeMap() ¶ public

getTypeMap(): Cake\Database\TypeMap

Returns the existing type map.

Returns

Cake\Database\TypeMap

getValues() ¶ public

getValues(): array

Gets the values to be inserted.

Returns

array

query() ¶ public

query(Cake\Database\Query|null $query = null): Cake\Database\Query|null|$this

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

Parameters

Cake\Database\Query|null $query optional: The query to set

Returns

Cake\Database\Query|null|$this

setColumns() ¶ public

setColumns(array $cols): $this

Sets the columns to be inserted.

Parameters

array $cols: Array with columns to be inserted.

Returns

$this

setDefaultTypes() ¶ public

setDefaultTypes(array $types): $this

Overwrite the default type mappings for fields in the implementing object.

This method is useful if you need to set type mappings that are shared across multiple functions/expressions in a query.

To add a default without overwriting existing ones use getTypeMap()->addDefaults()

Parameters

array $types: The array of types to set.

Returns

$this

setQuery() ¶ public

setQuery(Cake\Database\Query $query): $this

Sets the query object to be used as the values expression to be evaluated to insert records in the table.

Parameters

Cake\Database\Query $query: The query to set

Returns

$this

setTypeMap() ¶ public

setTypeMap(arrayCake\Database\TypeMap $typeMap): $this

Creates a new TypeMap if $typeMap is an array, otherwise exchanges it for the given one.

Parameters

arrayCake\Database\TypeMap $typeMap: Creates a TypeMap if array, otherwise sets the given TypeMap

Returns

$this

setValues() ¶ public

setValues(array $values): $this

Sets the values to be inserted.

Parameters

array $values: Array with values to be inserted.

Returns

$this

sql() ¶ public

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

Convert the values into a SQL string with placeholders.

Parameters

Cake\Database\ValueBinder $generator: Placeholder generator object

Returns

string

traverse() ¶ public

traverse(callable $visitor): void

Traverse 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

void

typeMap() ¶ public

typeMap(arrayCake\Database\TypeMap|null $typeMap = null): $thisCake\Database\TypeMap

Creates a new TypeMap if $typeMap is an array, otherwise returns the existing type map or exchanges it for the given one.

Parameters

arrayCake\Database\TypeMap|null $typeMap optional: Creates a TypeMap if array, otherwise sets the given TypeMap

Returns

$thisCake\Database\TypeMap

values() ¶ public

values(array|null $values = null): array|$this

Sets the values to be inserted. If no params are passed, then it returns the currently stored values

Parameters

array|null $values optional: Array with values to be inserted.

Returns

array|$this

Property Detail

`$_castedExpressions` ¶ protected

Whether or not values have been casted to expressions already.

Type

bool

`$_columns` ¶ protected

List of columns to ensure are part of the insert.

Type

array

`$_query` ¶ protected

The Query object to use as a values expression

Type

Cake\Database\Query|null

`$_typeMap` ¶ protected

Type

Cake\Database\TypeMap

`$_values` ¶ protected

Array of values to insert.

Type

array

Namespaces

Class ValuesExpression

Property Summary

Method Summary

__construct() public

_castToExpression() protected

_columnNames() protected

_processExpressions() protected

_requiresToExpressionCasting() protected

add() public

columns() public deprecated

defaultTypes() public deprecated

getColumns() public

getDefaultTypes() public

getQuery() public

getTypeMap() public

getValues() public

query() public deprecated

setColumns() public

setDefaultTypes() public

setQuery() public

setTypeMap() public

setValues() public

sql() public

traverse() public

typeMap() public deprecated

values() public deprecated

Method Detail

__construct() ¶ public

Parameters

_castToExpression() ¶ protected

Parameters

Returns

_columnNames() ¶ protected

Returns

_processExpressions() ¶ protected

Returns

_requiresToExpressionCasting() ¶ protected

Parameters

Returns

add() ¶ public

Parameters

Returns

Throws

columns() ¶ public

Parameters

Returns

defaultTypes() ¶ public

Parameters

Returns

getColumns() ¶ public

Returns

getDefaultTypes() ¶ public

Returns

getQuery() ¶ public

Returns

getTypeMap() ¶ public

Returns

getValues() ¶ public

Returns

query() ¶ public

Parameters

Returns

setColumns() ¶ public

Parameters

Returns

setDefaultTypes() ¶ public

Parameters

Returns

See Also

setQuery() ¶ public

Parameters

Returns

setTypeMap() ¶ public

Parameters

Returns

setValues() ¶ public

Parameters

Returns

sql() ¶ public

`$_castedExpressions` ¶ protected

`$_columns` ¶ protected

`$_query` ¶ protected

`$_typeMap` ¶ protected

`$_values` ¶ protected