ColumnSchema

API reference › yii › db › oci › ColumnSchema

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

Represents the metadata of a column in an Oracle 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.	`ColumnSchema`
`defaultPhpTypecast()`	Converts an Oracle 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

dbTypecast()

public function dbTypecast(mixed $value): mixed

Converts the input value according to $type and $dbType for use in a db query.

Converts strings and streams for Oracle BLOB columns to locator-bound values.

If the value is null or an Expression, it will not be converted.

Parameters

Parameter	Type	Description
`$value`	`mixed`	Input value

Returns

mixed: Converted value. This may also be an array containing the value as the first element and the PDO type as the second element.

defaultPhpTypecast()

public function defaultPhpTypecast(mixed $value): mixed

Converts an Oracle column default value to its PHP representation.

Handles Oracle-specific default formats:

null, empty/whitespace strings, and bare or parenthesized NULL to null.
regular and national string literals ('value' / N'value') to their unquoted value, resolving doubled single quotes ('' to '). Oracle treats an empty string literal as null.
signed, decimal, scientific, BINARY_FLOAT, and BINARY_DOUBLE numeric literals through ColumnSchema::phpTypecast().
everything else to an executable Expression, including datetime literals, function calls, operator expressions, alternative-quoted strings, and sequence NEXTVAL defaults.

Parameters

Parameter	Type	Description
`$value`	`mixed`	Default value in Oracle `DATA_DEFAULT` format.

Returns

mixed: Converted value.

Since

22.0