Класс fcf.NRender.TaskInfo
Объект с информацией о сборке шаблона. Передается в хуки шаблона.
Описание класса
Свойства
object args - Объект с обработанными аргументами шаблона.
object fullSrcArgs - Объект с исходными данными аргументов всех аргументов
object page - Объект описания страницы. Может быть изменен логикой шаблона.
fcf.RouteInfo route - Маршрут соответствующий странице на которой выполняется рендеринг. Значения fcf.getContext().route и свойство могут отличаться.
object srcArgs - Объект с исходными данными аргументов шаблона ожидающих обработки
string template - Путь к шаблону для которого выполняется рендеринг
Методы
Promise setArg(string a_name, mixed a_value) - Устанавливает значение аргумента шаблона. Используется при перезаписи значения или создание не объявленного аргумента шаблона в хуках. В качестве значения может выступать описание аргумента.
Свойства
args
Тип: object
Объект с обработанными аргументами шаблона.
fullSrcArgs
Тип: object
Объект с исходными данными аргументов всех аргументов
page
Тип: object
Объект описания страницы. Может быть изменен логикой шаблона.
Структура объекта:
object header - Информация о заголовке страницы
string title - Заголовок страницы
string description - Описание страницы
array keywords - Массив ключевых слов страницы
array header - Массив строк добавляемых в заголовок страницы
array include - Массив подключаемый JS и CSS файлов к странице
route
Тип: fcf.RouteInfo
Маршрут соответствующий странице на которой выполняется рендеринг. Значения fcf.getContext().route и свойство могут отличаться.
srcArgs
Тип: object
Объект с исходными данными аргументов шаблона ожидающих обработки
template
Тип: string
Путь к шаблону для которого выполняется рендеринг
Методы
fcf.Action->mixed buildArg(mixed a_srcArg)
Выполняет сборку аргумента шаблона на основании исходных данных.
Аргументы:
mixed a_srcArg - Описание аргумента шаблона, может выступать значением или результатом одной из функций fcf.arg*
Возвращаемое значение:
fcf.Action->mixed
fcf.Actions->string render(string a_template, object a_args)
Выполняет рендеринг шаблона
Аргументы:
string a_template - Путь к шаблону
object a_args - Объект содержащий аргументы шаблона
Возвращаемое значение:
fcf.Actions->string
Возвращает объект fcf.Actions, возвращающий строку - результат рендеринга.
Promise setArg(string a_name, mixed a_value)
Устанавливает значение аргумента шаблона. Используется при перезаписи значения или создание не объявленного аргумента шаблона в хуках. В качестве значения может выступать описание аргумента.
Аргументы:
string a_name - Имя аргумента
mixed a_value - Значение аргумента шаблона.
Возвращаемое значение:
Promise
Promise setValue(string a_name, string a_value)
Устанавливает значение аргумента шаблона. Если аргумент является ссылкой, то значение устанавливается и для элементов, на которые ссылается аргумеент.
Аргументы:
string a_name - Имя аргумента
string a_value - Устанавливаемое значение
Возвращаемое значение:
Promise