Разработка:modlibs/templater — различия между версиями

Материал из DOF
Перейти к: навигация, поиск
м (API плагина)
(Дополнительные методы Sigma)
 
(не показано 79 промежуточных версий 3 участников)
Строка 5: Строка 5:
  
 
== Принципы работы ==
 
== Принципы работы ==
Плагин templater отвечает за все действия по экспорту данных и за создание любых электронных документов (отчетов, приказов, графиков и т. п.)  
+
Плагин templater обеспечивает все действия по экспорту данных и создание любых электронных документов (отчетов, приказов, графиков и т. п.)  
 
=== Общие сведения ===
 
=== Общие сведения ===
 
Все документы формируются следующим образом:
 
Все документы формируются следующим образом:
на основе требуемого документа создается файл шаблона документа;
+
* на основе требуемого документа создается файл шаблона документа;
 
* собираются данные для вставки в шаблон
 
* собираются данные для вставки в шаблон
 
* формируется экспортируемый документ - производится вставка данных в шаблон;
 
* формируется экспортируемый документ - производится вставка данных в шаблон;
 
* сформированный документ посылается клиенту по  http-протоколу.
 
* сформированный документ посылается клиенту по  http-протоколу.
Шаблон документа формируется из документа по специальным правилам, а затем размещается в оговоренном месте плагина, из которого производится экспорт. Затем по аналогичным правилам производится вставка данных. Сбор и подготовка данных для экспорта производятся тем же плагином. В настоящее время формирование шаблона производится в ручную.  Описываемый модуль получает путь к каталогу документа, данные для вставки и формат документа. На основе этих данных он формирует документ и посылает его клиенту.
+
Шаблон документа формируется из документа по специальным правилам, а затем размещается в оговоренном месте плагина, из которого производится экспорт. Затем по аналогичным правилам производится вставка данных. Сбор и подготовка данных для экспорта производятся тем же плагином. В настоящее время формирование шаблона производится вручную.  Описываемый модуль получает путь к каталогу документа, данные для вставки и формат документа. На основе этих данных он формирует документ и посылает его клиенту.
 +
 
 
=== Формат исходных данных ===
 
=== Формат исходных данных ===
 
Данные, предназначенные для экспорта должны соответствовать следующим стандартам:
 
Данные, предназначенные для экспорта должны соответствовать следующим стандартам:
 
* Исходные данные всегда представлены в виде объекта класса stdClass (стандартный объект PHP).
 
* Исходные данные всегда представлены в виде объекта класса stdClass (стандартный объект PHP).
 
* Поля объекта могут содержать строки, числа и массивы объектов (массивы строк или чисел не допускаются). Данные других типов не обрабатываются.
 
* Поля объекта могут содержать строки, числа и массивы объектов (массивы строк или чисел не допускаются). Данные других типов не обрабатываются.
Строки и числа подставляются в шаблон документа "как есть", объекты обрабатываются как блоки. Объект данных для экспорта может иметь неограниченное количество вложенных блоков.
+
* Строки и числа подставляются в шаблон документа "как есть".  
Желательно для создания объекта данных для экспорта создавать отдельный класс, которые решает эту задачу.
+
* Данные для экспорта представляются в виде структурированного объекта (класс object()), в котором одиночные поля представляются скалярами, записи - объектами, а таблицы - массивами объектов.  
 +
Желательно для создания объекта данных для экспорта создавать отдельный класс, который решает эту задачу.
 +
 
 
=== Пример исходных данных ===
 
=== Пример исходных данных ===
В этом примере мы построим объект для экспорта оценок учеников двух классов. У каждого класса есть название, предмет, и дата, за которую выставлялись оценки. В каждом классе есть несколько учеников, которые эти оценки получили.
+
В этом примере мы построим объект для экспорта оценок учеников двух классов. У каждого класса есть название, предмет, и дата, за которую выставлялись оценки. В каждом классе есть несколько учеников, которые эти оценки получили. Таким образом, если мы хотим получить такую таблицу:
 +
    {|border="1"
 +
      |№
 +
      |ФИО ученика
 +
      |оценка
 +
      |-
 +
      |colspan="3" |З<sup>б</sup> класс, Математика, 21.01.09
 +
      |-
 +
      |1
 +
      |Замеладский Алексей
 +
      |5
 +
      |-
 +
      |2
 +
      |Гусева Татьяна
 +
      |4
 +
      |-
 +
      |colspan="3" |5<sup>б</sup> класс, Русский язык, 27.01.09
 +
      |-
 +
      |1
 +
      |Коньков Сергей
 +
      |5
 +
      |-
 +
      |2
 +
      |Захаров Александр
 +
      |3
 +
      |}
 +
 
 
Данные для экспорта будут выглядеть следующим образом:
 
Данные для экспорта будут выглядеть следующим образом:
 
<code php>
 
<code php>
Строка 58: Строка 87:
 
     )
 
     )
 
</code php>
 
</code php>
В этом примере поля объектов представляют собой данные, которые нужно распечатать, о объекты служат для упаковки этих данных, и разделения их на блоки.
+
=== Реализация экспорта ===
 
 
=== Тип документа ===
 
Каждый экспортируемый документ должен относиться к какому-либо типу. Тип документа зависти от его назначения (оценки за четверть, приказ о переводе в следующий класс, и т. д.). Внутри типа документа всегда  содержатся экспортируемые данные. Каждый документ определенного типа можно экспортировать в несколько разных форматов.
 
=== Форматы экспорта ===
 
Каждый формат экспорта по-своему обрабатывает данные, указанные в типе документа. Тем не менее, какой бы формат экспорта не был выбран (например csv, odf, pdf), данные всегда используются одни и те же.
 
== Использование ==
 
В этом разделе будет описано, как использовать плагин templater, будут приведены примеры кода.
 
 
==== Подготовка к экспорту ====
 
==== Подготовка к экспорту ====
 
Для начала надо убедиться, что на месте вспомогательные средства. Т.е. установлен описываемый плагин '''templater''', и плагин обеспечивающий превращения шаблона документа в документ - '''pear'''. Поэтому убедитесь, что у вас
 
Для начала надо убедиться, что на месте вспомогательные средства. Т.е. установлен описываемый плагин '''templater''', и плагин обеспечивающий превращения шаблона документа в документ - '''pear'''. Поэтому убедитесь, что у вас
* установлен плагин '''pear'''. Убедитесь, что на странице списка установленных плагинов, напротив модуля pear написано "Удалить, а не " "Установить".
+
* установлен плагин '''pear'''. Удостоверьтесь, что на странице списка установленных плагинов, напротив модуля pear написано "Удалить, а не " "Установить".
 
* в нем есть библиотека '''HTML_Template_Sigma'''. Проверьте наличие файла '''.../modlibs/pear/libs/HTML_Template_Sigma/Sigma.php'''.
 
* в нем есть библиотека '''HTML_Template_Sigma'''. Проверьте наличие файла '''.../modlibs/pear/libs/HTML_Template_Sigma/Sigma.php'''.
 
* установлен описываемый модуль - '''templater'''. Проверьте так же как и '''pear'''.
 
