Bitrix-D7  20.5.0
Класс EnumField
Граф наследования:EnumField:
ScalarField Field IStorable ITypeHintable IReadable

Открытые члены

 __construct ($name, $parameters=array())
 EnumField constructor. Подробнее...
 
 postInitialize ()
 
 configureValues ($values)
 
 getValidators ()
 
 getValues ()
 
 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)
 

Защищенные данные

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

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

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

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

◆ __construct()

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

EnumField constructor.

Аргументы
$name
array$parametersdeprecated, use configure* and add* methods instead
Исключения
SystemException

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

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

31  {
32  parent::__construct($name, $parameters);
33 
34  if (isset($parameters['values']))
35  {
36  $this->values = $parameters['values'];
37  }
38  }
__construct(Base $connector)
Constructor.
Definition: resultview.php:40

Методы

◆ cast()

cast (   $value)
Аргументы
mixed$value
Возвращает
mixed

Замещает IReadable.

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

98  {
99  return $value;
100  }

◆ configureValues()

configureValues (   $values)
Аргументы
$values
Возвращает
$this

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

65  {
66  $this->values = $values;
67  return $this;
68  }

◆ convertValueFromDb()

convertValueFromDb (   $value)
Аргументы
mixed$value
Возвращает
mixed

Замещает IReadable.

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

108  {
109  return $value;
110  }

◆ convertValueToDb()

convertValueToDb (   $value)
Аргументы
mixed$value
Возвращает
string
Исключения
SystemException

Замещает IReadable.

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

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

◆ getValidators()

getValidators ( )
Возвращает
array|Validators\Validator[]|callback[]
Исключения
SystemException

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

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

76  {
77  $validators = parent::getValidators();
78 
79  if ($this->validation === null)
80  {
81  $validators[] = new Validators\EnumValidator;
82  }
83 
84  return $validators;
85  }

◆ getValues()

getValues ( )

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

88  {
89  return $this->values;
90  }

◆ postInitialize()

postInitialize ( )

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

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

41  {
42  if (!is_array($this->values))
43  {
44  throw new SystemException(sprintf(
45  'Parameter "values" for %s field in `%s` entity should be an array',
46  $this->name, $this->entity->getDataClass()
47  ));
48  }
49 
50  if (empty($this->values))
51  {
52  throw new SystemException(sprintf(
53  'Required parameter "values" for %s field in `%s` entity is not found',
54  $this->name, $this->entity->getDataClass()
55  ));
56  }
57  }

Поля

◆ $values

$values
protected

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


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