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

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

 __construct ($name, $parameters=array())
 DateField constructor. Подробнее...
 
 configureFormat ($format)
 
 getValidators ()
 
 assureValueObject ($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)
 
 isValueEmpty ($value)
 
- Открытые члены унаследованные от 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
 
- Защищенные данные унаследованные от 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
 

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

См. определение в файле main/lib/orm/fields/datefield.php строка 22

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

◆ __construct()

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

DateField constructor.

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

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

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

См. определение в файле main/lib/orm/fields/datefield.php строка 34

35  {
36  parent::__construct($name, $parameters);
37 
38  $this->addFetchDataModifier(array($this, 'assureValueObject'));
39  }
__construct(Base $connector)
Constructor.
Definition: resultview.php:40

Методы

◆ assureValueObject()

assureValueObject (   $value)
Аргументы
$value
Возвращает
Type\Date
Исключения
Main

См. определение в файле main/lib/orm/fields/datefield.php строка 71

72  {
73  if ($value instanceof Type\DateTime)
74  {
75  // oracle sql helper returns datetime instead of date - it doesn't see the difference
76  $value = new Type\Date(
77  $value->format(Main\UserFieldTable::MULTIPLE_DATE_FORMAT),
79  );
80  }
81 
82  return $value;
83  }

◆ cast()

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

Замещает IReadable.

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

См. определение в файле main/lib/orm/fields/datefield.php строка 91

92  {
93  if (!empty($value) && !($value instanceof Type\Date))
94  {
95  return new Type\Date($value, $this->format);
96  }
97 
98  return $value;
99  }

◆ configureFormat()

configureFormat (   $format)

См. определение в файле main/lib/orm/fields/datefield.php строка 41

42  {
43  $this->format = $format;
44 
45  return $this;
46  }

◆ convertValueFromDb()

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

Замещает IReadable.

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

См. определение в файле main/lib/orm/fields/datefield.php строка 108

109  {
110  return $this->getConnection()->getSqlHelper()->convertFromDbDate($value);
111  }

◆ convertValueToDb()

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

Замещает IReadable.

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

См. определение в файле main/lib/orm/fields/datefield.php строка 120

121  {
122  try
123  {
124  return $this->getConnection()->getSqlHelper()->convertToDbDate($value);
125  }
126  catch (ArgumentTypeException $e)
127  {
128  throw new ArgumentException(
129  "Type error in `{$this->name}` of `{$this->entity->getFullName()}`: ".$e->getMessage()
130  );
131  }
132  }

◆ getGetterTypeHint()

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

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

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

См. определение в файле main/lib/orm/fields/datefield.php строка 137

138  {
139  return '\\'.Date::class;
140  }

◆ getSetterTypeHint()

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

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

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

См. определение в файле main/lib/orm/fields/datefield.php строка 145

146  {
147  return '\\'.Date::class;
148  }

◆ getValidators()

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

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

См. определение в файле main/lib/orm/fields/datefield.php строка 53

54  {
55  $validators = parent::getValidators();
56 
57  if ($this->validation === null)
58  {
59  $validators[] = new Validators\DateValidator;
60  }
61 
62  return $validators;
63  }

Поля

◆ $format

$format = null
protected

См. определение в файле main/lib/orm/fields/datefield.php строка 24


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