Документация для разработчиков

Template

Template - класс для сопоставления плейсхолдеров из файла (\Bitrix\DocumentGenerator\Body) и того, каким образом нужно получить значения этих плейсхолдеров. Правила получения данных состоят из (в порядке повышения приоритета) настроек полей по умолчанию, настроек плейсхолдеров по умолчанию (не используется), настроек плейсхолдеров для текущего шаблона (не используется).

Методы класса

МетодОписание
loadById($id)Метод загружает шаблон из базы данных по его ид $id.
getBody()Метод возвращает экземпляр \Bitrix\DocumentGenerator\Body.
getFields()Метод возвращает массив, где ключ - плейсхолдер, а значение - массив с описанием способа получения данных.
getFileName($prefix = '')Метод возвращает имя файла шаблона (при скачивании). $prefix припишется к названию, если заполнено.
getDataProviders($combineExtended = false)Метод вернет список провайдеров, которые привязаны к этому шаблону.
getUsers()Метод вернет список кодов доступа, привязанных к этому шаблону.
setSourceType($sourceType)Метод устанавливает используемый тип провайдера для этого шаблона. Сюда надо передать полное имя класса. Метод обязательно надо вызывать перед созданием \Bitrix\DocumentGenerator\Document. В методе идёт проверка соответствия провайдера и модуля шаблона. В случае ошибки - он не будет установлен.
getSourceType()Метод вернет установленный тип провайдера.
getDownloadUrl($absolute = false)Метод вернет ссылку на скачивание файла шаблона.
isDeleted()Метод вернет true, если шаблон помечен как удалённый.


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2019, «1С-Битрикс», 2019
Наверх