Логотип

Документация по API UMI.CMS

Руководство пользователя Документация по макросам и шаблонам
  • Миграция на php7
  • Разработка нестандартного функционала
  • Справочник по классам ядра UMI.CMS
    • Модель данных
      • umiFieldTypesCollection
        • addFieldType()
          Создать новый тип поля
        • delFieldType()
          Удалить тип поля с заданым идентификатором из коллекции
        • getFieldType()
          Получить экземпляр класса umiFieldType по идентификатору
        • getFieldTypesList()
          Возвращает список всех типов полей
        • getInstance()
          Получить экземпляр коллекции
      • umiFieldType
        • getName()
          Получить описание типа
        • getIsMultiple()
          Узнать, может ли значение поля данного типа состоять из массива значений (составной тип)
        • getIsUnsigned()
          Узнать, может ли значение поля данного типа иметь знак (зарезервировано, не используется в данный момент)
        • getDataType()
          Получить идентификатор типа
        • setName()
          Задать новое описание типа. Устанавливает флаг "Модифицирован".
        • setIsMultiple()
          Указать может ли значение поля данного типа состоять из массива значений (составной тип). Устанавливает флаг "Модифицирован".
        • setIsUnsigned()
          Указать может ли значение поля данного типа иметь знак (зарезервировано, не используется в данный момент). Устанавливает флаг "Модифицирован".
        • setDataType()
          Установить идентификатор типа. Устанавливает флаг "Модифицирован".
        • getDataTypes()
          Получить список всех поддерживаемых идентификаторов типа
        • getDataTypeDB()
          Получить имя поля таблицы БД, где будут хранится данные по идентификатору типа
        • isValidDataType()
          Узнать, поддерживается ли идентификатор типа
      • umiFieldsCollection
        • getField()
          Получить экземпляр класса umiField, соответствующий полю с id = $field_id
        • delField()
          Удалить поле с заданым идентификатором из коллекции
        • addField()
          Создать новое поле
        • isExists()
          Проверить, существует ли в БД поле с заданным идентификатором
        • getInstance()
          Возвращает umiFieldsCollection экземпляр класса
      • umiField
        • 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()
          Указать будет ли поле всегда отображаться на странице редактирования объекта или страницы
      • umiFieldsGroup
        • attachField()
          Присоединить к группе еще одно поле
        • detachField()
          Вывести поле из группы полей. При этом поле физически не удаляется, так как может одновременно фигурировать в разный группах полей разных типов данных.
        • getAllGroupsByName()
          Получить список всех групп с указанным названием вне зависимости от типа данных
        • getFields()
          Получить список всех полей в группе
        • getIsActive()
          Узнать, активна ли группа полей
        • getIsLocked()
          Узнать, заблокирована ли группа полей (разработчиком)
        • getIsVisible()
          Узнать, видима ли группа полей
        • getName()
          Получить строковой id группы
        • getOrd()
          Получить порядковый номер группы, по которому она сортируется в рамках типа данных
        • getTitle()
          Получить название группы
        • getTypeId()
          Получить id типа данных, к которому относится группа полей
        • loadFields()
          Не используйте этот метод в прикладном коде.
        • moveFieldAfter()
          Переместить поле $field_id после поля $after_field_id в группе $group_id
        • setIsActive()
          Изменить активность группы полей
        • setIsLocked()
          Изменить состояние блокировки группы полей
        • setIsVisible()
          Изменить видимость группы полей
        • setName()
          Изменить строковой id группы на на указанный
        • setOrd()
          Установить новое значение порядка сортировки
        • setTitle()
          Изменить название группы полей
        • setTypeId()
          Изменить тип данных, которому принадлежит группа полей
        • setTip()
          Установить новую подсказку для группы полей
        • getTip()
          Получить подсказку группы полей
      • umiObjectTypesCollection
        • addType()
          Создать тип данных с названием $name, дочерний от типа $parent_id
        • delType()
          Удалить тип данных с id $type_id. Все объекты этого типа будут автоматически удалены без возможности восстановления. Все дочерние типы от $type_id будут удалены рекурсивно.
        • getTypeIdByHierarchyTypeName()
          Получить тип данных, связанный с базовым типом (класс umiHierarchyType) $module/$method
        • getChildTypeIds()
          Получить список всех дочерних типов от $type_id на всю глубину наследования
        • getGuidesList()
          Получить список типов данных, которые можно использовать в качестве справочников
        • getInstance()
          Возвращает экземпляр класса umiObjectTypesCollection
        • getParentTypeId()
          Получить id типа данных, который является непосредственным родителем типа $type_id
        • getSubTypesList()
          Получить список дочерних типов по отношению к указанному типу
        • getType()
          Получить тип по его id
        • getTypeIdByHierarchyTypeId()
          Получить тип данных, связанный с базовым типом (umiHierarchyType) $hierarchy_type_id
        • getTypesByHierarchyTypeId()
          Получить список всех типов данных, связанных с базовым типом (umiHierarchyType) $hierarchy_type_id
      • umiObjectType
      • umiObjectsCollection
        • addObject()
          Создать новый объект в БД
        • addUpdatedObjectId()
          Указать, что $object_id был изменен во время сессии. Используется внутри ядра. Явный вызов этого метода клиентским кодом не нужен.
        • cloneObject()
          Сделать копию объекта и всех его свойств
        • delObject()
          Удалить объект с id $object_id. Если объект заблокирован, он не будет удален. При удалении принудительно вызывается commit() на удаляемом объекте. Нельзя удалить пользователей с id 14, 2373, нельзя удалить группу супервайзеров.
        • getCollectedObjects()
          Получить id всех объектов, загруженных в коллекцию
        • getGuidedItems()
          Получить отсортированный по имени список всех объектов в справочнике $guide_id (id типа данных).
        • getInstance()
          Возвращает экземпляр класса umiObjectsCollection
        • getObject()
          Получить экземпляр объекта с id $object_id
        • getUpdatedObjects()
          Получить список измененных объектов за текущую сессию
        • unloadObject()
          Выгрузить объект из коллекции
        • __destruct()
          Деструктор коллекции. Явно вызывать его не нужно никогда.
        • getObjectsLastUpdateTime()
          Возвращает максимальное время последней модификации объектов, загруженных в текущей сессии
        • changeOrder()
          Меняет индекс сортировки двух объектов
        • reBuildOrder()
          Перестраивает индекс сортировки
        • getMaxOrderByTypeId()
          Максимальное значение индекса сортировки
      • umiObject
        • getName()
          Получить название объекта
        • getTypeId()
          Получить id типа объекта
        • getIsLocked()
          Узнать, заблокирован ли объект. Метод зарезервирован, но не используется. Предполагается, что этот флаг будет блокировать любое изменение объекта
        • setName()
          Задать новое название объекта. Устанавливает флаг "Модифицирован".
        • setTypeId()
          Установить новый id типа данных (класс umiObjectType) для объекта. Используйте этот метод осторожно, потому что он просто переключает id типа данных.
        • setIsLocked()
          Выставить объекту статус "Заблокирован". Этот метод зарезервирован, но в настоящее время не используется.
        • setOwnerId()
          Установить id владельца объекта. Это означает, что пользователь с id $ownerId полностью владеет этим объектом: создал его, может модифицировать, либо удалить.
        • getOwnerId()
          Получить id пользователя, который владеет этим объектом
        • getPropByName()
          Получить свойство объекта по его строковому идентификатору
        • getPropById()
          Получить свойство объекта по его числовому идентификатору (просто id)
        • isPropertyExists()
          Узнать, существует ли свойство с id $field_id
        • isPropGroupExists()
          Узнать, существует ли группа полей с id $prop_group_id у объекта
        • getPropGroupId()
          Получить id группы полей по ее строковому идентификатору
        • getPropGroupByName()
          Получить группу полей по ее строковому идентификатору
        • getPropGroupById()
          Получить группу полей по ее id
        • getValue()
          Получить значение свойства $prop_name объекта
        • setValue()
          Установить значение свойства с $prop_name данными из $prop_value. Устанавливает флаг "Модифицирован". Значение в БД изменится только когда на объекте будет вызван метод commit(), либо в деструкторе объекта
        • setIsUpdated()
          Вручную установить флаг "Модифицирован"
        • getTypeGUID()
          Получить строковый идентификатор типа объекта
        • setUpdateTime()
          Устанавливает время изменения объекта. Устанавливает флаг "Модифицирован"
        • getUpdateTime()
          Возвращает время последнего изменения объекта
        • getOrder()
          Возвращает значение индекса сортировки объекта
        • setOrder()
          Устанавливает значение индекса сортировки объекта
      • umiObjectProperty
        • __construct()
          Конструктор класса
        • getId()
          Получить уникальный идентификатор свойства
        • getValue()
          Получить значение свойства
        • getName()
          Получить имя свойства
        • getTitle()
          Получить описание свойства
        • setValue()
          Установить значение свойства. Устанавливает флаг "Модифицирован". Значение в БД изменится только когда на экземпляре umiObjectProperty будет вызван метод commit(), либо в деструкторе экземпляра
        • resetValue()
          Сбросить значение свойства. Устанавливает флаг "Модифицирован". Значение в БД изменится только когда на экземпляре umiObjectProperty будет вызван метод commit(), либо в деструкторе экземпляра
        • getIsMultiple()
          Узнать, может ли значение данного свойства состоять из массива значений (составной тип)
        • getIsUnsigned()
          Узнать, может ли значение данного свойства иметь знак. Зарезервировано и пока не используется
        • getDataType()
          Получить идентификатор типа поля, связанного с данным свойством
        • getIsLocked()
          Узнать, заблокировано ли свойство на изменение
        • getIsInheritable()
          Узнать, наследуется ли значение свойства. Зарезервировано, но пока не используется.
        • getIsVisible()
          Узнать видимость свойства для пользователя
        • getObject()
          Возвращает связанный с этим свойством объект (umiObject) Смотрите также umiObject
        • getObjectId()
          Возвращает id объекта (umiObject), связанного с этим свойством Смотрите также umiObject
        • getField()
          Возвращает тип свойства (umiFieldType) Смотрите также umiFieldType
        • getProperty()
          Возвращает umiObjectProperty объект свойства
        • filterInputString()
          Сохраняет значение свойства в БД, если тип свойства "Тэги"
        • filterOutputString()
          Возвращает String отфильтрованная строка
        • filterCDATA()
          Возвращает String отфильтрованная строка
        • objectsByValue()
          Не используйте этот метод, его поведение будет изменено в ближайших версиях
      • baseRestriction
        • get()
          Получает экземпляр рестрикшена по его id
        • getList()
          Получает список всех возможных рестрикшенов
        • add()
          Добавить новый рестрикшен для определенного типа полей
        • validate()
          Провалидировать значение поля, за которым закреплен рестрикшен
        • getErrorMessage()
          Получить текст ошибки, который будет выведен пользователю в случае, если рестрикшен не провалидировался
        • getTitle()
          Получить название рестрикшена
        • getClassName()
          Получить строковой идентификатор рестрикшена
        • getId()
          Получить id рестрикшена
        • getFieldTypeId()
          получить id типа поля
        • find()
          Получить экземпляр рестрикэшна $classPrefix для типа полей $fieldTypeId, если такой существует
        • normalizeIn()
          Преобразовать значение поля перед сохранением в базу
        • normalizeOut()
          Преобразовать значение поля после загрузки из базы
      • umiBranch
    • Модель иерархии
      • domainsCollection
        • addDomain()
          Добавить в систему новый домен
        • setDefaultDomain()
          Установить домен по умолчанию
        • delDomain()
          Удалить домен из системы
        • getDomain()
          Получить экземпляр домена (класс domain)
        • getDefaultDomain()
          Получить домен по умолчанию
        • getList()
          Получить список доменов в системе
        • getDomainId()
          Получить id домена по его хосту (адресу домена)
        • getInstance()
          Возвращает domainsCollection экземпляр коллекции
        • getDomainByHost()
          Получить домен по значению host
        • isExists()
          Проверить, существует ли домен с заданным идентификатором
        • getDomainIdByUrl()
          Получить идентификатор домена по url
        • isDefaultDomain()
          Является ли данный домен доменом по умолчанию
      • domain
        • getHost()
          Получить адрес домена (хост)
        • getIsDefault()
          Узнать, является ли этот домен доменом по умолчанию
        • setHost()
          Изменить хост (адрес) домена
        • getDefaultLangId()
          Получить id языка (класс lang), который используется по умолчанию для этого домена
        • setDefaultLangId()
          Установить для домена язык по умолчанию
        • addMirrow()
          Добавить зеркало (класс domainMirrow) для домена
        • delMirrow()
          Удалить зеркало домена, используя его id
        • delAllMirrows()
          Удалить все зеркала домена
        • getMirrowId()
          Определить id зеркала домена по его хосту (адресу)
        • getMirrow()
          Получить зеркало домена (экземпляр класса domainMirrow) по его id
        • isMirrowExists()
          Проверить, существует ли у домена зеркало с id $mirrow_id
        • getMirrowsList()
          Получить список всех зеркал домена
        • setIsDefault()
          Установить/снять с домена флаг "Домен по умолчанию"
        • isUsingSsl()
          Использует ли домен SSL
        • setUsingSsl()
          Установить/снять для домена флаг "Использует SSL"
        • getFavicon()
          Получить изображение favicon домена
        • setFavicon()
          Установить изображение favicon для домена
      • domainMirrow
        • setHost()
          Изменить хост (адрес) зеркала
        • getHost()
          Получить хост (адрес) зеркала
      • langsCollection
        • addLang()
          Создать новый язык
        • delLang()
          Удалить язык с id $lang_id
        • getAssocArray()
          Получить список всех языков в системе в виде ассоциативного массива
        • getLang()
          Получить язык (экземпляр касса lang) по его id
        • getLangId()
          Получить id языка (класс lang) по его префиксу
        • getList()
          Получить список всех языков в системе
        • getInstance()
          Возвращает экземпляр класса langsCollection
      • lang
        • getTitle()
          Получить название языка
        • getPrefix()
          Получить префикс языка (его 2х или 3х символьный код)
        • setTitle()
          Установить новое название языка
        • setPrefix()
          Установить новый префикс для языка
      • templatesCollection
        • delTemplate()
          Удалить шаблон дизайна
        • getTemplate()
          Получить шаблон дизайна по его id
        • isExists()
          Проверить, существует ли шаблон дизайна с id $template_id
        • getInstance()
          Возвращает templatesCollection экземпляр класса templatesCollection
        • addTemplate()
          Добавить новый шаблон дизайна
      • template
        • getFilename()
          Получить название файла шаблона дизайна
        • getTitle()
          Получить название шаблона дизайна
        • getDomainId()
          Получить id домена, к которому привязан шаблон
        • getLangId()
          Получить id языка, к которому привязан шаблон
        • getIsDefault()
          Узнать, является ли данный шаблон шаблоном по умолчанию
        • setFilename()
          Изменить название файла шаблона
        • setTitle()
          Изменить название шаблона дизайна
        • setDomainId()
          Изменить домен, к которому привязан шаблон дизайна
        • setLangId()
          Изменить язык, к которому привязан шаблон
        • setIsDefault()
          Изменить флаг "по умолчанию"
        • getUsedPages()
          Получить список страниц, которые используют этот шаблон
        • setUsedPages()
          Привязать страницы сайта к шаблону
        • getTotalUsedPages()
          Возвращает общее число страниц, которые используют текущий шаблон
        • getRelatedPages()
          Возвращает список элементов, у которых установлен текущий шаблон
      • umiHierarchy
        • isExists()
          Проверяет, существует ли страница с заданным идентификатором
        • isLoaded()
          Проверяет, загружена ли в память страница с заданным идентификатором
        • getElement()
          Получить экземпляр страницы c заданным идентификатором
        • delElement()
          Удалить страницу с указанным идентификатором
        • copyElement()
          Создать виртуальную копию (подобие symlink в файловых системах) страницы с указанным идентификатором
        • cloneElement()
          Создать копию страницы с указанным идентификатором вместе со всеми данными
        • getDeletedList()
          Получить список удаленных страниц (страниц в корзине)
        • restoreElement()
          Восстановить страницу из корзины
        • removeDeletedElement()
          Навсегда удалить из корзины страницу (и из БД)
        • removeDeletedAll()
          Удалить все страницы из корзины (и из БД)
        • getParent()
          Получить идентификатор родительской страницы для страницы с указанным идентификатором
        • getAllParents()
          Получить список всех родительских страниц
        • getChildrenTree()
          Получить список дочерних страниц по отношению к указанной странице
        • getChildrenCount()
          Получить количество дочерних страниц по отношению к указанной странице
        • forceAbsolutePath()
          Переключить режим генерации урлов между относительным и полным (включать адрес домена даже если он совпадает с текущим доменом)
        • getPathById()
          Получить адрес страницы по ее id
        • getIdByPath()
          Получить id страницы по ее адресу
        • addElement()
          Добавить новую страницу
        • getDefaultElementId()
          Получить идентификатор страницы со статусом "по умолчанию" (главная страница) для указанного домена и языка
        • convertAltName()
          Конвертирует предлагаемый псевдостатический адрес в транслит и убирает недопустимые символы
        • moveBefore()
          Переместить страницу с указанным id в страницу $rel_id перед страницей $before_id
        • moveFirst()
          Переместить страницу с указанным id в страницу c $rel_id в начало списка
        • isAllowed()
          Проверить, есть ли права на чтение указанной страницы для текущего пользователя
        • getDominantTypeId()
          Определить id типа данных, которому принадлежат больше всего дочерних страниц для указанной страницы
        • addUpdatedElementId()
          Пометить страницу с указанным id как измененную в рамках текущей сессии
        • getUpdatedElements()
          Получить список страниц, измененных в рамках текущей сессии
        • __destruct()
          Деструктор
        • getCollectedElements()
          Получить список страниц, которые были запрошены в текущей сессии
        • unloadElement()
          Выгрузить экземпляр страницы с указанным id из памяти коллекции
        • getElementsLastUpdateTime()
          Получить максимальное значение атрибута "дата последней модификации" для всех страниц, загруженных в текущей сессии
        • getObjectInstances()
          Получить все страницы, использующие указанный объект (класс umiObject) в качестве источника данных
        • getDominantTplId()
          Получить id шаблона, который больше всего используется у подстраниц указанной страницы
        • getLastUpdatedElements()
          Получить список страниц, измененных с даты $timestamp
        • checkIsVirtual()
          Проверить список страниц на предмет того, имеют ли они виртуальные копии
        • getInstance()
          Возвращает umiHierarchy экземпляр класса umiHierarchy
        • getChildrenList()
          Получить список id дочерних элементов на всю глубину вложенности.
        • loadElements()
          Загружает элементы по переданному списку их ID
        • getOriginalPage()
          Возвращает оригинальную (первую) страницу, связанную с заданным объектом
      • umiHierarchyElement
        • commit()
          Применить все изменения сделанные с этой страницей
        • delete()
          Удалить страницу (поместить в Корзину).
        • getIsDeleted()
          Узнать, удалена ли страница в корзину или нет
        • getIsActive()
          Узнать, активна страница или нет
        • getIsVisible()
          Узнать, видима ли страница в меню или нет
        • getLangId()
          Получить id языка (класс lang), к которому привязана страница
        • getDomainId()
          Получить id домена (класс domain), к которому привязана страница
        • getTplId()
          Получить id шаблона дизайна (класс template), по которому отображается страница
        • getTypeId()
          Получить id базового типа (класс umiHierarchyType), который определяет поведение страницы на сайте
        • getUpdateTime()
          Получить время последней модификации страницы
        • getOrd()
          Получить порядок страницы относительно соседних страниц
        • getAltName()
          Получить псевдостатический адрес страницы, по которому строится ее адрес
        • getIsDefault()
          Получить флаг "по умолчанию" у страницы
        • getObject()
          Получить объект (класс umiObject), который является источником данных для страницы
        • getParentId()
          Получить id родительской страницы.
        • getName()
          Получить название страницы
        • getFieldId()
          Получить id поля по его строковому идентификатору
        • getValue()
          Получить значение свойства $prop_name
        • getObjectTypeId()
          Получить id типа данных (класс umiObjectType), к которому относится объект (класс umiObject) источник данных.
        • getHierarchyType()
          Получить базовый тип, к которому относится страница
        • getObjectId()
          Получить id объекта (класс umiObject), который служит источником данных для страницы
        • getModule()
          Получить название модуля базового типа страницы
        • getMethod()
          Получить название метода базового типа страницы
        • getIsBroken()
          Узнать, все ли в порядке с этим экземпляром
        • setValue()
          Изменить значение свойства $prop_name на $prop_value
        • setName()
          Изменить название страницы
        • setIsVisible()
          Установить флаг, означающий, что страница может быть видима в меню
        • setIsActive()
          Установить флаг активности
        • setIsDeleted()
          Установить флаг "удален", который сигнализирует о том, что страница помещена в корзину
        • setTypeId()
          Изменить id базового типа (класс umiHierarchyType), который определяет поведение страницы на сайте
        • setLangId()
          Изменить id языка (класс lang), к которому привязана страница
        • setTplId()
          Изменить шаблон дизайна, по которому отображается страница на сайте
        • setDomainId()
          Изменить домен (класс domain), к которому привязана страница
        • setUpdateTime()
          Изменить время последней модификации страницы
        • setOrd()
          Изменить номер порядка следования страницы в структуре относительно других страниц
        • setRel()
          Изменить родителя страницы
        • setObject()
          Изменить объект-источник данных страницы
        • setAltName()
          Изменить псевдостатический адрес, который участвует в формировании адреса страницы
        • setIsDefault()
          Изменить значение флаг "по умолчанию"
        • setIsUpdated()
          Изменить флаг измененности. Если экземпляр не помечен как измененный, метод commit() блокируется.
        • updateSiteMap()
          Обновить часть sitemap для данной страницы
        • hasVirtualCopy()
          проверяет есть ли у страницы виртуальные копии
        • isOriginal()
          Проверяет является ли страница "оригинальной" по отношению к ее виртуальным копиям
      • umiHierarchyTypesCollection
        • getType()
          Получить тип по его id
        • addType()
          Добавить новый иерархический тип
        • delType()
          Удалить тип
        • isExists()
          Проверить, существует ли иерархический тип с таким id
        • getTypesList()
          Получить список всех иерархических типов
        • getInstance()
          Возвращает umiHierarchyTypesCollection экземпляр коллекции
      • umiHierarchyType
        • getName()
          Получить название модуля, отвечающего за этот базовый тип
        • getTitle()
          Получить название базового типа
        • getExt()
          Получить название метода, отвечающего за этот базовый тип
        • setName()
          Изменить название модуля, отвечающего за этот базовый тип
        • setTitle()
          Изменить название базового типа
        • setExt()
          Изменить название метода, отвечающего за этот базовый тип
    • Модель прав доступа
      • permissionsCollection
        • __construct()
          Конструктор
        • getOwnerType()
          Внутрисистемный метод, не является частью публичного API
        • makeSqlWhere()
          Внутрисистемный метод, не является частью публичного API
        • isAllowedModule()
          Узнать, разрешен ли пользователю или группе $owner_id доступ к модулю $module
        • isAllowedMethod()
          Узнать, разрешен ли пользователю или группе $owner_id доступ к методу $method модуля $module
        • isAllowedObject()
          Узнать, разрешен ли пользователю или группе $owner_id доступ на чтение страницы $object_id (класс umiHierarchyElement)
        • isSv()
          Узнать, является ли пользователь $user_id супервайзером
        • isAdmin()
          Узнать, является ли пользователь $user_id администратором, т. е. есть ли у него доступ администрированию хотя бы одного модуля
        • isOwnerOfObject()
          Узнать, является ли пользователь $user_id владельцем объекта (класс umiObject) $object_id
        • setDefaultPermissions()
          Сбросить настройки прав до дефолтных для страницы (класс umiHierarchyElement) $element_id
        • resetElementPermissions()
          Удалить все права на страницу $elementId для пользователя или группы $ownerId
        • resetModulesPermissions()
          Сбросить все права на модули и методы для пользователя или группы $ownerId
        • setElementPermissions()
          Установить определенные права на страницу $elementId для пользователя или группы $ownerId
        • hasUserPermissions()
          Узнать, имеет ли пользователь или группа в принципе права на какие-нибудь страницы
        • copyHierarchyPermissions()
          Скопировать права на все страницы из $fromUserId в $toUserId
        • getUserId()
          Получить id текущего пользователя
        • isAllowedDomain()
          Узнать, разрешено ли пользователю или группе $owner_id администрировать домен $domain_id
        • setAllowedDomain()
          Установить права пользователю или группе $owner_id на администрирование домена $domain_id
        • setDefaultElementPermissions()
          Установить права по умолчанию для страницы $element по отношению к пользователю $owner_id
        • setAllElementsDefaultPermissions()
          Сбросить для пользователя или группы $owner_id права на все страницы на дефолтные
        • getUsersByElementPermissions()
          Получить список всех пользователей или групп, имеющих права на страницу $elementId
        • pushElementPermissions()
          Указать права на страницу. Влияет только на текущую сессию, данные в базе изменены не будут
        • getInstance()
          Возвращает permissionsCollection экземпляр класса permissionsCollection
        • getGuestId()
          Возвращает integer $guestId id пользователя "Гость"
    • Модель торговых предложений
    • Другие модели
      • searchModel
        • __construct()
          Класс для работы с поисковой базой по сайту.
        • index_all()
          Проиндексировать все страницы, где дата последней модификации меньше даты последней индексации
        • index_item()
          Проиндексировать определенную страницу
        • elementIsReindexed()
          Узнать, индексировалась ли страница $element_id после даты $updatetime
        • getIndexPages()
          Получить количество проиндексированных страниц
        • getIndexWords()
          Получить количество проиндексированных слов
        • getIndexWordsUniq()
          Получить количество проиндексированных уникальных слов
        • getIndexLast()
          Получить дату последней индексации
        • truncate_index()
          Очистить поисковый индекс
        • runSearch()
          Искать по поисковому индексу
        • getContext()
          Получить контекст, в котором употреблены поисковые слова на странице $element_id
        • unindex_items()
          Стереть индекс для страницы $element_id
        • index_items()
          Проиндексировать страницу $element_id и всех ее детей
        • calculateIDF()
          Посчитать IDF слова $wordId
        • getInstance()
          Возвращает searchModel экземпляр класса
        • getWordId()
          Возвращает integer|boolean id слова, либо false
      • backupModel
        • getChanges()
          Получить список изменений для страницы $cparam
        • save()
          Сохранить как точку восстановления текущие изменения для страницы $cparam
        • rollback()
          Восстановить данные из резервной точки $revision_id
        • addLogMessage()
          Добавить сообщение в список изменений страницы $elementId без занесения самих изменений
        • getInstance()
          Класс для управления резервными копиями страниц
      • garbageCollector
        • run()
          Запустить сборщик мусора. Сбрасывает счетчик итераций в ноль.
        • checkMaxIterations()
          Проверить, не превысили ли мы лимит по количеству итераций
      • cacheFrontend
        • getIsConnected()
          Данный метод устарел
        • save()
          Сохранить в кэш объект из ядра системы
        • load()
          Загрузить из кэша объект ядра системы
        • saveSql()
          Сохранить данные как результат запроса
        • loadSql()
          Загрузить данные как результат запроса
        • saveData()
          Сохранить обычные данные (строка, число)
        • saveObject()
          Данный метод устарел
        • saveElement()
          Данный метод устарел
        • loadData()
          Загрузить обычные данные (строка, число)
        • makeSleep()
          Приостановить работу кэша
        • del()
          Удалить ключ из кэша
        • flush()
          Сбросить весь кэш
        • getCurrentCacheEngineName()
          Получить название текущего cache engine
        • switchCacheEngine()
          Изменить cacheEngine, который используется системой
        • getInstance()
          Возвращает cacheFrontend экземпляр коллекции
        • getPriorityEnginesList()
          Возвращает Array список названий cacheEngine
        • chooseCacheEngine()
          Возвращает String|boolean название cacheEngine, либо false, если ничего не подходит
      • umiCron
      • umiLinksHelper
      • umiPropertiesHelper
      • umiTypesHelper
      • FilterIndexGenerator
        Класс для генерации индекса фильтруемых полей
      • FilterQueriesMaker
        Класс для фильтрации по индексу.
    • События
      • umiEventsController
        • callEvent()
          Вызвать событие и выполнить все обработчики, которые его слушают
        • registerEventListener()
          Зарегистрировать в коллекции обработчик события
        • getInstance()
          Возвращает umiEventsController
      • umiEventListener
        • setPriority()
          Установить приоритет обработчика события. В текущих версиях еще не реализовано
        • getPriority()
          Узнать текущий приоритет
        • setIsCritical()
          Установить критичность обработчика события. Если событие критично, то при возникновении любого исключения в этом обработчике, цепочка вызова обработчиков событий будет прервана.
        • getIsCritical()
          Получить критичность обработчика события
        • getEventId()
          Узнать строковой id события, который прослушивает этот обработчик события
        • getCallbackModule()
          Узнать, какой модуль будет выполнять обработку события
        • getCallbackMethod()
          Узнать, какой метод будет выполнять обработку события
      • umiEventPoint
        • __construct()
          Конструктор, который принимает идентификатор события
        • getEventId()
          Получить id события
        • setParam()
          Добавить параметр к событию. Позволяет передавать в обработчики события параметры
        • getParam()
          Получить параметр события
        • addRef()
          Добавить параметр-ссылку на значение, чтобы можно было из обработчика изменить значение переменной в контексте вызова события
        • &getRef()
          Получить ссылку на значение из контекста вызова события
        • call()
          Запустить событие
    • Выборки
      • umiSelection (deprecated)
        • setElementsFilter()
          Данный метод устарел
        • addObjectType()
          Добавляет тип объекта к критерию фильтрации
        • addElementType()
          Добавляет тип элемента к критерию фильтрации
        • addLimit()
          Устанавливает количественные ограничения на выборку
        • addActiveFilter()
          Устанавливает признак активности элемента
        • addObjectsFilter()
          Устанавливает возможные id объектов
        • addElementsFilter()
          Устанавливает возможные id элементов иерархии
        • setOrderByProperty()
          Устанавливает поле и вид сортировки
        • setOrderByOrd()
          Устанавливает сортировку по расположению в иерархии
        • setOrderByRand()
          Устанавливает выборку случайных ID
        • setOrderByName()
          Устанавливает сортировку по имени
        • setOrderByObjectId()
          Устанавливает сортировку по id объекта
        • addHierarchyFilter()
          Устанавливает параметры выбора элементов иерархии
        • addPropertyFilterBetween()
          Устанавливает проверку попадания значения поля в интервал
        • addPropertyFilterEqual()
          Устанавливает проверку значения поля на равенство
        • addPropertyFilterNotEqual()
          Устанавливает проверку значения поля на неравенство
        • addPropertyFilterLike()
          Устанавливает проверку значения поля на включение поисковой строки
        • addPropertyFilterMore()
          Устанавливает проверку значения поля на "больше"
        • addPropertyFilterLess()
          Устанавливает проверку значения поля на "меньше"
        • addPropertyFilterIsNull()
          Устанавливает проверку значения поля на отсутствие значения
        • addPropertyFilterIsNotNull()
          Устанавливает проверку значения поля на отсутствие значения
        • addPermissions()
          Устанавливает пользователя или группу для проверки прав на элемент
        • setPermissionsLevel()
          Устанавливает уровень прав, который должен быть у искомых страниц
        • addNameFilterEquals()
          Устанавливает значение для проверки имени поля на равенство
        • addNameFilterLike()
          Устанавливает значение для поиска в имени
        • getOrderConds()
          Возвращает параметры сортировки
        • getLimitConds()
          Возвращает количественные ограничения на выборку
        • getActiveConds()
          Возвращает признак активности
        • getOwnerConds()
          Возвращает список возможных владельцев
        • getObjectsConds()
          Возвращает список возможных id объектов
        • getElementsConds()
          Возвращает список возможных id элементов иерархии
        • getPropertyConds()
          Возвращает список условий на выборку по значению полей
        • getObjectTypeConds()
          Возвращает список возможных id типов объектов
        • getElementTypeConds()
          Возвращает список возможных id типов элементов иерархии
        • getNameConds()
          Возвращает условия проверки имени
        • getConditionModeOr()
          Возвращает значение флага группировки результатов выборки по значению полей
        • setIsDomainIgnored()
          Устанавливает значение флага игнорирования текущего домена
        • setIsLangIgnored()
          Устанавливает значение флага игнорирования текущей языковой версии
        • getIsDomainIgnored()
          Возвращает значение флага игнорирования текущего домена
        • getIsLangIgnored()
          Возвращает значение флага игнорирования текущей языковой версии
        • setDomainId()
          Искать только по указанному домену
        • setLangId()
          Искать только в указанной языковой версии
        • searchText()
          Поиск по строке в любом текстовом поле
      • umiSelectionsParser (deprecated)
        • runSelection()
          Возвращает Array id элементов иерархии или объектов
        • parseSelection()
          Возвращает Array ID объектов (umiObject) или элементов иерархии (umiHierarchyElement)
      • Selector
    • Утилитарные классы
      • umiCaptcha
        • generateCaptcha()
          Генерирует код вызова CAPTCHA. В зависимости от текущего шаблонизатора возвращает Array/String в качестве результата обработки.
        • isNeedCaptha()
          Проверяет необходимость ввода CAPTCHA. Возвращает boolean: true, если CAPTCHA обязательна; false, если CAPTCHA отключена или пользователь уже авторизован.
        • checkCaptcha()
          Проверяет валидность выбранной на сайте CAPTCHA. Возвращает boolean: true, если CAPTCHA верная; false, если CAPTCHA не верная.
      • umiBasket
        • getUserBasket()
          Возвращает объект, представляющий собой заказ со статусом "в корзине". Если объект не существует, создает его, связывает с текущим пользователем и возвращает
        • getCurrencyFullInfo()
          Возвращает id объекта "Статус заказа" по его строковому идентификатору (id_name)
        • recalcBasket()
          Пересчитывает цены в корзине заказов и возвращает общую сумму заказа
        • changeBasketItem()
          Изменяет информацию о товаре в корзине. После изменения информации о товаре, пересчитывает все цены в корзине
        • getBasketItemCount()
          Получить количество товара в корзине
        • getBasketItem()
          Получить информацию о товаре в корзине по идентификатору товара (umiHierarchyElement)
        • addItemToUserBasket()
          Добавляет объект "наименование в заказе" в корзину. Служит для добавления любых, не связанных с реальным товаром позиций. Работает только для авторизованных пользователей
        • addToBasket()
          Добавляет товар в корзину. После добавления пересчитываются все цены в корзине
        • removeFromBasket()
          Удалить товар из корзины. После удаления пересчитываются все цены в корзине
        • renderBasket()
          Возвращает информацию о корзине, используя шаблон. После удаления пересчитываются все цены в корзине
        • renderCurrencyChooser()
          Возвращает контрол выбора валюты
        • render4JSON()
          Возвращает информацию о корзине в виде JavaScript кода (используется для json'a)
        • render4Mail()
          Возвращает информацию о корзине для формирования письма о заказе, используя шаблон
        • renderUserOrders()
          Возвращает информацию обо всех заказах пользователя (история заказов), используя шаблон
        • renderOrderInfo()
          Возвращает информацию об определенном заказе пользователя, используя шаблон
        • checkIsEmpty()
          Проверяет пуста ли корзина
        • order()
          Оформляет заказ. После оформления заказа объект заново инициализируется, создается новый заказ со статусом "в корзине"
        • recalcCurrency()
          Пересчитать цену $basePriceValue из базовой валюты в $toCurrencyCode
        • getInstance()
          Возвращает umiBasket экземпляр класса umiBasket
        • getStatusBySId()
          Возвращает integer id объекта (umiObject), либо false, если статуса с таким id_name не существует
      • translit
        • convert()
          Возвращает String транслитерированная строка
      • umiSubscriber
        • __construct()
          Получить подписчика по id объекта
        • isRegistredUser()
          Узнать, является ли подписчик зарегистрированным пользователем
        • getDispatches()
          Получить список рассылок, на которые подписан подписчик
        • getSubscriberByUserId()
          Возвращает umiSubscriber объект подписчика
      • umiDate
      • umiDirectory
        • __construct()
          Конструктор
        • getPath()
          Возвращает путь к директории
        • getName()
          Возвращает имя директории
        • getIsBroken()
          Проверяет существует ли директория
        • getFSObjects()
          Читает директорию и возвращает массив объектов файловой системы
        • getFiles()
          Читает директорию и возвращает массив файлов в директории
        • getDirectories()
          Читает директорию и возвращает массив поддиректорий
        • delete()
          Удалить директорию
        • __toString()
          Убедиться, что директория $folder существует, если нет, то создать ее
        • requireFolder()
          Возвращает boolean true, если директория существует, либо успешно создана
        • isReadable()
          Проверяет доступна ли директория на чтение
        • deleteEmptyDirectory()
          Удаляет пустую директорию
      • umiFile
        • __construct()
          Конструктор
        • delete()
          Удалить файл из файловой системы
        • download()
          Послать HTTP заголовки для того, чтобы браузер начал скачивать файл
        • getFileName()
          Получить название файла
        • getDirName()
          Получить адрес директории, в которой лежит файл
        • getModifyTime()
          Получить время последней модификации файла
        • getExt()
          Получить расширение файла
        • getSize()
          Получить размер файла
        • getFilePath()
          Получить путь до файла в файловой системе
        • getIsBroken()
          Узнать, все ли в порядке с файлом, на который ссылается объект umiFile
        • getUnconflictPath()
          Возвращает boolean true, если нет ошибок
        • getDownloadMode()
          Возвращает режим скачивания файла
      • umiImageFile
        • __construct()
          Конструктор, принимает в качестве аргумента путь до файла в локальной файловой системе.
        • getWidth()
          Возвращает значение ширины изображения
        • getSupportedImageTypes()
          Возвращает Array массив, состоящий из допустимых расширений файлов изображений
        • setWatermarkOn()
          Указывает на необходимость добавления водного знака к следующей загружаемой картинке
        • setWatermarkOff()
          Отключает водный знак
        • upload()
          Возвращает путь до загруженного файла в случае успеха
        • getIsImage()
          Проверить, является ли файл допустимым изображением
        • getOrder()
          Возвращает порядок вывода
        • setOrder()
          Возвращает порядок вывода
        • getId()
          Возвращает идентификатор изображения
        • setId()
          Устанавливает идентификатор изображения
        • getAlt()
          Возвращает альтернативный текст для отображения
        • setAlt()
          Устанавливает альтернативный текст для отображения
        • imageOptim()
          Оптимизирует размер изображения
      • umiMail
        • __construct()
          Публичный конструктор
        • addRecipient()
          Добавляет получателя в общий список
        • setFrom()
          Устанавливает отправителя
        • setSubject()
          Устанавливает тему письма
        • setContent()
          Устанавливает текст письма, заменяя макросы значениями
        • setTxtContent()
          Устанавливает текст письма, не производя никакую обработку
        • setPriorityLevel()
          Устанавливает приоритет письма
        • setImportanceLevel()
          Устанавливает уровень важности. Зарезервировано, не используется
        • commit()
          Выставляет флаг, что письмо обработано
        • getHeaders()
          Устанавливает заголовки письма
        • send()
          Выполняет отправку сформированного письма
        • attachFile()
          Прикрепляет файл к письму
        • __destruct()
          Деструктор
        • clearFilesCache()
          Очищает список прикрепленных файлов
        • checkEmail()
          Возвращает boolean true - валидный, false - не валидный
    • Разное
      • umiEntinty
      • singleton
        • __clone()
          Запрещаем копирование
        • getInstance()
          Возвращает singleton экземпляр класса
      • umiRemoteFileGetter
        • get()
          Возвращает string|umiFile
      • xmlExporter
        • __construct()
          Конструктор
        • addBranches()
          Добавить к экспортируемым данным список ветвей структуры
        • addDataTypes()
          Добавить к экспортируемым данным типы полей
        • addDirs()
          Добавить к экспортируемым данным список директорий
        • addDomains()
          Добавить к экспортируемым данным список доменов
        • addElements()
          Добавить к экспортируемым данным список страниц
        • addFiles()
          Добавить к экспортируемым данным файлы
        • addLangs()
          Добавить к экспортируемым данным список языков
        • addObjects()
          Добавить к экспортируемым данным объекты
        • addRestrictions()
          Добавить к экспортируемым данным ограничения на значения полей
        • addTemplates()
          Добавить к экспортируемым данным шаблоны дизайна
        • addTypes()
          Добавить к экспортируемым данным типы
        • execute()
          Выполнить экспорт
        • getExportLog()
          Получить массив сообщений работы xmlExporter'a
        • isCompleted()
          Возвращает результат того, были ли экспортированы все данные, добавленные в экспорт
        • setDestination
          Устанавливает путь к директории, куда будут экспортированы файлы. Директория destination должна уже существовать. Если ее нет, то файлы не будут скопированы в папку экспорта
        • setIgnoreRelations()
          устанавливает игнорирование дополнительных данных (позволяет облегчить umiDump)
        • setShowAllFields()
          Позволяет экпортировать системные поля и невидимые группы
        • excludeBranches()
          Исключить из экспортируемых данных список ветвей структуры
      • xmlImporter
        • __construct()
          Конструктор
        • execute()
          Выполнить импорт
        • getImportLog()
          Получить массив сообщений работы xmlImporter'a
        • loadXmlDocument()
          Установить DOMDocument, откуда берутся данные для импорта (в формате umiDump 2.0)
        • loadXmlFile()
          Загрузить данные для импорта из файла
        • loadXmlString()
          Загрузить данные из строки в формате XML
        • setAutoGuideCreation()
          Установить режим автоматического создания справочников для полей типа «выпадающий список», «выпадающий список с множественным выбором» и «составное»
        • setDemositeMode()
          Установить режим импорта как режим установки демо-сайта, то есть импортируются только страницы и объекты, относящиеся к модулям, присутствующим в системе
        • setDestinationElement()
          Установить родительский элемент по умолчанию
        • setFilesSource()
          Установить пусть к директории, откуда могут быть скопированы импортируемые файлы
        • setIgnoreParentGroups()
          Установить режим, при котором вновь создаваемые типы наследуют группы полей родительского типа
        • setRenameFiles()
          Установить режим создания новых имен импортируемых файлов, относящихся к страницам и объектам
        • setUpdateIgnoreMode()
          Установить режим необновления ранее созданных сущностей
      • regedit
        • getInstance()
          Возвращает экземпляр класса regedit
        • getKey()
          Получить ключ по его адресу
        • getVal()
          Получить значение ключа по его адресу
        • setVal()
          Установить значение для ключа по переданному адресу
        • delVar()
          Удалить ключ и вложения
        • getList()
          Получить массив ключей, дочерних указанному
    • База данных

getInstance()

Название

getInstance() — Возвращает экземпляр класса umiTypesHelper

Параметры: static getInstance()

Была ли данная статья полезна?

© UMI.CMS 2024