Класс ScalarField

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

Открытые члены
	__construct ($name, $parameters=array())
	ScalarField constructor. Подробнее...
	getTypeMask ()
	configurePrimary ($value=true)
	isPrimary ()
	configureRequired ($value=true)
	isRequired ()
	configureUnique ($value=true)
	isUnique ()
	configureAutocomplete ($value=true)
	isAutocomplete ()
	configureColumnName ($value)
	getColumnName ()
	setColumnName ($column_name)
	configureDefaultValue ($value)
	getDefaultValue ($row=null)
	isValueEmpty ($value)
	getGetterTypeHint ()
	getSetterTypeHint ()
Открытые члены унаследованные от 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. Подробнее...
Открытые члены унаследованные от IReadable
	cast ($value)
	Casts value strictly to field type. Подробнее...
	convertValueFromDb ($value)
	Returns value converted from SQL raw result. Подробнее...
	convertValueToDb ($value)
	Returns raw SQL with escaped and quoted value. Подробнее...

Защищенные данные
	$is_primary
	$is_unique
	$is_required
	$is_autocomplete
	$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

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

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

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

__construct()

__construct	(		$name,
			$parameters = array()
	)

ScalarField constructor.

Аргументы

	$name
array	$parameters	deprecated, use configure* and add* methods instead

Исключения

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

Переопределяется в StringField, DateField, BooleanField, CryptoField, DatetimeField, EnumField, FloatField и ArrayField.

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

    {
        parent::__construct($name, $parameters);
 
        $this->is_primary = (isset($parameters['primary']) && $parameters['primary']);
        $this->is_unique = (isset($parameters['unique']) && $parameters['unique']);
        $this->is_required = (isset($parameters['required']) && $parameters['required']);
        $this->is_autocomplete = (isset($parameters['autocomplete']) && $parameters['autocomplete']);
 
        $this->column_name = isset($parameters['column_name']) ? $parameters['column_name'] : $this->name;
        $this->default_value = isset($parameters['default_value']) ? $parameters['default_value'] : null;
    }

Методы

configureAutocomplete()

configureAutocomplete

(

$value = true

)

Аргументы

boolean

$value

Возвращает

$this

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

    {
        $this->is_autocomplete = (bool) $value;
        return $this;
    }

configureColumnName()

configureColumnName

(

$value

)

Аргументы

string

$value

Возвращает

$this

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

    {
        $this->column_name = $value;
        return $this;
    }

configureDefaultValue()

configureDefaultValue

(

$value

)

Аргументы

callable | mixed

$value

Возвращает

$this

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

    {
        $this->default_value = $value;
        return $this;
    }

configurePrimary()

configurePrimary

(

$value = true

)

Аргументы

boolean

$value

Возвращает

$this

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

    {
        $this->is_primary = (bool) $value;
        return $this;
    }

configureRequired()

configureRequired

(

$value = true

)

Аргументы

boolean

$value

Возвращает

$this

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

    {
        $this->is_required = (bool) $value;
        return $this;
    }

configureUnique()

configureUnique

(

$value = true

)

Аргументы

boolean

$value

Возвращает

$this

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

    {
        $this->is_unique = (bool) $value;
        return $this;
    }

getColumnName()

getColumnName

(

)

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

    {
        return $this->column_name;
    }

getDefaultValue()

getDefaultValue

(

$row = null

)

Аргументы

array

$row

ORM data row in case of dependency value on other values

Возвращает

callable|mixed|null

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

    {
        if (!is_string($this->default_value) && is_callable($this->default_value))
        {
            return call_user_func($this->default_value, $row);
        }
        else
        {
            return $this->default_value;
        }
    }

getGetterTypeHint()

getGetterTypeHint

(

)

Возвращает

string

Замещает ITypeHintable.

Переопределяется в ArrayField, BooleanField, DateField, FloatField, DatetimeField и IntegerField.

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

    {
        return '\\string';
    }

getSetterTypeHint()

getSetterTypeHint

(

)

Возвращает

string

Замещает ITypeHintable.

Переопределяется в ArrayField, BooleanField, DateField, FloatField, DatetimeField и IntegerField.

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

    {
        return '\\string';
    }

getTypeMask()

getTypeMask

(

)

Возвращает

int

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

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

    {
        return FieldTypeMask::SCALAR;
    }

isAutocomplete()

isAutocomplete

(

)

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

    {
        return $this->is_autocomplete;
    }

isPrimary()

isPrimary

(

)

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

    {
        return $this->is_primary;
    }

isRequired()

isRequired

(

)

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

    {
        return $this->is_required;
    }

isUnique()

isUnique

(

)

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

    {
        return $this->is_unique;
    }

isValueEmpty()

isValueEmpty

(

$value

)

Переопределяется в BooleanField.

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

    {
        if ($value instanceof SqlExpression)
        {
            $value = $value->compile();
        }
 
        return (strval($value) === '');
    }

setColumnName()

setColumnName

(

$column_name

)

Аргументы

string

$column_name

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

    {
        $this->column_name = $column_name;
    }

Поля

$column_name

$column_name = ''

protected

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

$default_value

$default_value

protected

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

$is_autocomplete

$is_autocomplete

protected

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

$is_primary

$is_primary

protected

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

$is_required

$is_required

protected

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

$is_unique

$is_unique

protected

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

---

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

• scalarfield.php