Разработка:modlibs/templater

Материал из DOF
Версия от 15:17, 22 мая 2009; Ilya (обсуждение | вклад) (Заготовка для примера исходных данных)
Перейти к: навигация, поиск
Плагин
Название templater
Тип modlibs


Общие сведения

Плагин templater отвечает за все действия по экспорту данных и за создание любых электронных документов (отчетов, приказов, графиков и т. п.)

Принцип работы

Все документы формируются следующим образом: на основе требуемого документа создается файл шаблона документа;

  • собираются данные для вставки в шаблон
  • формируется экспортируемый документ - производится вставка данных в шаблон;
  • сформированный документ посылается клиенту по http-протоколу.

Шаблон документа формируется из документа по специальным правилам, а затем размещается в оговоренном месте плагина, из которого производится экспорт. Затем по аналогичным правилам производится вставка данных. Сбор и подготовка данных для экспорта производятся тем же плагином. В настоящее время формирование шаблона производится в ручную. Описываемый модуль получает путь к каталогу документа, данные для вставки и формат документа. На основе этих данных он формирует документ и посылает его клиенту.

Формат исходных данных

Данные, предназначенные для экспорта должны соответствовать следующим стандартам:

  • Исходные данные всегда представлены в виде объекта класса stdClass (стандартный объект PHP).
  • Поля объекта могут содержать строки, числа и массивы объектов (массивы строк или чисел не допускаются). Данные других типов не обрабатываются.

Строки и числа подставляются в шаблон документа "как есть", объекты обрабатываются как блоки. Объект данных для экспорта может иметь неограниченное количество вложенных блоков. Желательно для создания объекта данных для экспорта создавать отдельный класс, которые решает эту задачу.

Пример исходных данных

В этом примере мы построим объект для экспорта данных по ученикам двух классов. Данные для экспорта будут выглядеть следующим образом:

Тип документа

Форматы экспорта

Использование готового документа

Создание типа документа

Простое

Возможности по настройке поведения

Создание формата

API плагина

Форматы экспорта

ODF

Ссылки