* установлен описываемый модуль - '''templater'''. Проверьте так же как и '''pear'''.
=== Использование готового документа ===
+
Теперь надо подготовить плагин. В нем надо создать структуру папок. Для реализации экспорта надо создать в корневой папке плагина директорию '''templater'''. В ней нужно создать каталоги для каждого документа, который вы собираетесь экспортировать. В каждой из них нужно создать папки, названия которых - это типы файлов, в которые вы собираетесь экспортировать каждый документ. Внутри этих папок должны лежать файлы шаблонов для экспорта.
Самый простой способ экспортировать данные. Использование этого способа предполагает, что кто-то уже создал шаблон документа для экспорта, определил его тип и разметил его соответствующим образом.  
+
Например, у нас есть плагин '''reports''', типа '''im'''. Из него планируется экспортировать отчеты: список оценок - '''grades_list''', список учеников - '''students_list''', список учителей - '''teachers_list'''. Список оценок будет экспортироваться в форматы odf, csv, html. Список учителей в форматы odf и html. Список студентов в csv и html. Тогда надо создать такую структуру папок:
Вам остается сделать всего 2 действия:
+
    .../im/reports/templater/grades_list/odf
* собрать данные
+
    .../im/reports/templater/grades_list/csv
* указать какой документ в какой формат вы желаете экспортировать.
+
    .../im/reports/templater/grades_list/html
 +
    .../im/reports/templater/students_list/csv
 +
    .../im/reports/templater/students_list/html
 +
    .../im/reports/templater/teachers_list/odf
 +
    .../im/reports/templater/teachers_list/html
  
==== Сбор данных ====
+
Внутри этих папок следует разместить шаблоны документов для экспорта.
Данные извлекаются из базы данных, или из форм, а затем преобразуются в нужный для экспорта формат.
 
