Db

Type: Class
Namespace: craft\helpers
Inherits: craft\helpers\Db
Since: 3.0

Class Db

Public Methods

Method	Description
areColumnTypesCompatible()	Returns whether two column type definitions are relatively compatible with each other.
deleteIfExists()	Executes a DELETE command, but only if there are any rows to delete.
escapeParam()	Escapes commas and asterisks in a string so they are not treated as special characters in craft\helpers\Db::parseParam().
getMaxAllowedValueForNumericColumn()	Returns the maximum number allowed for a given column type.
getMinAllowedValueForNumericColumn()	Returns the minimum number allowed for a given column type.
getNumericalColumnType()	Returns a number column type, taking the min, max, and number of decimal points into account.
getSimplifiedColumnType()	Returns a simplified version of a given column type.
getTextualColumnStorageCapacity()	Returns the maximum number of bytes a given textual column type can hold for a given database.
getTextualColumnTypeByContentLength()	Given a length of a piece of content, returns the underlying database column type to use for saving.
idByUid()	Returns the `id` of a row in the given table by its `uid`.
idsByUids()	Returns an array `uid`:`id` pairs from a given table, by their `uid`s.
isNumericColumnType()	Returns whether the given column type is numeric.
isTextualColumnType()	Returns whether the given column type is textual.
isTypeSupported()	Returns whether a given DB connection’s schema supports a column type.
parseColumnLength()	Parses a column type definition and returns just the column length/size.
parseColumnType()	Parses a column type definition and returns just the column type, if it can be determined.
parseDateParam()	Normalizes date params and then sends them off to parseParam().
parseParam()	Parses a query param value and returns a yii\db\QueryInterface::where()-compatible condition.
prepareDateForDb()	Prepares a date to be sent to the database.
prepareValueForDb()	Prepares a value to be sent to the database.
prepareValuesForDb()	Prepares an array or object’s values to be sent to the database.
uidById()	Returns the `uid` of a row in the given table by its `id`.
uidsByIds()	Returns an array `id`:`uid` pairs from a given table, by their `id`s.

`areColumnTypesCompatible()`

Returns whether two column type definitions are relatively compatible with each other.

View source

Arguments

$typeA (string)
$typeB (string)

Returns

boolean

`deleteIfExists()`

Executes a DELETE command, but only if there are any rows to delete.

View source

Arguments

$table (string) – The table where the data will be deleted from.
$condition (string, array) – The condition that will be put in the WHERE part. Please refer to craft\db\Query::where() on how to specify condition.
$params (array) – The parameters to be bound to the command
$db (craft\db\Connection, null)

Returns

integer – Number of rows affected by the execution.

Throws

yii\db\Exception
execution failed

`escapeParam()`

Escapes commas and asterisks in a string so they are not treated as special characters in craft\helpers\Db::parseParam().

View source

Arguments

$value (string) – The param value.

Returns

string – The escaped param value.

`getMaxAllowedValueForNumericColumn()`

Returns the maximum number allowed for a given column type.

View source

Arguments

$columnType (string)

Returns

integer, false – The max allowed number, or false if it can't be determined

`getMinAllowedValueForNumericColumn()`

Returns the minimum number allowed for a given column type.

View source

Arguments

$columnType (string)

Returns

integer, false – The min allowed number, or false if it can't be determined

`getNumericalColumnType()`

Returns a number column type, taking the min, max, and number of decimal points into account.

View source

Arguments

$min (integer, null)
$max (integer, null)
$decimals (integer, null)

Returns

string

Throws

yii\base\Exception
if no column types can contain this

`getSimplifiedColumnType()`

Returns a simplified version of a given column type.

View source

Arguments

$columnType (string)

Returns

string

`getTextualColumnStorageCapacity()`

Returns the maximum number of bytes a given textual column type can hold for a given database.

View source

Arguments

$columnType (string) – The textual column type to check
$db (craft\db\Connection, null) – The database connection

Returns

integer, null, false – The storage capacity of the column type in bytes, null if unlimited, or false or it can't be determined.

`getTextualColumnTypeByContentLength()`

Given a length of a piece of content, returns the underlying database column type to use for saving.

View source

Arguments

$contentLength (integer)
$db (craft\db\Connection, null) – The database connection

Returns

string

Throws

yii\base\Exception
if using an unsupported connection type

`idByUid()`

Returns the id of a row in the given table by its uid.

View source

Arguments

$table (string)
$uid (string)

Returns

integer, null

`idsByUids()`

Returns an array uid:id pairs from a given table, by their uids.

View source

Arguments

$table (string)
$uids (string[])

Returns

string[]

`isNumericColumnType()`

Returns whether the given column type is numeric.

View source

Arguments

$columnType (string)

Returns

boolean

