Класс StringField

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

Открытые члены
	__construct ($name, $parameters=array())
	configureFormat ($format)
	getFormat ()
	getValidators ()
	configureSize ($size)
	getSize ()
	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 ()
	configureNullable ($value=true)
	isNullable ()
	configureBinary ($value=true)
	isBinary ()
	configureFulltext ($value=true)
	isFulltext ()
	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)
	getTitle ()
	setParameter ($name, $value)
	getParameter ($name)
	hasParameter ($name)
	setParentField (Field $parentField)
	getParentField ()
	getDataType ()
	getEntity ()
	getLangCode ()
	setConnection ($connection)
	getConnection ()
	serialize ($value)
	unserialize ($value)
	postInitialize ()

Защищенные данные
	$format = null
	$size = null
Защищенные данные унаследованные от ScalarField
	$is_primary
	$is_unique
	$is_required
	$is_autocomplete
	$is_private
	$is_nullable
	$is_binary = false
	$is_fulltext = false
	$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
	$connection = null

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

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

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

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

__construct()

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

StringField constructor.

Аргументы

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

Исключения

Bitrix\Main\SystemException

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

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

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

Методы

cast()

cast

(

$value

)

Аргументы

mixed

$value

Возвращает

string

Замещает IReadable.

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

configureFormat()

configureFormat

(

$format

)

Аргументы

$format

Возвращает

$this

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

configureSize()

configureSize

(

$size

)

Аргументы

$size

Возвращает

$this

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

convertValueFromDb()

convertValueFromDb

(

$value

)

Аргументы

mixed

$value

Возвращает

string

Исключения

Bitrix\Main\SystemException

Замещает IReadable.

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

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

convertValueToDb()

convertValueToDb

(

$value

)

Аргументы

string

$value

Возвращает

string

Исключения

Bitrix\Main\SystemException

Замещает IReadable.

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

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

getFormat()

getFormat

(

)

Shortcut for Regexp validator

Возвращает

null|string

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

getSize()

getSize

(

)

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

Возвращает

int|null

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

getValidators()

getValidators

(

)

Возвращает

array|Validators\Validator[]|callback[]

Исключения

Bitrix\Main\ArgumentTypeException

Исключения

Bitrix\Main\SystemException

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

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

Поля

$format

$format = null

protected

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

$size

$size = null

protected

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

---

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

• C:/bitrix/modules/main/lib/orm/fields/stringfield.php