Class yii\db\pgsql\ColumnSchema

All Classes | Properties | Methods | Constants

Inheritance	yii\db\pgsql\ColumnSchema » yii\db\ColumnSchema » yii\base\BaseObject
Implements	yii\base\Configurable
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2/blob/master/framework/db/pgsql/ColumnSchema.php

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

Public Properties

Hide inherited properties

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

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\BaseObject
__construct()	Constructor.	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()	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\pgsql\ColumnSchema
defaultPhpTypecast()	Converts a PostgreSQL column default value to its PHP representation.	yii\db\pgsql\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\pgsql\ColumnSchema

Protected Methods

Hide inherited methods

Method	Description	Defined By
getArrayParser()	Creates instance of ArrayParser	yii\db\pgsql\ColumnSchema
phpTypecastValue()	Casts $value after retrieving from the DBMS to PHP representation.	yii\db\pgsql\ColumnSchema
typecast()	Converts the input value according to $phpType after retrieval from the database.	yii\db\ColumnSchema

Constants

Hide inherited constants

Constant	Value	Description	Defined By
CAST_SUFFIX	'[\w" .\[\](),]+'	Pattern fragment matching the type suffix of a `pg_get_expr()` cast, such as `character varying(10)`, `"bit"`, `numeric(5,2)`, or `text[]`. Shared by every literal branch of {@see defaultPhpTypecast()} so the cast grammar cannot drift between them.	yii\db\pgsql\ColumnSchema

Property Details

Hide inherited properties

$dimension public property

The dimension of array. Defaults to 0, means this column is not an array.

public integer $dimension = 0

$sequenceName public property (available since version 2.0.29)

Name of associated sequence if column is auto-incremental. null if no sequence.

public string|null $sequenceName = null

Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\BaseObject::__call()

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\base\UnknownMethodException	when calling unknown method

Source code

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

__construct() public method

Defined in: yii\base\BaseObject::__construct()

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 $config here.
call the parent implementation at the end of the constructor.

public mixed __construct ( array $config = [] )
$config	array	Name-value pairs that will be used to initialize the object properties

Source code

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}

__get() public method

Defined in: yii\base\BaseObject::__get()

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;.

public mixed __get ( string $name )
$name	string	The property name
return	mixed	The property value
throws	yii\base\UnknownPropertyException	if the property is not defined
throws	yii\base\InvalidCallException	if the property is write-only

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 mixed __set ( string $name, mixed $value )
$name	string	The property name or the event name
$value	mixed	The property value
throws	yii\base\UnknownPropertyException	if the property is not defined
throws	yii\base\InvalidCallException	if the property is read-only

public mixed __unset ( string $name )
$name	string	The property name
throws	yii\base\InvalidCallException	if the property is read only.

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

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

Source code

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}

className() public static method

Defined in: yii\base\BaseObject::className()

Returns the fully qualified name of this class.

public static string className ( )
return	string	The fully qualified name of this class.

Source code

                public static function className(): string
{
    return static::class;
}

dbTypecast() public method

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

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

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.

Source code

                public function dbTypecast($value)
{
    if ($value === null) {
        return $value;
    }
    if ($value instanceof ExpressionInterface) {
        return $value;
    }
    if ($this->dimension > 0) {
        return new ArrayExpression($value, $this->dbType, $this->dimension);
    }
    if (in_array($this->dbType, [Schema::TYPE_JSON, Schema::TYPE_JSONB], true)) {
        return new JsonExpression($value, $this->dbType);
    }
    return $this->typecast($value);
}

defaultPhpTypecast() public method (available since version 22.0)

Converts a PostgreSQL column default value to its PHP representation.

Recognizes the literal formats produced by pg_get_expr() and typecasts only those:

NULL or (NULL), optionally followed by a direct type cast, to null.
Binary bit literals (B'...'::) to their integer value via bindec(); kept for backward compatibility, pg_get_expr() reports bit defaults in the quoted form.
Quoted bit literals ('...'::"bit") to their integer value via bindec(); bit varying defaults carry the same "bit" cast label.
Quoted literals with a cast ('value'::type, including type modifiers such as character varying(10)) to the unquoted value with doubled quotes unescaped, delegated to {@see \yii\db\pgsql\phpTypecast()}.
Numeric literals, optionally parenthesized and optionally cast (42, 1.5, (0)::numeric), delegated to {@see \yii\db\pgsql\phpTypecast()}.
Bare true/false to booleans.

