umiField

Описание

Этот класс служит для управления свойствами поля

Примеры использования

Пример 5. Создать поле с именем "Foo" и типом данных с идентификатором 3 (подробнее см. umiFieldType и umiFieldTypesCollection), после чего установить ему подсказку "Это новое поле" и сделать поле обязательным для заполения:


$fieldsCollection = umiFieldsCollection::getInstance();
$fieldId = $fieldsCollection->addField('foo', 'Foo', 3);
$field   = $fieldsCollection->getField($fieldId);
if($field) {
  $field->setTip("Это новое поле");
  $field->setIsRequired(true);

  var_dump($field->getTip());
  var_dump($field->getIsRequired());
}

Ожидаемый результат:

string(26) "Это новое поле" bool(true)

  • getDataType() — Получить идентификатор типа данных
  • getFieldType() — Получить тип данных поля (экземпляр класса umiFieldType)
  • getFieldTypeId() — Получить id типа данных поля (см. класс umiFieldType)
  • getGuideId() — Получить id справочника, с которым связано поле (справочник — это тип данных)
  • getIsInFilter() — Узнать, может ли поле участвовать в фильтрах
  • getIsInSearch() — Узнать, индексируется ли поле для поиска
  • getIsInheritable() — Узнать, наследуется ли значение поля. Зарезервировано, но пока не используется.
  • getIsLocked() — Узнать, заблокировано ли поле на изменение свойств
  • getIsRequired() — Проверить, является ли поле обязательным для заполнения
  • getIsSortable() — Проверить, является ли поле сортируемым
  • getIsSystem() — Узнать, является ли поле системным
  • getIsVisible() — Узнать видимость поля для пользователя
  • getName() — Получить имя поля (строковой идентификатор)
  • getRestrictionId() — Получить идентификатор формата значение (restriction), по которому валидируется значение поля
  • getTip() — Получить подсказку (короткую справку) для поля.
  • getTitle() — Получить название поля
  • setFieldTypeId() — Установить id типа данных поля (см. класс umiFieldType)
  • setGuideId() — Связать поле со справочником $guide_id (справочник - это тип данных)
  • setIsInFilter() — Указать может ли поле участвовать в фильтрах. Устанавливает флаг "Модифицирован".
  • setIsInSearch() — Указать будет ли поле индексироваться для поиска. Устанавливает флаг "Модифицирован".
  • setIsInheritable() — Указать наследуется ли значение поля. Зарезервировано, но пока не используется. Устанавливает флаг "Модифицирован".
  • setIsLocked() — Выставить полю статус "Заблокирован/Разблокирован". Устанавливает флаг "Модифицирован".
  • setIsRequired() — Установить, что поле является обязательным для заполнения
  • setIsSortable() — Установить поле сортируемым
  • setIsSystem() — Указать будет ли поле системным
  • setIsVisible() — Указать видимо ли поле для пользователя. Устанавливает флаг "Модифицирован".
  • setName() — Задать новое имя поля (строковой идентификатор). Устанавливает флаг "Модифицирован".
  • setRestrictionId() — Изменить id рестрикшена, по которому валидируется значение поля
  • setTip() — Установить новую подсказку (короткую справку) для поля. Устанавливает флаг "Модифицирован".
  • setTitle() — Задать новое описание поля. Устанавливает флаг "Модифицирован".
  • isImportant() — Узнать, должно ли поле всегда отображаться на странице редактирования объекта или страницы
  • setImportanceStatus() — Указать будет ли поле всегда отображаться на странице редактирования объекта или страницы