О том, какой формат должны иметь данные для экспорта описано в разделе [[Разработка:modlibs/templater#Формат исходных данных|Формат исходных данных]]. Рекомендуется выделять для сбора и упаковки данных отдельный класс, особенно если процесс сбора данных достаточно сложен.
 
==== Указание формата и типа документа ====
 
После того, как были собраны все необходимые данные можно приступать непосредственно к процессу экспорта. Нужно сначала получить объект для для экспорта, затем передать ему данные, и получить готовый файл.
 
  
''' Пример '''  
+
Правила подготовки шаблона описаны в разделе [[Разработка:modlibs/templater#Подготовка шаблона документа|Подготовка шаблона документа]].
* Обращаемся к плагину templater чтобы получить нужный объект.
+
 
     $export = $DOF->modlib('templater')->template('im', 'genedu', $data, 'gradeslist');
+
Теперь, когда шаблон есть, можно переходить к следующему этапу - сбору данных для экспорта. Объект экспорта должен соответствовать структуре объекта, описанной в разделах [[Разработка:modlibs/templater#Формат исходных данных|Формат исходных данных]] и [[Разработка:modlibs/templater#Пример исходных данных|Пример исходных данных]].
 +
 
 +
Теперь все необходимые приготовления выполнены и можно переходить непосредственно к экспорту.
 +
 
 +
==== Экспорт документа ====
 +
Собственно экспорт осуществляется в два этапа. Создание объекта экспорта и инициализация экспорта. Поясним оба этапа на примере. Предположим, мы хотим экспортировать ведомость оценок '''grades_list''' из плагина '''reports''' в формат '''odf'''. Тогда
 +
 
 +
* Получаем нужный объект:
 +
     $exporter = $DOF->modlib('templater')->template('im', 'reports', $dataforexport, 'grades_list');
 
Здесь:
 
Здесь:
  
 
''im'' - тип плагина,  
 
''im'' - тип плагина,  
  
''genedu'' - имя плагина,  
+
''reports'' - имя плагина,  
 
 
''gradeslist'' - директория, в которой лежит шаблон документа, который будет экспортирован.
 
 
 
''$export'' - объект, который будет производить все необходимые операции.
 
  
''$data'' - собранные на предыдущем этапе данные.
+
''grades_list'' - директория, в которой лежит шаблон документа, который будет экспортирован.
  
* Получив объект, обращаемся к нему выбираем формат, в который мы собираемся произвести экспорт.
+
''$exporter'' - объект, который будет производить все необходимые операции.
    $file = $export->get_file('odf');
 
В переменной $file будет содержаться файл нужного формата. Если вам нужно отправить файл немедленно вместе с заголовками, то воспользуйтесь методом send_file. Обратите внимание, что объект $export уже хранит в себе все необходимые данные. Если вы хотите еще раз экспортировать данные, но уже в другой формат - не нужно заново создавать объект, достаточно обратиться к нему еще раз.
 
  
=== Создание типа документа ===
+
''$dataforexport'' - собранные на предыдущем этапе данные.
В случае, когда нужно создать новый шаблон для документа требуются дополнительные операции. При работе над экспортом этот вариант будет использоваться наиболее часто.
 
==== Простое ====
 
В случае простого создания типа документа вам не потребуется писать какой-либо дополнительный код для обработки данных.
 
  
Для простого создания типа документа нужно:
+
* Получив объект, инициализируем отправку файла:
* Создать все необходимые файлы и папки
+
    $exporter->send_file('odf');
* Подготовить шаблон документа
+
    die;
* Собрать данные
+
Функция die здесь использована для того, чтобы больше ничего в файл экспорта не попало.  
* Указать какой документ в какой формат вы желаете экспортировать.
 
  
===== Создание файлов и папок =====
+
Обратите внимание, что объект $exporter уже хранит в себе все необходимые данные. Если вы хотите еще раз экспортировать данные, но уже в другой формат - не нужно заново создавать объект, достаточно обратиться к нему еще раз, например:
Надо в корневом каталоге плагина, из которого производится экспорт, создать папку с именем '''templater'''. В ней, для каждого из документов, которые предполагается экспортировать, надо создать папку с именем типа документа. В них надо создать директории, с названиями форматов экспорта.
+
    $exporter = $DOF->modlib('templater')->template('im', 'reports', $dataforexport, 'grades_list');   
Например, в плагине интерфейса exampleim планируется экспортировать документ с именем "тип_документа" в различные форматы. Тогда структура папок плагина должна быть такой:
+
    switch ($type)
     .../im/exampleim/templater/<тип_документа>/<имя_формата1>/
+
    {
     .../im/exampleim/templater/<тип_документа>/<имя_формата2>/
+
        case 'odf': $exporter->send_file('odf');break;
Здесь:
+
        case 'csv': $exporter->send_file('csv');break;
* тип_документа - имя типа документа
+
    }
* имя_формата - формат, в который нужно экспортировать файл
+
    die;
В свою очередь, внутри папки с именем формата должен лежать шаблон результирующего документа.
+
По умолчанию имя посылаемого файла формируется из собственно имени файла (которое по умолчанию равно '''export'''), и расширения, в качестве которого используется тип файла, указанный при инициализации экспорта. Но можно задать и другое имя. Для этого надо использовать второй необязательный параметр функции '''send_file''':
 +
     $options = new object;
 +
     $options->filename = 'new_export_file_name';
 +
    $exporter->send_file('odf', $options);
 +
Имя файла надо указывать без расширения.
  
===== Подготовка шаблона документа =====
+
=== Подготовка шаблона документа ===
В случае, если вам нужно создать новый документ, для которого еще не создан шаблон - этот шаблон нужно создать и разметить.  
+
Если вам нужно создать новый документ, то нужно создать и новый шаблон документа.  
Файл шаблона должен быть размечен тэгами шаблонизатора [http://pear.php.net/package/HTML_Template_Sigma  PEAR::HTMLTemlateSigma].
+
Файл шаблона должен быть размечен тегами шаблонизатора [http://pear.php.net/package/HTML_Template_Sigma  PEAR::HTMLTemlateSigma].
 
В нем оформляются места для вставки данных - поля и блоки.
 
В нем оформляются места для вставки данных - поля и блоки.
 
*Отдельное поле помечается фигурными скобками '''{}'''.  
 
*Отдельное поле помечается фигурными скобками '''{}'''.  
Строка 131: Строка 155:
 
*Если есть блок полей, то начало блока помечается тегом '''&lsaquo;!-- BEGIN block_name --&rsaquo;'''.  
 
*Если есть блок полей, то начало блока помечается тегом '''&lsaquo;!-- BEGIN block_name --&rsaquo;'''.  
 
*Окончание блока помечается тегом '''&lsaquo;!-- END block_name --&rsaquo;'''. Здесь block_name - имя блока, все остальное - обязательная служебная конструкция. Между этими тегами нужно размещать поля блока и другие блоки.
 
*Окончание блока помечается тегом '''&lsaquo;!-- END block_name --&rsaquo;'''. Здесь block_name - имя блока, все остальное - обязательная служебная конструкция. Между этими тегами нужно размещать поля блока и другие блоки.
Например надо получить такой файл:
+
Например надо таблицу ведомости оценок (см. [[Разработка:modlibs/templater#Пример исходных данных|Пример исходных данных]])
  
[[Изображение:sample1.jpg]].  
+
    {|border="1"
 +
      |№
 +
      |ФИО ученика
 +
      |оценка
 +
      |-
 +
      |colspan="3" |З<sup>б</sup> класс, Математика, 21.01.09
 +
      |-
 +
      |1
 +
      |Замеладский Алексей
 +
      |5
 +
      |-
 +
      |2
 +
      |Гусева Татьяна
 +
      |4
 +
      |-
 +
      |colspan="3" |5<sup>б</sup> класс, Русский язык, 27.01.09
 +
      |-
 +
      |1
 +
      |Коньков Сергей
 +
      |5
 +
      |-
 +
      |2
 +
      |Захаров Александр
 +
      |3
 +
      |}
  
Тогда поля и блоки надо вставлять в файл шаблона так:
+
получить в виде html-файла. Тогда в шаблоне документа надо вставить поля и блоки примерно так:
 +
    <html>
 +
    ....
 +
    &lsaquo;table&rsaquo;
 +
      &lsaquo;tr&rsaquo;
 +
          &lsaquo;td&rsaquo;№&lsaquo;/td&rsaquo;
 +
          &lsaquo;td&rsaquo;ФИО ученика&lsaquo;/td&rsaquo;
 +
          &lsaquo;td&rsaquo;Оценка&lsaquo;/td&rsaquo;
 +
      &lsaquo;/tr&rsaquo;
 +
      &lsaquo;!-- BEGIN classes --&rsaquo;
 +
      &lsaquo;tr&rsaquo;
 +
          &lsaquo;td&rsaquo;{name} класс, {subject}, {date}&lsaquo;/td&rsaquo;
 +
      &lsaquo;/tr&rsaquo;
 +
      &lsaquo;!-- BEGIN students --&rsaquo;
 +
      &lsaquo;tr&rsaquo;
 +
          &lsaquo;td&rsaquo;{number}&lsaquo;/td&rsaquo;
 +
          &lsaquo;td&rsaquo;{fio}&lsaquo;/td&rsaquo;
 +
          &lsaquo;td&rsaquo;&lsaquo;grade>&lsaquo;/td>
 +
      &lsaquo;/tr&rsaquo;
 +
      &lsaquo;!-- END students --&rsaquo;
 +
      &lsaquo;!-- END classes --&rsaquo;
 +
    &lsaquo;/table&rsaquo;
 +
    ....
 +
    &lsaquo;/html&rsaquo;
  
[[Изображение:sample2.jpg]].
+
Каждый файл шаблона должен иметь имя template.тип_файла экспорта. К примеру '''template.html'''. Из этого правила есть несколько исключений. В частности, odf-формат имеет сложную структуру, поэтому и его шаблон должен быть устроен соответственно. Структура папок шаблона odf-документа описана [[Разработка:modlibs/templater#ODF|тут]]. В ряде случаев шаблон документа вообще не нужен. Так например, формат dbg - это тестовый вариант вывода данных. В этом случае неформатированные данные экспорта выводятся на экран. Другой случай - экспорт в формат '''csv'''. Файл в этом формате представляет собой набор строк, в которых данные разделены запятыми. Для него шаблон также не нужен.
  
Изнутри файл, размеченный тегами Sigma будет выглядеть следующим образом:
+
=== Альтернативный способ формирования документа ===
     Отчет об индивидуальной успеваемости.
+
Можно изменить способ формирования документа в существующий формат. Для этого надо, в своем плагине, в папке с названием типа файла экспорта создать файл '''init.php'''. Т.е. если мы хотим изменить формирование списка оценок в файл '''html''', то должна получиться такая структура папок
     Ученик {name}.
+
     .../templater/reports/grades_list/html/init.php
    Предмет, Оценка
+
     .../templater/reports/grades_list/html/template.html
    &lsaquo;!-- BEGIN grades_table --&rsaquo;
+
Внутри этого файла, должен быть определен класс, который и создает документ из шаблона. Теперь, во время экспорта, формирование документа будет производить не встроенный в '''templater''' класс, а альтернативный.
    {course}, {grade}
 
    &lsaquo;!-- END grades_table --&rsaquo;
 
                        {autor}.
 
  
Таким образом, объект данных для экспорта приведенной выше таблицы должен выглядеть так:  
+
Если возникла необходимость экспортировать данные в файл, тип которого не поддерживает плагин '''templater''', можно самостоятельно реализовать и это. Для этого надо добавить папку ''тип_файла_экспорта'' в плагин '''templater''':
[[Изображение:sample3.jpg]]
+
    .../modlib/templater/formats/тип_файла_экспорта
 +
А внутрь нее положить файл '''init.php''', с аналогичным классом. Например, надо реализовать экспорт в excell. Тогда в плагине '''templater''' должен появиться файл '''init.php''' по такому адресу:
 +
    .../modlib/templater/formats/xls/init.php
  
===== Сбор данных =====
+
Общий принцип формирования имен классов:
Сбор данных при создании своего типа документа аналогичен [[Разработка:modlibs/templater#Сбор данных|сбору данных]] при использовании готового документа.
+
* Для создания нового формата ''dof_modlib_templater_format''_'''тип-файла-экспорта'''.
===== Указание формата и типа документа =====
+
* Для изменения логики работы существующего формата ''dof''_'''типплагина_имяплагина'''_''templater''_'''название-папки-документа'''_'''тип-файла-экспорта'''.
Указание формата и типа документа происходит [[Разработка:modlibs/templater#Указание формата и типа документа|так же]] как и при использовании готового документа.
+
Таким образом, для выше приведенных примеров имена классов будут такими:
==== Возможности по настройке поведения ====
+
* Новый класс экспорта в excell: '''dof_moblib_templater_format_xls'''.
В случае, когда недостаточно возможностей простой разметки и обработки документа - можно задать собственную логику поведения для любого формата или класса форматов. Например, если стандартная логика обработки odf-файлов вам не подходит, вы можете переопределить ее, и задать собственное поведение для обработки своих документов. Более подробно этот процесс описан в следующем разделе - "Создание формата".
+
* Альтернативный класс экспорта в '''html''': '''dof_im_reports_templater_grades_list_html'''.
 
 
=== Создание формата ===
 
Если есть необходимость произвести экспорт в формат, который пока еще не предусмотрен плагином templater - у вас есть возможность самостоятельно дополнить список форматов, в которые возможен экспорт. Также в этом разделе будет описана возможность переопределения поведения существующего формата.
 
 
 
Все созданные форматы должны соответствовать определенным требованиям:
 
* располагаться в специальной папке,
 
** внутри modlib\templater\formats\ если вы создаете новый формат
 
** или внутри <тип_плагина>\<имя_плагина>\templater\<тип_документа>\
 
* наследовать базовый класс ''dof_modlib_templater_format'' и реализовывать все его базовые методы.
 
 
 
==== Расположение файлов ====
 
''' Для создания нового формата '''
 
Структура папок:
 
* ''modlib'' - папка всех плагинов типа modlib
 
** ''templater'' - папка плагина templater
 
*** ''formats'' - папка в которой лежат все форматы
 
**** <имя_формата> - имя созданного вами формата. Всегда задается как стандартное расширение файла указанного формата.
 
**** '''init.php''' - файл в котором будет содержаться новый класс формата
 
**** ''template.<имя_формата>'' - файл шаблона документа.
 
 
 
''' Для изменения поведения существующего формата '''
 
* ''<тип_плагина>'' - тип плагина, в котором нужно переопределить класс экспорта, например ''im''
 
** ''<имя_плагина>'' - имя плагина, в котором нужно переопределить класс экспорта, например ''genedu''
 
*** ''templater'' - папка в которой хранятся все типы документов
 
**** ''<тип_документа>'' - папка с типом документа
 
***** ''<имя_формата>'' - формат, в который вы хотите сделать возможным экспорт. Всегда задается как стандартное расширение файла указанного формата (например pdf).
 
***** '''init.php''' - файл, в котором содержится переопределенный класс для формата.
 
***** ''template.<имя_формата>'' - файл шаблона документа. Более подробно о том, как должен называться файл шаблона - см. раздел "[[Разработка:modlibs/templater#Форматы экспорта|Форматы экспорта]]".
 
 
 
==== Создание класса ====
 
''' Стандарт именования классов'''
 
* Для создания нового формата ''dof_modlib_templater_format''_'''имяформата'''
 
* Для изменения логики работы существующего формата ''dof''_'''типплагина_имяплагина'''_''templater''_'''кодшаблона'''_'''имяформата'''
 
 
 
Для всех новых форматов экспорта в плагине templater существует абстрактный базовый класс  ''dof_modlib_templater_format''. Класс, который вы создаете должен наследоваться от него. В случае, если вы хотите изменить логику работы уже существующего формата, то класс можно наследовать непосредственно от него.
 
  
 +
В плагине '''templater''' существует абстрактный базовый класс  '''dof_modlib_templater_format'''. Каждый класс, который вы создаете, должен наследоваться от него.
 
При создании нового формата обязательно нужно реализовать следующие методы:
 
При создании нового формата обязательно нужно реализовать следующие методы:
 
* '''get_file'''($options) - получить файл в виде строки. Главная функция, производящая все преобразования над данными.
 
* '''get_file'''($options) - получить файл в виде строки. Главная функция, производящая все преобразования над данными.
 
* '''get_filename'''($options) - получить имя файла вместе с расширением одной строкой.
 
* '''get_filename'''($options) - получить имя файла вместе с расширением одной строкой.
 
* '''get_mimetype'''($options) - получить MIME-тип для подстановки его в HTTP-заголовок.
 
* '''get_mimetype'''($options) - получить MIME-тип для подстановки его в HTTP-заголовок.
Пример:
 
    header('Content-Type: '.'''$format->get_mimetype()'''.'charset=utf8');
 
  
Дальнейшее использование созданного вами формата аналогично использованию готового формата.
+
Дальнейшее использование созданного вами формата аналогично использованию готового формата. Более подробную информацию о методах и свойствах класса ''dof_modlib_templater_format'' можно найти в разделе [[Разработка:modlibs/templater#dof_modlib_templater_format|API]].
  
Более подробную информацию о методах и свойствах класса ''dof_modlib_templater_format'' можно найти в разделе [[Разработка:modlibs/templater#dof_modlib_templater_format|API]].
+
=== Альтернативный способ экспорта ===
 +
Если работа стандартного контейнера экспорта [[Разработка:modlibs/templater#dof_modlib_templater_package|dof_modlib_templater_package]] вас не устраивает, то вы можете создать свой. Для этого надо создать свой класс и реализовать в нем необходимые методы. Этот класс надо поместить в файл '''init.php''', а файл положить в папку того документа, для экспорта которого, вы этот контейнер создавали. Теперь при создании объекта экспорта будет создан не стандартный объект, а тот, который вы написали в файле. К примеру, вы хотите производить экспорт оценок через собственный контейнер. Тогда должна получиться такая структура папок:
 +
    .../im/reports/templater/grades_list/odf/
 +
    .../im/reports/templater/grades_list/csv/
 +
    .../im/reports/templater/grades_list/html/
 +
    .../im/reports/templater/grades_list/init.php
 +
Класс контейнера должен именоваться так: dof_тип-плагина_имя-плагина_templater_название-папки-документа. В нашем случае это '''dof_im_reports_templater_grades_list'''.
  
 
== API плагина ==
 
== API плагина ==
Строка 208: Строка 248:
 
=== Внешний ===
 
=== Внешний ===
 
====dof_modlib_templater:====
 
====dof_modlib_templater:====
*'''template'''($plugintype, $pluginname, $templatename, $data) — получить класс для экспорта в указанном плагине, с указанным названием. Возвращает объект класса dof_modlib_templater_package или dof_типплагина_имяплагина_templater_кодшаблона
+
*'''template'''($plugintype, $pluginname, $data, $templatename) — возвращает класс экспорта документа из указанного плагина. Возвращает объект класса dof_modlib_templater_package или dof_тип-плагина_имя-плагина_templater_имя-документа
** $plugintype - Тип плагина
+
** $plugintype - тип плагина
 
** $pluginname - имя плагина
 
** $pluginname - имя плагина
** $templatename - имя шаблона для экспорта
+
** $data - данные для экспорта, структурированные как указано [[Разработка:modlibs/templater#Формат исходных данных|выше]].
** $data - данные для экспорта
+
** $templatename - имя документа; здесь указывается имя папки, в которой лежат шаблоны для формирования документа в разных форматах. В рассмотренных выше примерах это '''grages_list''', '''teachers_list''' или '''students_list'''.
*'''template_path'''($plugintype, $pluginname, $templatename,$adds=null, $fromplugin) - путь к шаблону (корню или внутренней папке)
+
 
** $plugintype - тип плагина (im, storage, modlib и т. д.)
+
*'''template_path'''($plugintype, $pluginname, $templatename,$adds=null, $fromplugin) - возвращает путь внутри плагина.
 +
** $plugintype - тип плагина
 
** $pluginname - имя плагина  
 
** $pluginname - имя плагина  
** $templatename - имя шаблона форматирования
+
** $templatename - имя документа (см. предыдущую функцию)
** $adds - дополнительный путь после папки шаблона
+
** $adds - дополнительный путь внутри плагина
 
** $fromplugin - какой путь нужно вернуть: из внешнего плагина или из modlib/templater. Ее возможные значения:
 
** $fromplugin - какой путь нужно вернуть: из внешнего плагина или из modlib/templater. Ее возможные значения:
*** null (по умолчанию) - искать путь сначала во внешнем плагине, а затем в
+
*** null (по умолчанию) - искать путь сначала во внешнем плагине, а затем во внутреннем
 
*** true  - искать только во внешнем планине
 
*** true  - искать только во внешнем планине
 
*** false - искать только в modlib/templater
 
*** false - искать только в modlib/templater
Таблица, иллюстрирующая работу этой функции:
+
Таблица, описывающая работу этой функции:
 
{| border=1
 
{| border=1
 
  |'''№'''
 
  |'''№'''
Строка 276: Строка 317:
 
  |}
 
  |}
  
 
+
====dof_modlib_templater_package====
====dof_modlib_templater_package:====
 
 
*'''get_file'''($type, $options) - получить отформатированные данные, пригодные для обработки функцией file_put_contents().  
 
*'''get_file'''($type, $options) - получить отформатированные данные, пригодные для обработки функцией file_put_contents().  
**$type — в какой формат экспортировать,  
+
**$type — в какой формат экспортировать. Должно совпадать с названием папок в ...'''/modlibs/templater/formats/''' - '''dbg''' или '''csv''', или '''odf''' и др. А также с именем папки во внешнем плагине, в котором лежит шаблон экспорта в файлы такого типа.
 
**$options — дополнительные параметры.
 
**$options — дополнительные параметры.
 
*'''send_file'''($type, $options) — инициализировать передачу файла клиенту через браузер.
 
*'''send_file'''($type, $options) — инициализировать передачу файла клиенту через браузер.
 
**$type — в какой формат экспортировать,  
 
**$type — в какой формат экспортировать,  
 
**$options — дополнительные параметры.
 
**$options — дополнительные параметры.
*'''get_formats'''() - список доступных форматов для этого документа
+
*'''get_formats'''() - список доступных для указанного документа типов файлов экспорта.
 
*'''template_path'''($adds=null, $fromplugin) - путь к шаблону  (работает через класс dof_modlib_templater)
 
*'''template_path'''($adds=null, $fromplugin) - путь к шаблону  (работает через класс dof_modlib_templater)
 
**$adds - дополнительный путь, присоединяемый к возвращаемому функцией template_path в классе '''dof_modlib_templater''':
 
**$adds - дополнительный путь, присоединяемый к возвращаемому функцией template_path в классе '''dof_modlib_templater''':
Строка 325: Строка 365:
 
*** true  - искать только во внешнем планине
 
*** true  - искать только во внешнем планине
 
*** false - искать только в modlib/templater
 
*** false - искать только в modlib/templater
 +
 +
=== Дополнительные методы Sigma ===
 +
*'''date'''($fofmat,$value = null) - Форматирует системную дату/время. Равносилен стандартной функции РНР [http://ru2.php.net/manual/ru/function.strftime.php strftime].
 +
*'''mb_substr'''($value,$start = 0,$length = 1) - Получает часть строки. Равносилен стандартной функции РНР [http://ru2.php.net/manual/ru/function.mb-substr.php mb_substr]. Используемая кодировка 'utf-8'.
 +
*'''get_value'''($id,$field,$code) - Возвращает значение поля в записи с указанным id.
 +
**  $id - id записи в таблице
 +
**  $field - поле в таблице
 +
**  $code - имя плагина справочника
 +
*'''get_string'''($identifier, $pluginname = NULL, $a = NULL, $plugintype = 'im') - Возвращает строку перевода из файла локализации. Равносилен стандартному методу деканата '''get_string'''.
  
 
== Форматы экспорта ==
 
== Форматы экспорта ==
=== DBG ===
+
В этом разделе будут рассмотрены все поддерживаемые плагином templater форматы экспорта.
Название формата происходит от слова "debug". Это тестовый формат, можете поэкспериментировать с ним, для того чтобы наглядно ознакомиться с работой плагина templater. Результат экспорта в этот формат представляет собой обычный текстовый файл.
+
 
  
 
=== ODF ===
 
=== ODF ===
 
Open Document Format.
 
Open Document Format.
Этот формат используется документами OpenOffice. В этом формате можно создавать как обычные текстовые документы (odt), так и электронные таблицы (ods). Для подготовки документа нужно разметить его тегами шаблонизатора Sigma. Создание текстового документа и электронной таблицы происходит одинаково - разница только в расширении файла: odf - для текстового документа, и ods для электронной таблицы.
+
Этот формат используется документами [http://openoffice.ru OpenOffice]. В этом формате можно создавать как обычные текстовые документы (odt), так и электронные таблицы (ods). Для подготовки документа нужно разметить его тегами шаблонизатора [http://pear.php.net/package/HTML_Template_Sigma Sigma]. Создание текстового документа и электронной таблицы происходит одинаково - разница только в расширении файла: odt - для текстового документа, и ods для электронной таблицы.
 +
 
 +
Экспорт в формат odf реализуется стандартным образом. Отдельных слов, в силу особенностей структуры документа, заслуживает только подготовка шаблона.
 +
Все файлы формата odf представляют собой zip-архивы определенной структуры. У '''odt''' или '''ods''' документов собственно текст находится в файле '''content.xml''', который лежит в корне архива. Для того, чтобы правильно разметить документ - воспользуйтесь разделом [[Разработка:modlibs/templater#Подготовка шаблона документа|Подготовка шаблона документа]].
 +
 
 +
В плагине, из которого планируется реализовать экспорт в odf,  папке odf, должна лежать папка с именем '''content''', в которой должны лежать каталоги и файлы распакованные из этого архива. Собственно текст документа хранится в файле '''content.xml'''. Поэтому именно этот файл должен быть размечен как шаблон документа. Остальные файлы и папки можно оставить без изменения. В итоге мы должны увидеть что-то подобное:
 +
    .../im/reports/templater/grades_list/odf/content/Configurations2/
 +
    .../im/reports/templater/grades_list/odf/content/META-INF/
 +
    .../im/reports/templater/grades_list/odf/content/Thumbnails/
 +
    .../im/reports/templater/grades_list/odf/content/content.xml
 +
    .../im/reports/templater/grades_list/odf/content/meta.xml
 +
    .../im/reports/templater/grades_list/odf/content/mimetype
 +
    .../im/reports/templater/grades_list/odf/content/settings.xml
 +
Ниже представлена схема структуры папок, с пояснением, для чего какие файлы и директории нужны.
 +
[[Изображение:folders5.jpeg]]
 +
 
 +
Пример реализации экспорта в '''odf''':
 +
    $template = $DOF->modlib('templater')->template('im', 'reports', $data, 'grades_list');
 +
    $template->send_file('odf');
 +
    die;
  
 
=== CSV ===
 
=== CSV ===
Comma Separated Value - значения разделенные запятыми. Файлы этого формата  - это текстовые файлы, данные в которых отделяются друг от друга специальными текстовыми разделителями.
+
Comma Separated Value - значения разделенные запятыми. Файлы этого формата  - это набор строк, данные в которых отделяются друг от друга специальными текстовыми разделителями. Обычно запятой, точкой с запятой или символом таблуляции.
 +
 
 +
Экспорт в этот формат имеет свои особенности.
 +
 
 +
По умолчанию экспорт документов в этот формат происходит следующим образом:
 +
* из входных данных берется самый первый массив объектов;
 +
* названия свойств (названия, а не значения!) первого объекта становятся строкой заголовков, остальные поля - строками данных;
 +
* при формировании строк данных в них попадают только данные, которые хранятся в свойствах объекта, одноименных со свойствами объекта, из которого сформирована строка заголовка. Лишние данные отбрасываются, недостающие заменяются пробелами;
 +
* все остальные элементы входных данных игнорируются.
 +
 
 +
Поскольку csv-файлы имеют стандартную и неизменную структуру, шаблоны для их построения не требуются. Из объекта данных формируется последовательность строк, после чего обработанные данные отсылаются клиенту:
 +
    $template = $DOF->modlib('templater')->template('im', 'reports', $data, 'teachers_list');
 +
    $template->send_file('csv');
 +
    die;
 +
 
 +
По умолчанию строка заголовка вставляется в конечный файл. Но можно это отключить:
 +
    $template = $DOF->modlib('templater')->template('im', 'reports', $data, 'teachers_list');
 +
    $options = new object;
 +
    $options->title = false;
 +
    $template->send_file('csv', $options);
 +
    die;
  
 
=== HTML ===
 
=== HTML ===
 
Экспорт в этот формат пригодиться в случае, если вам нужно сохранить данные из какого-либо документа как web-страницу.
 
Экспорт в этот формат пригодиться в случае, если вам нужно сохранить данные из какого-либо документа как web-страницу.
 +
Как обычно, надо создать файл шаблона, разметить его, положить в установленное место и назвать '''template.html'''.  О том, как правильно его разметить можно прочитать в разделе [[Разработка:modlibs/templater#Подготовка шаблона документа|Подготовка шаблона документа]].
 +
Пример кода:
 +
    $template = $DOF->modlib('templater')->template('im', 'reports', $data, 'grades_list');
 +
    $template->send_file('html');
 +
=== DBG ===
 +
Это тестовый вариант экспорта. На экран выводятся входные данные в том виде как они переданы. Это может помочь разобраться с их структурой и проверить работоспособность классов. Для этого варианта экспорта не требуется никакого шаблона. Все остальное - как обычно.
 +
Пример кода:
 +
    $template = $DOF->modlib('templater')->template('im', 'reports', $data, 'grades_list');
 +
    $template->send_file('dbg');
  
 
== Ссылки ==
 
== Ссылки ==
 
*[http://pear.php.net/package/HTML_Template_Sigma Шаблонизатор HTMLTemplateSigma]
 
*[http://pear.php.net/package/HTML_Template_Sigma Шаблонизатор HTMLTemplateSigma]
 
*[http://pear.php.net/manual/en/package.html.html-template-sigma.intro-syntax.php Справка по синтаксису шаблонизатора Sigma]
 
*[http://pear.php.net/manual/en/package.html.html-template-sigma.intro-syntax.php Справка по синтаксису шаблонизатора Sigma]

Текущая версия на 16:59, 5 апреля 2013

Плагин
Название templater
Тип modlibs


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

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

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

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

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

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

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

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

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

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

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

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

ФИО ученика оценка
Зб класс, Математика, 21.01.09
1 Замеладский Алексей 5
2 Гусева Татьяна 4
5б класс, Русский язык, 27.01.09
1 Коньков Сергей 5
2 Захаров Александр 3

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

   stdClass Object
   (
   [classes] => Array 
   
       [0] => stdClass Object                                           // данные о первом классе
           [name]       => 3 "б"
           [date]       => 21.01.09
           [subject]    => Математика
           [students]   => Array
   
               [0] => stdClass Object                                   // здесь хранятся данные первого ученика из 3-го "Б"
                       [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                                   // здесь хранятся данные первого ученика из 5-го "Б"
                       [number] => 1
                       [fio]    => Коньков Сергей
                       [grade]  => 5
               [1] => stdClass Object
                       [number] => 2
                       [fio]    => Захаров Александр
                       [grade]  => 3
   )

Реализация экспорта

Подготовка к экспорту

Для начала надо убедиться, что на месте вспомогательные средства. Т.е. установлен описываемый плагин templater, и плагин обеспечивающий превращения шаблона документа в документ - pear. Поэтому убедитесь, что у вас

  • установлен плагин pear. Удостоверьтесь, что на странице списка установленных плагинов, напротив модуля pear написано "Удалить, а не " "Установить".
  • в нем есть библиотека HTML_Template_Sigma. Проверьте наличие файла .../modlibs/pear/libs/HTML_Template_Sigma/Sigma.php.
  • установлен описываемый модуль - templater. Проверьте так же как и pear.

Теперь надо подготовить плагин. В нем надо создать структуру папок. Для реализации экспорта надо создать в корневой папке плагина директорию templater. В ней нужно создать каталоги для каждого документа, который вы собираетесь экспортировать. В каждой из них нужно создать папки, названия которых - это типы файлов, в которые вы собираетесь экспортировать каждый документ. Внутри этих папок должны лежать файлы шаблонов для экспорта. Например, у нас есть плагин reports, типа im. Из него планируется экспортировать отчеты: список оценок - grades_list, список учеников - students_list, список учителей - teachers_list. Список оценок будет экспортироваться в форматы odf, csv, html. Список учителей в форматы odf и html. Список студентов в csv и html. Тогда надо создать такую структуру папок:

   .../im/reports/templater/grades_list/odf
   .../im/reports/templater/grades_list/csv
   .../im/reports/templater/grades_list/html
   .../im/reports/templater/students_list/csv
   .../im/reports/templater/students_list/html
   .../im/reports/templater/teachers_list/odf
   .../im/reports/templater/teachers_list/html

Внутри этих папок следует разместить шаблоны документов для экспорта.

Правила подготовки шаблона описаны в разделе Подготовка шаблона документа.

Теперь, когда шаблон есть, можно переходить к следующему этапу - сбору данных для экспорта. Объект экспорта должен соответствовать структуре объекта, описанной в разделах Формат исходных данных и Пример исходных данных.

Теперь все необходимые приготовления выполнены и можно переходить непосредственно к экспорту.

Экспорт документа

Собственно экспорт осуществляется в два этапа. Создание объекта экспорта и инициализация экспорта. Поясним оба этапа на примере. Предположим, мы хотим экспортировать ведомость оценок grades_list из плагина reports в формат odf. Тогда

  • Получаем нужный объект:
   $exporter = $DOF->modlib('templater')->template('im', 'reports', $dataforexport, 'grades_list');

Здесь:

im - тип плагина,

reports - имя плагина,

grades_list - директория, в которой лежит шаблон документа, который будет экспортирован.

$exporter - объект, который будет производить все необходимые операции.

$dataforexport - собранные на предыдущем этапе данные.

  • Получив объект, инициализируем отправку файла:
   $exporter->send_file('odf');
   die;

Функция die здесь использована для того, чтобы больше ничего в файл экспорта не попало.

Обратите внимание, что объект $exporter уже хранит в себе все необходимые данные. Если вы хотите еще раз экспортировать данные, но уже в другой формат - не нужно заново создавать объект, достаточно обратиться к нему еще раз, например:

   $exporter = $DOF->modlib('templater')->template('im', 'reports', $dataforexport, 'grades_list');    
   switch ($type)
   {
       case 'odf': $exporter->send_file('odf');break;
       case 'csv': $exporter->send_file('csv');break;
   }
   die;

По умолчанию имя посылаемого файла формируется из собственно имени файла (которое по умолчанию равно export), и расширения, в качестве которого используется тип файла, указанный при инициализации экспорта. Но можно задать и другое имя. Для этого надо использовать второй необязательный параметр функции send_file:

   $options = new object;
   $options->filename = 'new_export_file_name';
   $exporter->send_file('odf', $options);

Имя файла надо указывать без расширения.

Подготовка шаблона документа

Если вам нужно создать новый документ, то нужно создать и новый шаблон документа. Файл шаблона должен быть размечен тегами шаблонизатора PEAR::HTMLTemlateSigma. В нем оформляются места для вставки данных - поля и блоки.

  • Отдельное поле помечается фигурными скобками {}.
  • Внутри скобок указывается имя поля. Например, {lastname} - поле, вместо которого должна подставляться фамилия.
  • Если есть блок полей, то начало блока помечается тегом ‹!-- BEGIN block_name --›.
  • Окончание блока помечается тегом ‹!-- END block_name --›. Здесь block_name - имя блока, все остальное - обязательная служебная конструкция. Между этими тегами нужно размещать поля блока и другие блоки.

Например надо таблицу ведомости оценок (см. Пример исходных данных)

ФИО ученика оценка
Зб класс, Математика, 21.01.09
1 Замеладский Алексей 5
2 Гусева Татьяна 4
5б класс, Русский язык, 27.01.09
1 Коньков Сергей 5
2 Захаров Александр 3

получить в виде html-файла. Тогда в шаблоне документа надо вставить поля и блоки примерно так:

   <html>
   ....
   ‹table›
      ‹tr›
         ‹td›№‹/td›
         ‹td›ФИО ученика‹/td›
         ‹td›Оценка‹/td›
      ‹/tr›
      ‹!-- BEGIN classes --›
      ‹tr›
         ‹td›{name} класс, {subject}, {date}‹/td›
      ‹/tr›
      ‹!-- BEGIN students --›
      ‹tr›
         ‹td›{number}‹/td›
         ‹td›{fio}‹/td›
         ‹td›‹grade>‹/td>
      ‹/tr›
      ‹!-- END students --›
      ‹!-- END classes --›
   ‹/table›
   ....
   ‹/html›

Каждый файл шаблона должен иметь имя template.тип_файла экспорта. К примеру template.html. Из этого правила есть несколько исключений. В частности, odf-формат имеет сложную структуру, поэтому и его шаблон должен быть устроен соответственно. Структура папок шаблона odf-документа описана тут. В ряде случаев шаблон документа вообще не нужен. Так например, формат dbg - это тестовый вариант вывода данных. В этом случае неформатированные данные экспорта выводятся на экран. Другой случай - экспорт в формат csv. Файл в этом формате представляет собой набор строк, в которых данные разделены запятыми. Для него шаблон также не нужен.

Альтернативный способ формирования документа

Можно изменить способ формирования документа в существующий формат. Для этого надо, в своем плагине, в папке с названием типа файла экспорта создать файл init.php. Т.е. если мы хотим изменить формирование списка оценок в файл html, то должна получиться такая структура папок

   .../templater/reports/grades_list/html/init.php
   .../templater/reports/grades_list/html/template.html

Внутри этого файла, должен быть определен класс, который и создает документ из шаблона. Теперь, во время экспорта, формирование документа будет производить не встроенный в templater класс, а альтернативный.

Если возникла необходимость экспортировать данные в файл, тип которого не поддерживает плагин templater, можно самостоятельно реализовать и это. Для этого надо добавить папку тип_файла_экспорта в плагин templater:

   .../modlib/templater/formats/тип_файла_экспорта

А внутрь нее положить файл init.php, с аналогичным классом. Например, надо реализовать экспорт в excell. Тогда в плагине templater должен появиться файл init.php по такому адресу:

   .../modlib/templater/formats/xls/init.php

Общий принцип формирования имен классов:

  • Для создания нового формата dof_modlib_templater_format_тип-файла-экспорта.
  • Для изменения логики работы существующего формата dof_типплагина_имяплагина_templater_название-папки-документа_тип-файла-экспорта.

Таким образом, для выше приведенных примеров имена классов будут такими:

  • Новый класс экспорта в excell: dof_moblib_templater_format_xls.
  • Альтернативный класс экспорта в html: dof_im_reports_templater_grades_list_html.

В плагине templater существует абстрактный базовый класс dof_modlib_templater_format. Каждый класс, который вы создаете, должен наследоваться от него. При создании нового формата обязательно нужно реализовать следующие методы:

  • get_file($options) - получить файл в виде строки. Главная функция, производящая все преобразования над данными.
  • get_filename($options) - получить имя файла вместе с расширением одной строкой.
  • get_mimetype($options) - получить MIME-тип для подстановки его в HTTP-заголовок.

Дальнейшее использование созданного вами формата аналогично использованию готового формата. Более подробную информацию о методах и свойствах класса dof_modlib_templater_format можно найти в разделе API.

Альтернативный способ экспорта

Если работа стандартного контейнера экспорта dof_modlib_templater_package вас не устраивает, то вы можете создать свой. Для этого надо создать свой класс и реализовать в нем необходимые методы. Этот класс надо поместить в файл init.php, а файл положить в папку того документа, для экспорта которого, вы этот контейнер создавали. Теперь при создании объекта экспорта будет создан не стандартный объект, а тот, который вы написали в файле. К примеру, вы хотите производить экспорт оценок через собственный контейнер. Тогда должна получиться такая структура папок:

   .../im/reports/templater/grades_list/odf/ 
   .../im/reports/templater/grades_list/csv/
   .../im/reports/templater/grades_list/html/
   .../im/reports/templater/grades_list/init.php

Класс контейнера должен именоваться так: dof_тип-плагина_имя-плагина_templater_название-папки-документа. В нашем случае это dof_im_reports_templater_grades_list.

API плагина

В этом разделе описаны все функции интерфейса плагина templater.

Внешний

dof_modlib_templater:

  • template($plugintype, $pluginname, $data, $templatename) — возвращает класс экспорта документа из указанного плагина. Возвращает объект класса dof_modlib_templater_package или dof_тип-плагина_имя-плагина_templater_имя-документа
    • $plugintype - тип плагина
    • $pluginname - имя плагина
    • $data - данные для экспорта, структурированные как указано выше.
    • $templatename - имя документа; здесь указывается имя папки, в которой лежат шаблоны для формирования документа в разных форматах. В рассмотренных выше примерах это grages_list, teachers_list или students_list.
  • template_path($plugintype, $pluginname, $templatename,$adds=null, $fromplugin) - возвращает путь внутри плагина.
    • $plugintype - тип плагина
    • $pluginname - имя плагина
    • $templatename - имя документа (см. предыдущую функцию)
    • $adds - дополнительный путь внутри плагина
    • $fromplugin - какой путь нужно вернуть: из внешнего плагина или из modlib/templater. Ее возможные значения:
      • null (по умолчанию) - искать путь сначала во внешнем плагине, а затем во внутреннем
      • true - искать только во внешнем планине
      • false - искать только в modlib/templater

Таблица, описывающая работу этой функции:

$templatename $fromplugin Результат
1 null null Путь внутри modlib/templater
2 null true false
3 null fasle Путь внутри modlib/templater
4 Существующее null Путь из внешнего плагина
5 Существующее true Путь из внешнего плагина
6 Существующее false Путь внутри modlib/templater
7 Ошибочное null false
8 Ошибочное true false
9 Ошибочное false false

dof_modlib_templater_package

  • get_file($type, $options) - получить отформатированные данные, пригодные для обработки функцией file_put_contents().
    • $type — в какой формат экспортировать. Должно совпадать с названием папок в .../modlibs/templater/formats/ - dbg или csv, или odf и др. А также с именем папки во внешнем плагине, в котором лежит шаблон экспорта в файлы такого типа.
    • $options — дополнительные параметры.
  • send_file($type, $options) — инициализировать передачу файла клиенту через браузер.
    • $type — в какой формат экспортировать,
    • $options — дополнительные параметры.
  • get_formats() - список доступных для указанного документа типов файлов экспорта.
  • template_path($adds=null, $fromplugin) - путь к шаблону (работает через класс dof_modlib_templater)
    • $adds - дополнительный путь, присоединяемый к возвращаемому функцией template_path в классе dof_modlib_templater:
    • $fromplugin - какой путь нужно вернуть: из внешнего плагина или из modlib/templater. Возможные значения:
      • null (по умолчанию) - искать путь сначала во внешнем плагине, а затем в
      • true - искать только во внешнем планине
      • false - искать только в modlib/templater

Внутренний

Этот раздел понадобится вам в случае если вам будет нужно написать собственный формат или тип документа.

dof_modlib_templater_package:

  • __construct($dof, $plugintype, $pluginname, $templatename)
    • $dof - стандартный объект $DOF
    • $plugintype - тип плагина (im, storage, modlib и т. д.)
    • $pluginname - имя плагина
    • $templatename - имя шаблона форматирования, для которого вызывается обьект dof_modlib_templater_package:
  • set_data($obj) — загрузить необработанные данные в объект.
    • $obj - объект с необработанными данными
  • get_data() - внутренний метод. Получить необработанный объект с данными.

dof_modlib_templater_format

  • __construct($dof, $plugintype, $pluginname, $templatename) - конструктор класса. Вызывается автоматически объектом dof_modlib_templater_package.
    • $dof - объект $DOF
    • $plugintype - Тип плагина
    • $pluginname - имя плагина
    • $templatename - имя шаблона для экспорта
  • get_file($options)
    • $options - произвольные дополнительные параметры
  • set_data($data)
    • $data - объект с заранее подготовленными данными
  • get_filename($options)
    • $options - произвольные дополнительные параметры
  • get_mimetype($options)
    • $options - произвольные дополнительные параметры
  • template_path($adds=null, $fromplugin) - путь к папке данного формата (работает через класс package)
    • $adds - дополнительный путь, присоединяемый к возвращаемому функцией template_path в классе dof_modlib_templater_package:
    • $fromplugin - какой путь нужно вернуть: из внутреннего плагина или из modlib/templater. Возможные значения:
      • null (по умолчанию) - искать путь сначала во внешнем плагине, а затем в
      • true - искать только во внешнем планине
      • false - искать только в modlib/templater

Дополнительные методы Sigma

  • date($fofmat,$value = null) - Форматирует системную дату/время. Равносилен стандартной функции РНР strftime.
  • mb_substr($value,$start = 0,$length = 1) - Получает часть строки. Равносилен стандартной функции РНР mb_substr. Используемая кодировка 'utf-8'.
  • get_value($id,$field,$code) - Возвращает значение поля в записи с указанным id.
    • $id - id записи в таблице
    • $field - поле в таблице
    • $code - имя плагина справочника
  • get_string($identifier, $pluginname = NULL, $a = NULL, $plugintype = 'im') - Возвращает строку перевода из файла локализации. Равносилен стандартному методу деканата get_string.

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

В этом разделе будут рассмотрены все поддерживаемые плагином templater форматы экспорта.


ODF

Open Document Format. Этот формат используется документами OpenOffice. В этом формате можно создавать как обычные текстовые документы (odt), так и электронные таблицы (ods). Для подготовки документа нужно разметить его тегами шаблонизатора Sigma. Создание текстового документа и электронной таблицы происходит одинаково - разница только в расширении файла: odt - для текстового документа, и ods для электронной таблицы.

Экспорт в формат odf реализуется стандартным образом. Отдельных слов, в силу особенностей структуры документа, заслуживает только подготовка шаблона. Все файлы формата odf представляют собой zip-архивы определенной структуры. У odt или ods документов собственно текст находится в файле content.xml, который лежит в корне архива. Для того, чтобы правильно разметить документ - воспользуйтесь разделом Подготовка шаблона документа.

В плагине, из которого планируется реализовать экспорт в odf, папке odf, должна лежать папка с именем content, в которой должны лежать каталоги и файлы распакованные из этого архива. Собственно текст документа хранится в файле content.xml. Поэтому именно этот файл должен быть размечен как шаблон документа. Остальные файлы и папки можно оставить без изменения. В итоге мы должны увидеть что-то подобное:

   .../im/reports/templater/grades_list/odf/content/Configurations2/
   .../im/reports/templater/grades_list/odf/content/META-INF/
   .../im/reports/templater/grades_list/odf/content/Thumbnails/
   .../im/reports/templater/grades_list/odf/content/content.xml
   .../im/reports/templater/grades_list/odf/content/meta.xml
   .../im/reports/templater/grades_list/odf/content/mimetype
   .../im/reports/templater/grades_list/odf/content/settings.xml

Ниже представлена схема структуры папок, с пояснением, для чего какие файлы и директории нужны. Folders5.jpeg

Пример реализации экспорта в odf:

   $template = $DOF->modlib('templater')->template('im', 'reports', $data, 'grades_list');
   $template->send_file('odf');
   die;

CSV

Comma Separated Value - значения разделенные запятыми. Файлы этого формата - это набор строк, данные в которых отделяются друг от друга специальными текстовыми разделителями. Обычно запятой, точкой с запятой или символом таблуляции.

Экспорт в этот формат имеет свои особенности.

По умолчанию экспорт документов в этот формат происходит следующим образом:

  • из входных данных берется самый первый массив объектов;
  • названия свойств (названия, а не значения!) первого объекта становятся строкой заголовков, остальные поля - строками данных;
  • при формировании строк данных в них попадают только данные, которые хранятся в свойствах объекта, одноименных со свойствами объекта, из которого сформирована строка заголовка. Лишние данные отбрасываются, недостающие заменяются пробелами;
  • все остальные элементы входных данных игнорируются.

Поскольку csv-файлы имеют стандартную и неизменную структуру, шаблоны для их построения не требуются. Из объекта данных формируется последовательность строк, после чего обработанные данные отсылаются клиенту:

   $template = $DOF->modlib('templater')->template('im', 'reports', $data, 'teachers_list');
   $template->send_file('csv');
   die;

По умолчанию строка заголовка вставляется в конечный файл. Но можно это отключить:

   $template = $DOF->modlib('templater')->template('im', 'reports', $data, 'teachers_list');
   $options = new object;
   $options->title = false;
   $template->send_file('csv', $options);
   die;

HTML

Экспорт в этот формат пригодиться в случае, если вам нужно сохранить данные из какого-либо документа как web-страницу. Как обычно, надо создать файл шаблона, разметить его, положить в установленное место и назвать template.html. О том, как правильно его разметить можно прочитать в разделе Подготовка шаблона документа. Пример кода:

   $template = $DOF->modlib('templater')->template('im', 'reports', $data, 'grades_list');
   $template->send_file('html');

DBG

Это тестовый вариант экспорта. На экран выводятся входные данные в том виде как они переданы. Это может помочь разобраться с их структурой и проверить работоспособность классов. Для этого варианта экспорта не требуется никакого шаблона. Все остальное - как обычно. Пример кода:

   $template = $DOF->modlib('templater')->template('im', 'reports', $data, 'grades_list');
   $template->send_file('dbg');

Ссылки