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

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

 __construct ($name, $parameters=array())
 BooleanField constructor. Подробнее...
 
 configureStorageValues ($falseValue, $trueValue)
 
 configureValues ($falseValue, $trueValue)
 Short alias for configureStorageValues. Подробнее...
 
 normalizeValue ($value)
 Convert true/false values to actual field values. Подробнее...
 
 booleanizeValue ($value)
 Converts any possible value to strict boolean. Подробнее...
 
 getValidators ()
 
 getValues ()
 
 isValueEmpty ($value)
 
 cast ($value)
 
 convertValueFromDb ($value)
 
 convertValueToDb ($value)
 
 getGetterTypeHint ()
 
 getSetterTypeHint ()
 
- Открытые члены унаследованные от 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)
 
- Открытые члены унаследованные от 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. Подробнее...
 

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

 $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
 

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

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

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

◆ __construct()

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

BooleanField constructor.

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

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

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

33  {
34  parent::__construct($name, $parameters);
35 
36  if (empty($parameters['values']))
37  {
38  $this->values = array(false, true);
39  }
40  else
41  {
42  $this->values = $parameters['values'];
43  }
44 
45  $this->addSaveDataModifier(array($this, 'normalizeValue'));
46  }
__construct(Base $connector)
Constructor.
Definition: resultview.php:40

Методы

◆ booleanizeValue()

booleanizeValue (   $value)

Converts any possible value to strict boolean.

Аргументы
$value
Возвращает
bool

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

113  {
114  if (is_bool($value))
115  {
116  return $value;
117  }
118 
119  $normalizedValue = $this->normalizeValue($value);
120  return (bool) array_search($normalizedValue, $this->values, true);
121  }
normalizeValue($value)
Convert true/false values to actual field values.

◆ cast()

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

Замещает IReadable.

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

156  {
157  return $this->booleanizeValue($value);
158  }
booleanizeValue($value)
Converts any possible value to strict boolean.

◆ configureStorageValues()

configureStorageValues (   $falseValue,
  $trueValue 
)
Аргументы
$falseValue
$trueValue
Возвращает
$this

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

55  {
56  $this->values = [$falseValue, $trueValue];
57  return $this;
58  }

◆ configureValues()

configureValues (   $falseValue,
  $trueValue 
)

Short alias for configureStorageValues.

Аргументы
$falseValue
$trueValue
Возвращает
BooleanField

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

69  {
70  return $this->configureStorageValues($falseValue, $trueValue);
71  }
configureStorageValues($falseValue, $trueValue)

◆ convertValueFromDb()

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

Замещает IReadable.

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

166  {
167  return $this->booleanizeValue($value);
168  }

◆ convertValueToDb()

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

Замещает IReadable.

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

177  {
178  return $this->getConnection()->getSqlHelper()->convertToDbString(
179  $this->normalizeValue($value)
180  );
181  }

◆ getGetterTypeHint()

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

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

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

187  {
188  return '\\boolean';
189  }

◆ getSetterTypeHint()

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

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

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

195  {
196  return '\\boolean';
197  }

◆ getValidators()

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

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

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

129  {
130  $validators = parent::getValidators();
131 
132  if ($this->validation === null)
133  {
134  $validators[] = new Validators\BooleanValidator;
135  }
136 
137  return $validators;
138  }

◆ getValues()

getValues ( )

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

141  {
142  return $this->values;
143  }

◆ isValueEmpty()

isValueEmpty (   $value)

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

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

146  {
147  return (strval($value) === '' && $value !== false);
148  }

◆ normalizeValue()

normalizeValue (   $value)

Convert true/false values to actual field values.

Аргументы
boolean | integer | string$value
Возвращает
mixed

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

79  {
80  if (
81  (is_string($value) && ($value == '1' || $value == '0'))
82  ||
83  (is_bool($value))
84  )
85  {
86  $value = (int) $value;
87  }
88  elseif (is_string($value) && $value == 'true')
89  {
90  $value = 1;
91  }
92  elseif (is_string($value) && $value == 'false')
93  {
94  $value = 0;
95  }
96 
97  if (is_integer($value) && ($value == 1 || $value == 0))
98  {
99  $value = $this->values[$value];
100  }
101 
102  return $value;
103  }

Поля

◆ $values

$values
protected

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


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