Класс ArrayField

Граф наследования:ArrayField:

Открытые члены
	__construct ($name, $parameters=[])
	configureSerializationJson ()
	Sets json serialization format. Подробнее...
	configureSerializationPhp ()
	Sets php serialization format. Подробнее...
	configureSerializeCallback ($callback)
	Custom encode handler. Подробнее...
	configureUnserializeCallback ($callback)
	Custom decode handler. Подробнее...
	encode ($value)
	decode ($value)
	encodeJson ($value)
	decodeJson ($value)
	encodePhp ($value)
	decodePhp ($value)
	cast ($value)
	convertValueFromDb ($value)
	convertValueToDb ($value)
	getGetterTypeHint ()
	getSetterTypeHint ()
Открытые члены унаследованные от ScalarField
	getTypeMask ()
	configurePrimary ($value=true)
	isPrimary ()
	configureRequired ($value=true)
	isRequired ()
	configureUnique ($value=true)
	isUnique ()
	configureAutocomplete ($value=true)
	isAutocomplete ()
	configurePrivate ($value=true)
	isPrivate ()
	configureColumnName ($value)
	getColumnName ()
	setColumnName ($column_name)
	configureDefaultValue ($value)
	getDefaultValue ($row=null)
	isValueEmpty ($value)
Открытые члены унаследованные от Field
	setEntity (Entity $entity)
	resetEntity ()
	validateValue ($value, $primary, $row, Result $result)
	modifyValueBeforeSave ($value, $data)
	getValidators ()
	addValidator ($validator)
	getFetchDataModifiers ()
	addFetchDataModifier ($modifier)
	getSaveDataModifiers ()
	addSaveDataModifier ($modifier)
	isSerialized ()
	setSerialized ()
	configureSerialized ()
	getName ()
	setName ($name)
	configureTitle ($title)
	Lang phrase. Подробнее...
	getTitle ()
	setParameter ($name, $value)
	getParameter ($name)
	hasParameter ($name)
	setParentField (Field $parentField)
	getParentField ()
	getDataType ()
	getEntity ()
	getLangCode ()
	getConnection ()
	serialize ($value)
	unserialize ($value)
	postInitialize ()
	Called after being initialized by Entity. Подробнее...

Защищенные данные
	$serializationType
	$encodeFunction
	$decodeFunction
Защищенные данные унаследованные от ScalarField
	$is_primary
	$is_unique
	$is_required
	$is_autocomplete
	$is_private
	$column_name = ''
	$default_value
Защищенные данные унаследованные от Field
	$name
	$dataType
	$initialParameters
	$title
	$validation = null
	$validators = null
	$additionalValidators = array()
	$fetchDataModification = null
	$fetchDataModifiers
	$additionalFetchDataModifiers = array()
	$saveDataModification = null
	$saveDataModifiers
	$additionalSaveDataModifiers = array()
	$isSerialized = false
	$parentField
	$entity

Дополнительные унаследованные члены
Открытые статические члены унаследованные от Field
static	getOldDataTypeByClass ($class)
static	getOldDataTypeByField (Field $field)
static	getClassByOldDataType ($dateType)
Защищенные члены унаследованные от Field
	appendValidator ($validator)
	appendFetchDataModifier ($modifier)
	appendSaveDataModifier ($modifier)
Статические защищенные данные унаследованные от Field
static	$oldDataTypes

Подробное описание

См. определение в файле arrayfield.php строка 17

Конструктор(ы)

__construct()

__construct	(		$name,
			$parameters = []
	)

Переопределяет метод предка ScalarField.

См. определение в файле arrayfield.php строка 28

    {
        $this->configureSerializationJson();
 
        $this->addSaveDataModifier([$this, 'encode']);
        $this->addFetchDataModifier([$this, 'decode']);
 
        parent::__construct($name, $parameters);
    }

Методы

cast()

cast

(

$value

)

Аргументы

mixed

$value

Возвращает

array

Замещает IReadable.