Everything else — operator expressions, function calls, nextval(...), CURRENT_* keywords — becomes an executable {@see \yii\db\Expression}. Branch order is significant: the bit branches must precede the generic quoted-literal branch, or bit strings would be typecast as plain integers.

public mixed defaultPhpTypecast ( mixed $value )
$value	mixed	Raw default value in PostgreSQL schema metadata format.
return	mixed	Converted PHP value.

Source code

                public function defaultPhpTypecast($value)
{
    if ($value === null) {
        return null;
    }
    if (preg_match('/^(?:NULL|\(NULL\))(?:::' . self::CAST_SUFFIX . ')?$/i', $value)) {
        return null;
    }
    if (preg_match("/^B'([01]*)'::" . self::CAST_SUFFIX . '$/', $value, $matches)) {
        return bindec($matches[1]);
    }
    if (preg_match("/^'([01]+)'::\"bit\"$/", $value, $matches)) {
        return bindec($matches[1]);
    }
    if (preg_match("/^'((?:[^']|'')*)'::" . self::CAST_SUFFIX . '$/s', $value, $matches)) {
        return $this->phpTypecast(str_replace("''", "'", $matches[1]));
    }
    if (preg_match('/^(\()?(-?\d+(?:\.\d+)?)(?(1)\))(?:::' . self::CAST_SUFFIX . ')?$/', $value, $matches)) {
        return $this->phpTypecast($matches[2]);
    }
    if ($value === 'true' || $value === 'false') {
        return $value === 'true';
    }
    return new Expression($value);
}

getArrayParser() protected method

Creates instance of ArrayParser

protected yii\db\pgsql\ArrayParser getArrayParser ( )

Source code

                protected function getArrayParser()
{
    static $parser = null;
    if ($parser === null) {
        $parser = new ArrayParser();
    }
    return $parser;
}

hasMethod() public method

Defined in: yii\base\BaseObject::hasMethod()

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

Source code

                public function hasMethod($name)
{
    return method_exists($this, $name);
}

hasProperty() public method

Defined in: yii\base\BaseObject::hasProperty()

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 $checkVars is 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

Source code

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}

init() public method

Defined in: yii\base\BaseObject::init()

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

Source code

                public function init()
{
}

isType() public method (available since version 22.0)

Defined in: yii\db\ColumnSchema::isType()

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.

Source code

                public function isType(string $type): bool
{
    return $this->type === $type;
}

phpTypecast() public method

Converts the input value according to $phpType after retrieval from the database.

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

public mixed phpTypecast ( mixed $value )
$value	mixed	Input value
return	mixed	Converted value

Source code

                public function phpTypecast($value)
{
    if ($this->dimension > 0) {
        if (!is_array($value)) {
            $value = $this->getArrayParser()->parse($value);
        }
        if (is_array($value)) {
            array_walk_recursive($value, function (&$val, $key) {
                $val = $this->phpTypecastValue($val);
            });
        } elseif ($value === null) {
            return null;
        }
        return $value;
    }
    return $this->phpTypecastValue($value);
}

phpTypecastValue() protected method

Casts $value after retrieving from the DBMS to PHP representation.

protected boolean\|mixed\|null phpTypecastValue ( string\|null $value )
$value	string\|null

Source code

                protected function phpTypecastValue($value)
{
    if ($value === null) {
        return null;
    }
    // `bytea` columns are returned as streams by the PDO PGSQL driver; read them into a string for consumers such
    // as DbCache.
    if ($this->type === Schema::TYPE_BINARY && is_resource($value) && get_resource_type($value) === 'stream') {
        return stream_get_contents($value);
    }
    switch ($this->type) {
        case Schema::TYPE_BOOLEAN:
            if (is_bool($value)) {
                return $value;
            }
            switch (strtolower($value)) {
                case 't':
                case 'true':
                    return true;
                case 'f':
                case 'false':
                    return false;
            }
            return (bool) $value;
        case Schema::TYPE_JSON:
            return json_decode($value, true);
    }
    return parent::phpTypecast($value);
}

typecast() protected method (available since version 2.0.3)

Defined in: yii\db\ColumnSchema::typecast()

Converts the input value according to $phpType after retrieval from the database.

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

protected mixed typecast ( mixed $value )
$value	mixed	Input value
return	mixed	Converted value

Source code

                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;
}

Class yii\db\pgsql\ColumnSchema

Public Properties

Public Methods

Protected Methods

Constants

Property Details

Method Details

User Contributed Notes

Leave a comment