Class yii\db\mysql\ColumnSchema
| Inheritance | yii\ |
|---|---|
| Implements | yii\ |
| Available since version | 2.0.14.1 |
| Source Code | https://github.com/yiisoft/yii2/blob/master/framework/db/mysql/ColumnSchema.php |
Represents the metadata of a column in a MySQL database table.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $allowNull | boolean | Whether this column can be null. | yii\ |
| $autoIncrement | boolean | Whether this column is auto-incremental | yii\ |
| $comment | string|null | Comment of this column. | yii\ |
| $dbType | string | The DB type of this column. | yii\ |
| $defaultValue | mixed | Default value of this column | yii\ |
| $enumValues | array|null | Enumerable values. | yii\ |
| $isDefaultExpression | boolean | Whether MySQL reports the column default as an expression (DEFAULT_GENERATED). |
yii\ |
| $isPrimaryKey | boolean|null | Whether this column is a primary key | yii\ |
| $name | string | Name of this column (without quotes). | yii\ |
| $phpType | string | The PHP type of this column. | yii\ |
| $precision | integer|null | Precision of the column data, if it is numeric. | yii\ |
| $scale | integer|null | Scale of the column data, if it is numeric. | yii\ |
| $size | integer|null | Display size of the column. | yii\ |
| $type | string | Abstract type of this column. | yii\ |
| $unsigned | boolean | Whether this column is unsigned. | yii\ |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\ |
| __construct() | Constructor. | yii\ |
| __get() | Returns the value of an object property. | yii\ |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\ |
| __set() | Sets value of an object property. | yii\ |
| __unset() | Sets an object property to null. | yii\ |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\ |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\ |
| className() | Returns the fully qualified name of this class. | yii\ |
| dbTypecast() | Converts the input value according to $type and $dbType for use in a db query. | yii\ |
| defaultPhpTypecast() | Converts a MySQL column default value to its PHP representation. | yii\ |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\ |
| hasProperty() | Returns a value indicating whether a property is defined. | yii\ |
| init() | Initializes the object. | yii\ |
| isType() | Returns whether this column uses the given abstract type. | yii\ |
| phpTypecast() | Converts the input value according to $phpType after retrieval from the database. | yii\ |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| typecast() | Converts the input value according to $phpType after retrieval from the database. | yii\ |
Constants
| Constant | Value | Description | Defined By |
|---|---|---|---|
| DEFAULT_LITERAL_ESCAPES | [ '\0' => "\x00", '\b' => "\x08", '\n' => "\n", '\r' => "\r", '\t' => "\t", '\Z' => "\x1a", "\\'" => "'", '\\\\' => '\\', ] |
Escape sequences MySQL and MariaDB emit inside quoted default literals, mapped to their byte values.
MySQL prints \0, \, \, and \ and passes other control characters through as raw bytes; MariaDB
additionally prints \ and \. Both escape \' and \\. |
yii\ |
Property Details
Whether MySQL reports the column default as an expression (DEFAULT_GENERATED).
Method Details
Defined in:
yii\
Calls the named method which is not a class method.
Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.
| public mixed __call ( string $name, array $params ) | ||
| $name | string |
The method name |
| $params | array |
Method parameters |
| return | mixed |
The method return value |
|---|---|---|
| throws | yii\ |
when calling unknown method |
public function __call($name, $params)
{
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
Defined in:
yii\
Constructor.
The default implementation does two things:
- Initializes the object with the given configuration
$config. - Call init().
If this method is overridden in a child class, it is recommended that
- the last parameter of the constructor is a configuration array, like
$confighere. - call the parent implementation at the end of the constructor.
| public mixed __construct ( array | ||
| $config | array |
Name-value pairs that will be used to initialize the object properties |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
Defined in:
yii\
Returns the value of an object property.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $value = $object->property;.
See also __set().
| public mixed __get ( string $name ) | ||
| $name | string |
The property name |
| return | mixed |
The property value |
|---|---|---|
| throws | yii\ |
if the property is not defined |
| throws | yii\ |
if the property is write-only |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter();
} elseif (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
Defined in:
yii\
Checks if a property is set, i.e. defined and not null.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing isset($object->property).
Note that if the property is not defined, false will be returned.
| public boolean __isset ( string $name ) | ||
| $name | string |
The property name or the event name |
| return | boolean |
Whether the named property is set (not null). |
|---|---|---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
return false;
}
Defined in:
yii\
Sets value of an object property.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $object->property = $value;.
See also __get().
| public mixed __set ( string $name, mixed $value ) | ||
| $name | string |
The property name or the event name |
| $value | mixed |
The property value |
| throws | yii\ |
if the property is not defined |
|---|---|---|
| throws | yii\ |
if the property is read-only |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter($value);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
} else {
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
}
Defined in:
yii\
Sets an object property to null.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing unset($object->property).
Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.
| public mixed __unset ( string $name ) | ||
| $name | string |
The property name |
| throws | yii\ |
if the property is read only. |
|---|---|---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
}
}
Defined in:
yii\
Returns a value indicating whether a property can be read.
A property is readable if:
- the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVarsis true);
See also canSetProperty().
| public boolean canGetProperty ( string $name, boolean $checkVars = true ) | ||
| $name | string |
The property name |
| $checkVars | boolean |
Whether to treat member variables as properties |
| return | boolean |
Whether the property can be read |
|---|---|---|
public function canGetProperty($name, $checkVars = true)
{
return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
Defined in:
yii\
Returns a value indicating whether a property can be set.
A property is writable if:
- the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVarsis true);
See also canGetProperty().
| public boolean canSetProperty ( string $name, boolean $checkVars = true ) | ||
| $name | string |
The property name |
| $checkVars | boolean |
Whether to treat member variables as properties |
| return | boolean |
Whether the property can be written |
|---|---|---|
public function canSetProperty($name, $checkVars = true)
{
return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
Defined in:
yii\
Returns the fully qualified name of this class.
| public static string className ( ) | ||
| return | string |
The fully qualified name of this class. |
|---|---|---|
public static function className(): string
{
return static::class;
}
Converts the input value according to $type and $dbType for use in a db query.
If the value is null or an yii\
| public mixed dbTypecast ( mixed $value ) | ||
| $value | mixed |
Input value |
| return | mixed |
Converted value. This may also be an array containing the value as the first element and the PDO type as the second element. |
|---|---|---|
public function dbTypecast($value)
{
if ($value === null) {
return $value;
}
if ($value instanceof ExpressionInterface) {
return $value;
}
if ($this->dbType === Schema::TYPE_JSON) {
return new JsonExpression($value, $this->type);
}
return $this->typecast($value);
}
Converts a MySQL column default value to its PHP representation.
Handles MySQL-specific default value formats:
nulltonull.CURRENT_TIMESTAMP/current_timestamp()on temporal columns (timestamp,datetime,date,time) to an {@see \yii\ db\ Expression}, preserving any declared fractional-seconds precision such as CURRENT_TIMESTAMP(3).- quoted string literals on
textandblobcolumns, and on any column flagged through {@see $isDefaultExpression}, to their PHP value: the character-set introducer MySQL prepends is discarded and the escape sequences in {@see \yii\ db\ mysql\ DEFAULT_LITERAL_ESCAPES} are resolved. jsoncolumns are exempt. - remaining expression defaults flagged through {@see $isDefaultExpression} to an {@see \
yii\ db\ Expression}. jsondefaults without the flag to their decoded value when the string is valid JSON, or to an {@see \yii\ db\ Expression} otherwise; MariaDB reports expression-form defaults without metadata. - remaining
textdefaults without the flag to an {@see \yii\ db\ Expression}, preserving MariaDB's expression-form SQL. - bit defaults (
b'...') when$dbTypestarts withbitto their integer value viabindec(). - everything else delegates to {@see \
yii\ db\ mysql\ phpTypecast()}.
Branch order is significant: MySQL also flags plain CURRENT_TIMESTAMP defaults as DEFAULT_GENERATED, so the
normalization above must win over the generic expression wrapping. Flagged defaults carry an extra metadata
escape layer (\', \\) that is removed before literal parsing; MariaDB reports the expression verbatim.
| public mixed defaultPhpTypecast ( mixed $value ) | ||
| $value | mixed |
Default value in the format reported by |
| return | mixed |
Converted value. |
|---|---|---|
public function defaultPhpTypecast($value)
{
if ($value === null) {
return null;
}
if (
is_string($value)
&& in_array($this->type, ['timestamp', 'datetime', 'date', 'time'], true)
&& preg_match('/^current_timestamp(?:\(([0-9]*)\))?$/i', $value, $matches) === 1
) {
$precision = $matches[1] ?? '';
return new Expression('CURRENT_TIMESTAMP' . ($precision !== '' ? "({$precision})" : ''));
}
if (is_string($value)) {
$expression = $this->isDefaultExpression
? strtr($value, ['\\\\' => '\\', "\\'" => "'"])
: $value;
if (
$this->type !== Schema::TYPE_JSON
&& ($this->isDefaultExpression || in_array($this->type, [Schema::TYPE_TEXT, Schema::TYPE_BINARY], true))
&& preg_match("/^(?:_[a-z0-9]+)?'((?:\\\\.|[^'\\\\])*)'$/i", $expression, $matches) === 1
) {
return $this->phpTypecast(strtr($matches[1], self::DEFAULT_LITERAL_ESCAPES));
}
if ($this->isDefaultExpression) {
return new Expression($expression);
}
}
if ($this->type === Schema::TYPE_JSON && is_string($value)) {
$decoded = json_decode($value, true);
return json_last_error() === JSON_ERROR_NONE
? $decoded
: new Expression($value);
}
if ($this->type === Schema::TYPE_TEXT && is_string($value)) {
return new Expression($value);
}
if (is_string($value) && strncasecmp($this->dbType, 'bit', 3) === 0) {
return bindec(trim($value, "b'"));
}
return $this->phpTypecast($value);
}
Defined in:
yii\
Returns a value indicating whether a method is defined.
The default implementation is a call to php function method_exists().
You may override this method when you implemented the php magic method __call().
| public boolean hasMethod ( string $name ) | ||
| $name | string |
The method name |
| return | boolean |
Whether the method is defined |
|---|---|---|
public function hasMethod($name)
{
return method_exists($this, $name);
}
Defined in:
yii\
Returns a value indicating whether a property is defined.
A property is defined if:
- the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVarsis true);
See also:
| public boolean hasProperty ( string $name, boolean $checkVars = true ) | ||
| $name | string |
The property name |
| $checkVars | boolean |
Whether to treat member variables as properties |
| return | boolean |
Whether the property is defined |
|---|---|---|
public function hasProperty($name, $checkVars = true)
{
return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
Defined in:
yii\
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
| public mixed init ( ) |
public function init()
{
}
Defined in:
yii\
Returns whether this column uses the given abstract type.
| public boolean isType ( string $type ) | ||
| $type | string |
Abstract column type. |
| return | boolean |
Whether this column uses the given abstract type. |
|---|---|---|
public function isType(string $type): bool
{
return $this->type === $type;
}
Converts the input value according to $phpType after retrieval from the database.
If the value is null or an yii\
| public mixed phpTypecast ( mixed $value ) | ||
| $value | mixed |
Input value |
| return | mixed |
Converted value |
|---|---|---|
public function phpTypecast($value)
{
if ($value === null) {
return null;
}
if ($this->type === Schema::TYPE_JSON) {
return json_decode($value, true);
}
return parent::phpTypecast($value);
}
Defined in:
yii\
Converts the input value according to $phpType after retrieval from the database.
If the value is null or an yii\
| protected mixed typecast ( mixed $value ) | ||
| $value | mixed |
Input value |
| return | mixed |
Converted value |
|---|---|---|
protected function typecast($value)
{
if (
$value === ''
&& !in_array(
$this->type,
[
Schema::TYPE_TEXT,
Schema::TYPE_STRING,
Schema::TYPE_BINARY,
Schema::TYPE_CHAR
],
true
)
) {
return null;
}
if (
$value === null
|| gettype($value) === $this->phpType
|| $value instanceof ExpressionInterface
|| $value instanceof Query
) {
return $value;
}
if (
is_array($value)
&& count($value) === 2
&& isset($value[1])
&& in_array($value[1], $this->getPdoParamTypes(), true)
) {
return new PdoValue($value[0], $value[1]);
}
switch ($this->phpType) {
case 'resource':
case 'string':
if (is_resource($value)) {
return $value;
}
if (is_float($value)) {
// ensure type cast always has . as decimal separator in all locales
return StringHelper::floatToString($value);
}
if (
is_numeric($value)
&& ColumnSchemaBuilder::CATEGORY_NUMERIC === ColumnSchemaBuilder::$typeCategoryMap[$this->type]
) {
// https://github.com/yiisoft/yii2/issues/14663
return $value;
}
if (is_object($value) && $value instanceof \BackedEnum) {
return (string) $value->value;
}
return (string) $value;
case 'integer':
if (is_object($value) && $value instanceof \BackedEnum) {
return (int) $value->value;
}
return (int) $value;
case 'boolean':
// treating a 0 bit value as false too
// https://github.com/yiisoft/yii2/issues/9006
return (bool) $value && $value !== "\0" && strtolower($value) !== 'false';
case 'double':
return (float) $value;
}
return $value;
}
User Contributed Notes
Leave a comment
Join the conversation to share a note.