См. определение в файле arrayfield.php строка 170

    {
        return (array) $value;
    }

configureSerializationJson()

configureSerializationJson

(

)

Sets json serialization format.

Возвращает

$this

См. определение в файле arrayfield.php строка 43

    {
        $this->serializationType = 'json';
        $this->encodeFunction = [$this, 'encodeJson'];
        $this->decodeFunction = [$this, 'decodeJson'];
 
        return $this;
    }

configureSerializationPhp()

configureSerializationPhp

(

)

Sets php serialization format.

Возвращает

$this

См. определение в файле arrayfield.php строка 57

    {
        $this->serializationType = 'php';
        $this->encodeFunction = [$this, 'encodePhp'];
        $this->decodeFunction = [$this, 'decodePhp'];
 
        return $this;
    }

configureSerializeCallback()

configureSerializeCallback

(

$callback

)

Custom encode handler.

Аргументы

callable

$callback

Возвращает

$this

См. определение в файле arrayfield.php строка 73

    {
        $this->encodeFunction = $callback;
        $this->serializationType = 'custom';
 
        return $this;
    }

configureUnserializeCallback()

configureUnserializeCallback

(

$callback

)

Custom decode handler.

Аргументы

$callback

Возвращает

$this

См. определение в файле arrayfield.php строка 88

    {
        $this->decodeFunction = $callback;
        $this->serializationType = 'custom';
 
        return $this;
    }

convertValueFromDb()

convertValueFromDb

(

$value

)

Аргументы

mixed

$value

Возвращает

mixed|string

Исключения

Замещает IReadable.

См. определение в файле arrayfield.php строка 181

    {
        return $this->getConnection()->getSqlHelper()->convertFromDbString($value);
    }

convertValueToDb()

convertValueToDb

(

$value

)

Аргументы

mixed

$value

Возвращает

string

Исключения

Замещает IReadable.

См. определение в файле arrayfield.php строка 192

    {
        return $this->getConnection()->getSqlHelper()->convertToDbString($value);
    }

decode()

decode

(

$value

)

Аргументы

string

$value

Возвращает

array

См. определение в файле arrayfield.php строка 112

    {
        if($value <> '')
        {
            $callback = $this->decodeFunction;
            return $callback($value);
        }
 
        return [];
    }

decodeJson()

decodeJson

(

$value

)

Аргументы

$value

Возвращает

mixed

Исключения

См. определение в файле arrayfield.php строка 140

    {
        return Json::decode($value);
    }

decodePhp()

decodePhp

(

$value

)

Аргументы

$value

Возвращает

array

См. определение в файле arrayfield.php строка 160

    {
        return unserialize($value);
    }

encode()

encode

(

$value

)

Аргументы

array

$value

Возвращает

string

См. определение в файле arrayfield.php строка 101

    {
        $callback = $this->encodeFunction;
        return $callback($value);
    }

encodeJson()

encodeJson

(

$value

)

Аргументы

$value

Возвращает

mixed

Исключения

См. определение в файле arrayfield.php строка 129

    {
        return Json::encode($value);
    }

encodePhp()

encodePhp

(

$value

)

Аргументы

$value

Возвращает

string

См. определение в файле arrayfield.php строка 150

    {
        return serialize($value);
    }

getGetterTypeHint()

getGetterTypeHint

(

)

Возвращает

string

Переопределяет метод предка ScalarField.

См. определение в файле arrayfield.php строка 200

    {
        return 'array';
    }

getSetterTypeHint()

getSetterTypeHint

(

)

Возвращает

string

Переопределяет метод предка ScalarField.

См. определение в файле arrayfield.php строка 208

    {
        return 'array';
    }

Поля

$decodeFunction

$decodeFunction

protected

См. определение в файле arrayfield.php строка 26

$encodeFunction

$encodeFunction

protected

См. определение в файле arrayfield.php строка 23

$serializationType

$serializationType

protected

См. определение в файле arrayfield.php строка 20

---

Объявления и описания членов класса находятся в файле:

• arrayfield.php