Class yii\db\mssql\ColumnSchema
| Inheritance | yii\ |
|---|---|
| Implements | yii\ |
| Available since version | 2.0.23 |
| Source Code | https://github.com/yiisoft/yii2/blob/master/framework/db/mssql/ColumnSchema.php |
Represents the metadata of a column in a Microsoft SQL Server 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\ |
| $isComputed | boolean | Whether this column is a computed column | yii\ |
| $isPrimaryKey | boolean|null | Whether this column is a primary key | yii\ |
| $name | string | Name of this column (without quotes). | yii\ |
| $outputColumnDeclaration | string | SQL type declaration. | 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() | Renders a rowversion/timestamp value as an 8-byte binary literal (0x...) for WHERE comparisons, and
converts varbinary strings to CONVERT(VARBINARY(MAX), 0x...) expressions to avoid conversion errors. |
yii\ |
| defaultPhpTypecast() | Converts a MSSQL column default value to its PHP representation. | yii\ |
| getOutputColumnDeclaration() | Returns the SQL type declaration for this column inside an OUTPUT clause temp table. | 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\ |
| isRowVersion() | Returns whether this column is a SQL Server rowversion (legacy synonym timestamp) auto-versioning column. |
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\ |
Property Details
Whether this column is a computed column
SQL type declaration.
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;
}
Renders a rowversion/timestamp value as an 8-byte binary literal (0x...) for WHERE comparisons, and
converts varbinary strings to CONVERT(VARBINARY(MAX), 0x...) expressions to avoid conversion errors.
See also:
| public mixed dbTypecast ( mixed $value ) | ||
| $value | mixed | |
public function dbTypecast($value)
{
if ($this->isRowVersion() && $value !== null && !$value instanceof ExpressionInterface) {
$hex = is_string($value) && strlen($value) === 8
? bin2hex($value) // raw 8-byte binary value.
: sprintf('%016x', (int) $value); // integer representation from `phpTypecast()`.
return new Expression("0x{$hex}");
}
if ($this->isVarbinary()) {
if ($value instanceof PdoValue && $value->getType() === \PDO::PARAM_LOB) {
$pdoValue = $value->getValue();
if (is_string($pdoValue) || $pdoValue === null) {
$value = $pdoValue;
}
}
if (is_string($value)) {
return new Expression('CONVERT(VARBINARY(MAX), 0x' . bin2hex($value) . ')');
}
if ($value === null && $this->allowNull) {
return new Expression('CAST(NULL AS VARBINARY(MAX))');
}
}
return parent::dbTypecast($value);
}
Converts a MSSQL column default value to its PHP representation.
Recognizes the literal formats stored in sys.default_constraints.definition and typecasts only those:
NULLor any parenthesized form such as(NULL)tonull.- Quoted strings (
('value')/(N'value'), any parenthesis depth) to the unquoted value with doubled quotes unescaped, delegated to {@see \yii\ db\ mssql\ phpTypecast()}. - Parenthesized signed, decimal, or scientific numerics (
((0)),((-5)),((1.0e+005))) delegated to {@see \yii\ db\ mssql\ phpTypecast()}. - Binary literals (
(0x...)) to their byte string viahex2bin().
Everything else; function calls such as (getdate()), operator expressions such as ((1)+(2)), or
(NEXT VALUE FOR ...) sequences; becomes an executable {@see \
| public mixed defaultPhpTypecast ( mixed $value ) | ||
| $value | mixed |
Default value in MSSQL |
| return | mixed |
Converted value. |
|---|---|---|
public function defaultPhpTypecast($value)
{
if ($value === null) {
return null;
}
if (is_string($value)) {
if (preg_match('/^(?:NULL|\(+NULL\)+)$/i', $value) === 1) {
return null;
}
if (preg_match("/^\(+N?'((?:''|[^'])*)'\)+$/is", $value, $matches) === 1) {
$value = str_replace("''", "'", $matches[1]);
} elseif (preg_match('/^\(+([+-]?(?:\d+(?:\.\d*)?|\.\d+)(?:e[+-]?\d+)?)\)+$/i' , $value, $matches) === 1) {
$value = $matches[1];
} elseif (preg_match('/^\(+0x((?:[0-9a-f]{2})*)\)+$/i', $value, $matches) === 1) {
$value = hex2bin($matches[1]);
} else {
return new Expression($value);
}
}
return parent::defaultPhpTypecast($value);
}
Returns the SQL type declaration for this column inside an OUTPUT clause temp table.
Preserves the reflected declaration for variable-length types (varchar, nvarchar, varbinary), keeps the
legacy (MAX) fallback for bare variable-length declarations, appends the declared size for fixed-length types
(char, nchar, binary), and maps timestamp to varbinary(8) or binary(8).
| public string getOutputColumnDeclaration ( ) | ||
| return | string |
SQL type declaration. |
|---|---|---|
public function getOutputColumnDeclaration(): string
{
if ($this->dbType === Schema::TYPE_TIMESTAMP) {
return $this->allowNull ? 'varbinary(8)' : 'binary(8)';
}
$dbType = $this->dbType;
if (in_array($dbType, ['varchar', 'nvarchar', 'varbinary'], true)) {
$dbType .= '(MAX)';
} elseif (in_array($dbType, ['char', 'nchar', 'binary'], true)) {
$dbType .= "($this->size)";
}
return $dbType;
}
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()
{
}
Returns whether this column is a SQL Server rowversion (legacy synonym timestamp) auto-versioning column.
See also https://learn.microsoft.com/en-us/sql/t-sql/data-types/rowversion-transact-sql.
| public boolean isRowVersion ( ) |
public function isRowVersion(): bool
{
return $this->isType(Schema::TYPE_TIMESTAMP);
}
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.
Decodes a rowversion/timestamp token to its integer value, and reads varbinary streams into strings.
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->isRowVersion()) {
if (is_resource($value) && get_resource_type($value) === 'stream') {
$value = stream_get_contents($value);
}
return is_string($value) && strlen($value) === 8
? unpack('J', $value)[1]
: $value;
}
if ($this->isVarbinary() && is_resource($value) && get_resource_type($value) === 'stream') {
return stream_get_contents($value);
}
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.