Разработка:modlibs/templater
| Плагин | |
| Название | templater |
| Тип | modlibs |
Принципы работы
Плагин templater отвечает за все действия по экспорту данных и за создание любых электронных документов (отчетов, приказов, графиков и т. п.)
Общие сведения
Все документы формируются следующим образом: на основе требуемого документа создается файл шаблона документа;
- собираются данные для вставки в шаблон
- формируется экспортируемый документ - производится вставка данных в шаблон;
- сформированный документ посылается клиенту по http-протоколу.
Шаблон документа формируется из документа по специальным правилам, а затем размещается в оговоренном месте плагина, из которого производится экспорт. Затем по аналогичным правилам производится вставка данных. Сбор и подготовка данных для экспорта производятся тем же плагином. В настоящее время формирование шаблона производится в ручную. Описываемый модуль получает путь к каталогу документа, данные для вставки и формат документа. На основе этих данных он формирует документ и посылает его клиенту.
Формат исходных данных
Данные, предназначенные для экспорта должны соответствовать следующим стандартам:
- Исходные данные всегда представлены в виде объекта класса stdClass (стандартный объект PHP).
- Поля объекта могут содержать строки, числа и массивы объектов (массивы строк или чисел не допускаются). Данные других типов не обрабатываются.
Строки и числа подставляются в шаблон документа "как есть", объекты обрабатываются как блоки. Объект данных для экспорта может иметь неограниченное количество вложенных блоков. Желательно для создания объекта данных для экспорта создавать отдельный класс, которые решает эту задачу.
Пример исходных данных
В этом примере мы построим объект для экспорта оценок учеников двух классов. У каждого класса есть название, предмет, и дата, за которую выставлялись оценки. В каждом классе есть несколько учеников, которые эти оценки получили.
Данные для экспорта будут выглядеть следующим образом:
stdClass Object
(
[classes] => Array
[0] => stdClass Object
[name] => 3 "б"
[date] => 21.01.09
[subject] => Математика
[students] => Array
[0] => stdClass Object
[number] => 1
[fio] => Замеладский Алексей
[grade] => 5
[1] => stdClass Object
[number] => 2
[fio] => Гусева Татьяна
[grade] => 4
[1] => stdClass Object
[name] => 5 "б"
[date] => 21.01.09
[subject] => Русский язык
[students] => Array
[0] => stdClass Object
[number] => 1
[fio] => Коньков Сергей
[grade] => 5
[1] => stdClass Object
[number] => 2
[fio] => Захаров Александр
[grade] => 3
)
В этом примере поля объектов представляют собой данные, которые нужно распечатать, о объекты служат для упаковки этих данных, и разделения их на блоки.
Тип документа
Каждый экспортируемый документ должен относиться к какому-либо типу. Тип документа зависти от его назначения (оценки за четверть, приказ о переводе в следующий класс, и т. д.). Внутри типа документа всегда содержатся экспортируемые данные. Каждый документ определенного типа можно экспортировать в несколько разных форматов.
Форматы экспорта
Каждый формат экспорта по-своему обрабатывает данные, указанные в типе документа. Тем не менее, какой бы формат экспорта не был выбран (например csv, odf, pdf), данные всегда используются одни и те же.
Использование
В этом разделе будет описано, как использовать плагин templater, будут приведены примеры кода.
Подготовка к экспорту
Для начала надо убедиться, что на месте вспомогательные средства. Т.е. установлен описываемый плагин templater, и плагин обеспечивающий превращения шаблона документа в документ - pear. Поэтому убедитесь, что у вас
- установлен плагин pear. Убедитесь, что на странице списка установленных плагинов, напротив модуля pear написано "Удалить, а не " "Установить".
- в нем есть библиотека HTML_Template_Sigma. Проверьте наличие файла .../modlibs/pear/libs/HTML_Template_Sigma/Sigma.php.
- установлен описываемый модуль - templater. Проверьте так же как и pear.
Использование готового документа
Самый простой способ экспортировать данные. Для этого нужно собрать данные, и указать какой документ в какой формат вы желаете экспортировать.
