Class yii\db\mssql\ColumnSchema
| Inheritance | yii\db\mssql\ColumnSchema » yii\db\ColumnSchema » yii\base\BaseObject | 
|---|---|
| Implements | yii\base\Configurable | 
| Available since version | 2.0.23 | 
| Source Code | https://github.com/yiisoft/yii2/blob/master/framework/db/mssql/ColumnSchema.php | 
Class ColumnSchema for MSSQL database
Public 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 | 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 | 
| $enumValues | array | Enumerable values. | yii\db\ColumnSchema | 
| $isComputed | boolean | Whether this column is a computed column | yii\db\mssql\ColumnSchema | 
| $isPrimaryKey | boolean | 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 | Precision of the column data, if it is numeric. | yii\db\ColumnSchema | 
| $scale | integer | Scale of the column data, if it is numeric. | yii\db\ColumnSchema | 
| $size | integer | 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
| 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\ColumnSchema | 
| defaultPhpTypecast() | Prepares default value and converts it according to $phpType | yii\db\mssql\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 | 
| phpTypecast() | Converts the input value according to $phpType after retrieval from the database. | yii\db\ColumnSchema | 
Protected Methods
| Method | Description | Defined By | 
|---|---|---|
| typecast() | Converts the input value according to $phpType after retrieval from the database. | yii\db\ColumnSchema | 
Property Details
Whether this column is a computed column
Method Details
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 ( $name, $params ) | ||
| $name | string | The method name | 
| $params | array | Method parameters | 
| return | mixed | The method return value | 
|---|---|---|
| throws | yii\base\UnknownMethodException | when calling unknown method | 
                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
            
        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 $confighere.
- call the parent implementation at the end of the constructor.
| public void __construct ( $config = [] ) | ||
| $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\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;.
See also __set().
| public mixed __get ( $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 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\base\BaseObject::__isset()
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 ( $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\base\BaseObject::__set()
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 void __set ( $name, $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 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\base\BaseObject::__unset()
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 void __unset ( $name ) | ||
| $name | string | The property name | 
| throws | yii\base\InvalidCallException | 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\base\BaseObject::canGetProperty()
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 ( $name, $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\base\BaseObject::canSetProperty()
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 ( $name, $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);
}
            
        ::class instead.                    
                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. | 
|---|---|---|
                public static function className()
{
    return get_called_class();
}
            
        Defined in: yii\db\ColumnSchema::dbTypecast()
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 ( $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)
{
    // the default implementation does the same as casting for PHP, but it should be possible
    // to override this with annotation of explicit PDO type.
    return $this->typecast($value);
}
            
        Prepares default value and converts it according to $phpType
| public mixed defaultPhpTypecast ( $value ) | ||
| $value | mixed | Default value | 
| return | mixed | Converted value | 
|---|---|---|
                public function defaultPhpTypecast($value)
{
    if ($value !== null) {
        // convert from MSSQL column_default format, e.g. ('1') -> 1, ('string') -> string
        $value = substr(substr($value, 2), 0, -2);
    }
    return parent::phpTypecast($value);
}
            
        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 ( $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\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 $checkVarsis true);
See also:
| public boolean hasProperty ( $name, $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\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 void init ( ) | 
                public function init()
{
}
            
        Defined in: yii\db\ColumnSchema::phpTypecast()
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 ( $value ) | ||
| $value | mixed | Input value | 
| return | mixed | Converted value | 
|---|---|---|
                public function phpTypecast($value)
{
    return $this->typecast($value);
}
            
        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 ( $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 (PHP_VERSION_ID >= 80100 && is_object($value) && $value instanceof \BackedEnum) {
                return (string) $value->value;
            }
            return (string) $value;
        case 'integer':
            if (PHP_VERSION_ID >= 80100 && 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;
}
            
        
Signup or Login in order to comment.