`isTextualColumnType()`

Returns whether the given column type is textual.

View source

Arguments

$columnType (string)

Returns

boolean

`isTypeSupported()`

Returns whether a given DB connection’s schema supports a column type.

View source

`parseColumnLength()`

Parses a column type definition and returns just the column length/size.

View source

Arguments

$columnType (string)

Returns

integer, null

`parseColumnType()`

Parses a column type definition and returns just the column type, if it can be determined.

View source

Arguments

$columnType (string)

Returns

string, null

`parseDateParam()`

Normalizes date params and then sends them off to parseParam().

View source

Arguments

$column (string)
$value (string, array, DateTime)
$defaultOperator (string) – The default operator to apply to the values (can be not, !=, <=, >=, <, >, or =)

Returns

mixed

`parseParam()`

Parses a query param value and returns a yii\db\QueryInterface::where()-compatible condition. If the $value is a string, it will automatically be converted to an array, split on any commas within the string (via craft\helpers\ArrayHelper::toArray()). If that is not desired behavior, you can escape the comma with a backslash before it. The first value can be set to either 'and' or 'or' to define whether all of the values must match, or any. If it’s neither 'and' nor 'or', then 'or' will be assumed. Values can begin with the operators 'not ', '!=', '<=', '>=', '<', '>', or '='. If they don’t, '=' will be assumed. Values can also be set to either ':empty:' or ':notempty:' if you want to search for empty or non-empty database values. (An “empty” value is either NULL or an empty string of text).

View source

Arguments

$column (string) – The database column that the param is targeting.
$value (string, integer, array) – The param value(s).
$defaultOperator (string) – The default operator to apply to the values (can be not, !=, <=, >=, <, >, or =)
$caseInsensitive (boolean) – Whether the resulting condition should be case-insensitive

Returns

mixed

`prepareDateForDb()`

Prepares a date to be sent to the database.

View source

Arguments

$date (mixed) – The date to be prepared

Returns

string, null – The prepped date, or null if it could not be prepared

`prepareValueForDb()`

Prepares a value to be sent to the database.

View source

Arguments

$value (mixed) – The value to be prepared

Returns

mixed – The prepped value

`prepareValuesForDb()`

Prepares an array or object’s values to be sent to the database.

View source

Arguments

$values (mixed) – The values to be prepared

Returns

array – The prepared values

`uidById()`

Returns the uid of a row in the given table by its id.

View source

Arguments

$table (string)
$id (integer)

Returns

string, null

`uidsByIds()`

Returns an array id:uid pairs from a given table, by their ids.

View source

Arguments

$table (string)
$ids (integer[])

Returns

string[]

Constants

Constant	Description
`SIMPLE_TYPE_NUMERIC`
`SIMPLE_TYPE_TEXTUAL`

Db

# Public Methods

#areColumnTypesCompatible()

Arguments

Returns

#deleteIfExists()

Arguments

Returns

Throws

#escapeParam()

Arguments

Returns

#getMaxAllowedValueForNumericColumn()

Arguments

Returns

#getMinAllowedValueForNumericColumn()

Arguments

Returns

#getNumericalColumnType()

Arguments

Returns

Throws

#getSimplifiedColumnType()

Arguments

Returns

#getTextualColumnStorageCapacity()

Arguments

Returns

#getTextualColumnTypeByContentLength()

Arguments

Returns

Throws

#idByUid()

Arguments

Returns

#idsByUids()

Arguments

Returns

#isNumericColumnType()

Arguments

Returns

#isTextualColumnType()

Arguments

Returns

#isTypeSupported()

Arguments

Returns

Throws

#parseColumnLength()

Arguments

Returns

#parseColumnType()

Arguments

Returns

#parseDateParam()

Arguments

Returns

#parseParam()

Arguments

Returns

#prepareDateForDb()

Arguments

Returns

#prepareValueForDb()

Arguments

Returns

#prepareValuesForDb()

Arguments

Returns

#uidById()

Arguments

Returns

#uidsByIds()

Arguments

Returns

# Constants

Public Methods

`areColumnTypesCompatible()`

`deleteIfExists()`

`escapeParam()`

`getMaxAllowedValueForNumericColumn()`

`getMinAllowedValueForNumericColumn()`

`getNumericalColumnType()`

`getSimplifiedColumnType()`

`getTextualColumnStorageCapacity()`

`getTextualColumnTypeByContentLength()`

`idByUid()`

`idsByUids()`

`isNumericColumnType()`

`isTextualColumnType()`

`isTypeSupported()`

`parseColumnLength()`

`parseColumnType()`

`parseDateParam()`

`parseParam()`

`prepareDateForDb()`

`prepareValueForDb()`

`prepareValuesForDb()`

`uidById()`

`uidsByIds()`

Constants