ColumnSchema

API reference › yii › db › sqlite › ColumnSchema

class	`yii\db\sqlite\ColumnSchema`
Extends	`yii\db\ColumnSchema` » `yii\base\BaseObject`
Implements	`yii\base\Configurable`
Since	22.0
Source	`framework/db/sqlite/ColumnSchema.php`

Represents the metadata of a column in a SQLite database table.

Properties

Property	Type	Description	Defined by
`$allowNull`	`bool`	Whether this column can be null. Default: `false`.	`yii\db\ColumnSchema`
`$autoIncrement`	`bool`	Whether this column is auto-incremental Default: `false`.	`yii\db\ColumnSchema`
`$comment`	`string\|null`	Comment of this column. Default: `null`.	`yii\db\ColumnSchema`
`$dbType`	`string`	The DB type of this column. Default: `''`.	`yii\db\ColumnSchema`
`$defaultValue`	`mixed`	Default value of this column Default: `null`.	`yii\db\ColumnSchema`
`$enumValues`	`array\|null`	Enumerable values. Default: `null`.	`yii\db\ColumnSchema`
`$isPrimaryKey`	`bool\|null`	Whether this column is a primary key Default: `null`.	`yii\db\ColumnSchema`
`$name`	`string`	Name of this column (without quotes). Default: `''`.	`yii\db\ColumnSchema`
`$phpType`	`string`	The PHP type of this column. Default: `''`.	`yii\db\ColumnSchema`
`$precision`	`int\|null`	Precision of the column data, if it is numeric. Default: `null`.	`yii\db\ColumnSchema`
`$scale`	`int\|null`	Scale of the column data, if it is numeric. Default: `null`.	`yii\db\ColumnSchema`
`$size`	`int\|null`	Display size of the column. Default: `null`.	`yii\db\ColumnSchema`
`$type`	`string`	Abstract type of this column. Default: `''`.	`yii\db\ColumnSchema`
`$unsigned`	`bool`	Whether this column is unsigned. Default: `false`.	`yii\db\ColumnSchema`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\BaseObject`
`__get()`	Returns the value of an object property.	`yii\base\BaseObject`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\BaseObject`
`__set()`	Sets value of an object property.	`yii\base\BaseObject`
`__unset()`	Sets an object property to null.	`yii\base\BaseObject`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\BaseObject`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\BaseObject`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`dbTypecast()`	Converts the input value according to `$type` and `$dbType` for use in a db query.	`yii\db\ColumnSchema`
`defaultPhpTypecast()`	Converts a SQLite column default value to its PHP representation.	`ColumnSchema`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\BaseObject`
`hasProperty()`	Returns a value indicating whether a property is defined.	`yii\base\BaseObject`
`init()`	Initializes the object.	`yii\base\BaseObject`
`isType()`	Returns whether this column uses the given abstract type.	`yii\db\ColumnSchema`
`phpTypecast()`	Converts the input value according to `$phpType` after retrieval from the database.	`yii\db\ColumnSchema`
`typecast()` protected	Converts the input value according to `$phpType` after retrieval from the database.	`yii\db\ColumnSchema`

Method details

defaultPhpTypecast()

public function defaultPhpTypecast(mixed $value): mixed

Converts a SQLite column default value to its PHP representation.

Handles SQLite-specific default formats reported by PRAGMA table_info:

null, empty strings, and bare or parenthesized NULL to null.
CURRENT_DATE, CURRENT_TIME, and CURRENT_TIMESTAMP to Expression.
single, double, backtick, or bracket-quoted string literals to their unquoted PHP value.
signed decimal and scientific numeric literals through ColumnSchema::phpTypecast().
TRUE and FALSE through ColumnSchema::phpTypecast() as 1 and 0 respectively.
bareword defaults to their literal text value, matching SQLite’s non-parenthesized DEFAULT word behavior.
everything else to an executable Expression, including functions, operators, BLOB literals, and hexadecimal integers whose meaning is only preserved when parsed as SQL text.

Branch order is significant: CURRENT_* and TRUE/FALSE must precede the bareword fallthrough, or they would reflect as string literals. PRAGMA table_info strips one outer parenthesis level; paren-tolerant branches exist only for literals that are also legal inside a parenthesized default expression.

Parameters

Parameter	Type	Description
`$value`	`mixed`	Default value in SQLite `dflt_value` format.

Returns

mixed: Converted value.

Since

22.0