Bitrix-D7  20.0.0
Класс ScalarField
Граф наследования:ScalarField:
Field IStorable ITypeHintable IReadable ArrayField BooleanField DateField EnumField FloatField IntegerField StringField DatetimeField TextField CryptoField

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

 __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$parametersdeprecated, use configure* and add* methods instead
Исключения

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

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

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

42  {
43  parent::__construct($name, $parameters);
44 
45  $this->is_primary = (isset($parameters['primary']) && $parameters['primary']);
46  $this->is_unique = (isset($parameters['unique']) && $parameters['unique']);
47  $this->is_required = (isset($parameters['required']) && $parameters['required']);
48  $this->is_autocomplete = (isset($parameters['autocomplete']) && $parameters['autocomplete']);
49 
50  $this->column_name = isset($parameters['column_name']) ? $parameters['column_name'] : $this->name;
51  $this->default_value = isset($parameters['default_value']) ? $parameters['default_value'] : null;
52  }

Методы

◆ configureAutocomplete()

configureAutocomplete (   $value = true)
Аргументы
boolean$value
Возвращает
$this

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

116  {
117  $this->is_autocomplete = (bool) $value;
118  return $this;
119  }

◆ configureColumnName()

configureColumnName (   $value)
Аргументы
string$value
Возвращает
$this

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

132  {
133  $this->column_name = $value;
134  return $this;
135  }

◆ configureDefaultValue()

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

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

156  {
157  $this->default_value = $value;
158  return $this;
159  }

◆ configurePrimary()

configurePrimary (   $value = true)
Аргументы
boolean$value
Возвращает
$this

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

68  {
69  $this->is_primary = (bool) $value;
70  return $this;
71  }

◆ configureRequired()

configureRequired (   $value = true)
Аргументы
boolean$value
Возвращает
$this

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

84  {
85  $this->is_required = (bool) $value;
86  return $this;
87  }

◆ configureUnique()

configureUnique (   $value = true)
Аргументы
boolean$value
Возвращает
$this

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

100  {
101  $this->is_unique = (bool) $value;
102  return $this;
103  }

◆ getColumnName()

getColumnName ( )

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

138  {
139  return $this->column_name;
140  }

◆ getDefaultValue()

getDefaultValue (   $row = null)
Аргументы
array$rowORM data row in case of dependency value on other values
Возвращает
callable|mixed|null

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

167  {
168  if (!is_string($this->default_value) && is_callable($this->default_value))
169  {
170  return call_user_func($this->default_value, $row);
171  }
172  else
173  {
174  return $this->default_value;
175  }
176  }

◆ getGetterTypeHint()

getGetterTypeHint ( )
Возвращает
string

Замещает ITypeHintable.

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

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

192  {
193  return '\\string';
194  }

◆ getSetterTypeHint()

getSetterTypeHint ( )
Возвращает
string

Замещает ITypeHintable.

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

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

200  {
201  return '\\string';
202  }

◆ getTypeMask()

getTypeMask ( )
Возвращает
int

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

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

58  {
59  return FieldTypeMask::SCALAR;
60  }

◆ isAutocomplete()

isAutocomplete ( )

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

122  {
123  return $this->is_autocomplete;
124  }

◆ isPrimary()

isPrimary ( )

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

74  {
75  return $this->is_primary;
76  }

◆ isRequired()

isRequired ( )

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

90  {
91  return $this->is_required;
92  }

◆ isUnique()

isUnique ( )

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

106  {
107  return $this->is_unique;
108  }

◆ isValueEmpty()

isValueEmpty (   $value)

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

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

179  {
180  if ($value instanceof SqlExpression)
181  {
182  $value = $value->compile();
183  }
184 
185  return (strval($value) === '');
186  }

◆ setColumnName()

setColumnName (   $column_name)
Аргументы
string$column_name

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

146  {
147  $this->column_name = $column_name;
148  }

Поля

◆ $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


Объявления и описания членов класса находятся в файле:
Bitrix\Main\ORM\Fields\Field\$name
$name
Definition: main/lib/orm/fields/field.php:27
Bitrix\Main\ORM\Fields\ScalarField\$default_value
$default_value
Definition: scalarfield.php:31
Bitrix\Main\ORM\Fields\ScalarField\$is_autocomplete
$is_autocomplete
Definition: scalarfield.php:26
Bitrix\Sender\Connector\__construct
__construct(Base $connector)
Constructor.
Definition: resultview.php:40
Bitrix\Main\ORM\Fields\FieldTypeMask\SCALAR
const SCALAR
Definition: fieldtypemask.php:17
Bitrix\Main\ORM\Fields\ScalarField\$is_unique
$is_unique
Definition: scalarfield.php:22
Bitrix\Main\ORM\Fields\ScalarField\$column_name
$column_name
Definition: scalarfield.php:28
Bitrix\Main\ORM\Fields\ScalarField\$is_primary
$is_primary
Definition: scalarfield.php:20
Bitrix\Main\ORM\Fields\ScalarField\$is_required
$is_required
Definition: scalarfield.php:24