Класс StringField

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

Открытые члены
	__construct ($name, $parameters=array())
	StringField constructor. Подробнее...
	configureFormat ($format)
	getFormat ()
	Shortcut for Regexp validator. Подробнее...
	getValidators ()
	configureSize ($size)
	getSize ()
	Returns the size of the field in a database (in characters). Подробнее...
	cast ($value)
	convertValueFromDb ($value)
	convertValueToDb ($value)
Открытые члены унаследованные от 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)
	getGetterTypeHint ()
	getSetterTypeHint ()
Открытые члены унаследованные от Field
	setEntity (Entity $entity)
	resetEntity ()
	validateValue ($value, $primary, $row, Result $result)
	modifyValueBeforeSave ($value, $data)
	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. Подробнее...

Защищенные данные
	$format = null
	$size = null
Защищенные данные унаследованные от 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

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

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

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

__construct()

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

StringField constructor.

Аргументы

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

Исключения

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

Переопределяется в CryptoField, CryptoField и SecretField.

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

    {
        parent::__construct($name, $parameters);
 
        if (!empty($parameters['format']))
        {
            $this->format = $parameters['format'];
        }
        if(isset($parameters['size']) && intval($parameters['size']) > 0)
        {
            $this->size = intval($parameters['size']);
        }
    }

Методы

cast()

cast

(

$value

)

Аргументы

mixed

$value

Возвращает

string

Замещает IReadable.

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

    {
        $value = (string) $value;
 
        if ($this->size !== null)
        {
            $value = mb_substr($value, 0, $this->size);
        }
 
        return $value;
    }

configureFormat()

configureFormat

(

$format

)

Аргументы

$format

Возвращает

$this

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

    {
        $this->format = $format;
        return $this;
    }

configureSize()

configureSize

(

$size

)

Аргументы

$size

Возвращает

$this

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

    {
        $this->size = $size;
        return $this;
    }

convertValueFromDb()

convertValueFromDb

(

$value

)

Аргументы

mixed

$value

Возвращает

string

Исключения

Замещает IReadable.

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

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

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

convertValueToDb()

convertValueToDb

(

$value

)

Аргументы

string

$value

Возвращает

string

Исключения

Замещает IReadable.

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

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

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

getFormat()

getFormat

(

)

Shortcut for Regexp validator.

Возвращает

null|string

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

    {
        return $this->format;
    }

getSize()

getSize

(

)

Returns the size of the field in a database (in characters).

Возвращает

int|null

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

    {
        return $this->size;
    }

getValidators()

getValidators

(

)

Возвращает

array|Validators\Validator[]|callback[]

Исключения

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

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

    {
        $validators = parent::getValidators();
 
        if ($this->format !== null)
        {
            $validators[] = new Validators\RegExpValidator($this->format);
        }
 
        return $validators;
    }

Поля

$format

$format = null

protected

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

$size

$size = null

protected

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

---

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

• stringfield.php