HumHub Documentation (unofficial)

ColumnSchema extends ColumnSchema
in package

Class ColumnSchema for MySQL database

Tags
author

Dmytro Naumenko d.naumenko.a@gmail.com

since
2.0.14.1

Table of Contents

Properties

$allowNull  : bool
$autoIncrement  : bool
$comment  : string
$dbType  : string
$defaultValue  : mixed
$disableJsonSupport  : bool
$enumValues  : array<string|int, mixed>
$isPrimaryKey  : bool
$name  : string
$phpType  : string
$precision  : int
$scale  : int
$size  : int
$type  : string
$unsigned  : bool

Methods

__call()  : mixed
Calls the named method which is not a class method.
__construct()  : mixed
Constructor.
__get()  : mixed
Returns the value of an object property.
__isset()  : bool
Checks if a property is set, i.e. defined and not null.
__set()  : mixed
Sets value of an object property.
__unset()  : mixed
Sets an object property to null.
canGetProperty()  : bool
Returns a value indicating whether a property can be read.
canSetProperty()  : bool
Returns a value indicating whether a property can be set.
className()  : string
Returns the fully qualified name of this class.
dbTypecast()  : mixed
Converts the input value according to [[type]] and [[dbType]] for use in a db query.
hasMethod()  : bool
Returns a value indicating whether a method is defined.
hasProperty()  : bool
Returns a value indicating whether a property is defined.
init()  : mixed
Initializes the object.
phpTypecast()  : mixed
Converts the input value according to [[phpType]] after retrieval from the database.
typecast()  : mixed
Converts the input value according to [[phpType]] after retrieval from the database.
getPdoParamTypes()  : array<string|int, int>

Properties

$allowNull

public bool $allowNull

whether this column can be null.

$autoIncrement

public bool $autoIncrement = false

whether this column is auto-incremental

$comment

public string $comment

comment of this column. Not all DBMS support this.

$dbType

public string $dbType

the DB type of this column. Possible DB types vary according to the type of DBMS.

$defaultValue

public mixed $defaultValue

default value of this column

$disableJsonSupport

public bool $disableJsonSupport = false

whether the column schema should OMIT using JSON support feature. You can use this property to make upgrade to Yii 2.0.14 easier. Default to false, meaning JSON support is enabled.

Tags
since
2.0.14.1
deprecated

Since 2.0.14.1 and will be removed in 2.1.

$enumValues

public array<string|int, mixed> $enumValues

enumerable values. This is set only if the column is declared to be an enumerable type.

$isPrimaryKey

public bool $isPrimaryKey

whether this column is a primary key

$name

public string $name

name of this column (without quotes).

$phpType

public string $phpType

the PHP type of this column. Possible PHP types include: string, boolean, integer, double, array.

$precision

public int $precision

precision of the column data, if it is numeric.

$scale

public int $scale

scale of the column data, if it is numeric.

$type

public string $type

abstract type of this column. Possible abstract types include: char, string, text, boolean, smallint, integer, bigint, float, decimal, datetime, timestamp, time, date, binary, and money.

$unsigned

public bool $unsigned

whether this column is unsigned. This is only meaningful when [[type]] is smallint, integer or bigint.

Methods

__call()

Calls the named method which is not a class method.

public __call(string $name, array<string|int, mixed> $params) : mixed

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.

Parameters
$name : string

the method name

$params : array<string|int, mixed>

method parameters

Tags
throws
UnknownMethodException

when calling unknown method

Return values
mixed —

the method return value

__construct()

Constructor.

public __construct([array<string|int, mixed> $config = [] ]) : mixed

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.
Parameters
$config : array<string|int, mixed> = []

name-value pairs that will be used to initialize the object properties

__get()

Returns the value of an object property.

public __get(string $name) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $object->property;.

Parameters
$name : string

the property name

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is write-only

see
__set()
Return values
mixed —

the property value

__isset()

Checks if a property is set, i.e. defined and not null.

public __isset(string $name) : bool

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.

Parameters
$name : string

the property name or the event name

Tags
see
https://www.php.net/manual/en/function.isset.php
Return values
bool —

whether the named property is set (not null).

__set()

Sets value of an object property.

public __set(string $name, mixed $value) : mixed

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $object->property = $value;.

Parameters
$name : string

the property name or the event name

$value : mixed

the property value

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is read-only

see
__get()

__unset()

Sets an object property to null.

public __unset(string $name) : mixed

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.

Parameters
$name : string

the property name

Tags
throws
InvalidCallException

if the property is read only.

see
https://www.php.net/manual/en/function.unset.php

canGetProperty()

Returns a value indicating whether a property can be read.

public canGetProperty(string $name[, bool $checkVars = true ]) : bool

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 $checkVars is true);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canSetProperty()
Return values
bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.

public canSetProperty(string $name[, bool $checkVars = true ]) : bool

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 $checkVars is true);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canGetProperty()
Return values
bool —

whether the property can be written

className()

Returns the fully qualified name of this class.

public static className() : string
Tags
deprecated

since 2.0.14. On PHP >=5.5, use ::class instead.

Return values
string —

the fully qualified name of this class.

dbTypecast()

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

public dbTypecast(mixed $value) : mixed
Parameters
$value : mixed

input value

Return values
mixed —

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

hasMethod()

Returns a value indicating whether a method is defined.

public hasMethod(string $name) : bool

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

Parameters
$name : string

the method name

Return values
bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined.

public hasProperty(string $name[, bool $checkVars = true ]) : bool

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);
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

Tags
see
canGetProperty()
see
canSetProperty()
Return values
bool —

whether the property is defined

init()

Initializes the object.

public init() : mixed

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

phpTypecast()

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

public phpTypecast(mixed $value) : mixed
Parameters
$value : mixed

input value

Return values
mixed —

converted value

typecast()

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

protected typecast(mixed $value) : mixed

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

Parameters
$value : mixed

input value

Tags
since
2.0.3
Return values
mixed —

converted value

getPdoParamTypes()

private getPdoParamTypes() : array<string|int, int>
Return values
array<string|int, int> —

array of numbers that represent possible PDO parameter types


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results