Разработка:modlibs/templater - История изменений

K-krsnv: /* Дополнительные методы Sigma */

2013-04-05T13:59:32Z

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

Johnleft: /* ODF */ исправлены ошибки

2009-06-05T09:42:32Z

‎ODF: исправлены ошибки

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

2009-06-05T09:20:05Z

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

Johnleft: /* Подготовка шаблона документа */ исправлены ошибки

2009-06-05T09:15:31Z

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

Johnleft: /* Экспорт документа */ исправил ошибки

2009-06-05T09:00:43Z

‎Экспорт документа: исправил ошибки

Johnleft: /* Подготовка к экспорту */ исправил мелкие ошибки

2009-06-05T08:59:05Z

‎Подготовка к экспорту: исправил мелкие ошибки

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

2009-06-05T08:38:05Z

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

Johnleft: /* Альтернативный способ экспорта */ Добавлена глава про свой контейнер экспорта

2009-06-05T08:22:10Z

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

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

2009-06-04T14:28:45Z

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

Johnleft: /* dof_modlib_templater_package: */ убрал двоеточие

2009-06-04T14:27:23Z

‎dof_modlib_templater_package:: убрал двоеточие

@@ Строка 367: / Строка 367: @@
 === Дополнительные методы Sigma ===
-*'''date'''($fofmat,$value = null) - Форматирует системную дату/время. Равносилен стандартной функции РНР [http://ru2.php.net/manual/ru/function.date.php date].
+*'''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.

@@ Строка 381: / Строка 381: @@
 === ODF ===
 Open Document Format.
-Этот формат используется документами [http://openoffice.ru OpenOffice]. В этом формате можно создавать как обычные текстовые документы (odt), так и электронные таблицы (ods). Для подготовки документа нужно разметить его тегами шаблонизатора [http://pear.php.net/package/HTML_Template_Sigma Sigma]. Создание текстового документа и электронной таблицы происходит одинаково - разница только в расширении файла: odf - для текстового документа, и ods для электронной таблицы.
+Этот формат используется документами [http://openoffice.ru OpenOffice]. В этом формате можно создавать как обычные текстовые документы (odt), так и электронные таблицы (ods). Для подготовки документа нужно разметить его тегами шаблонизатора [http://pear.php.net/package/HTML_Template_Sigma Sigma]. Создание текстового документа и электронной таблицы происходит одинаково - разница только в расширении файла: odt - для текстового документа, и ods для электронной таблицы.
 Экспорт в формат odf реализуется стандартным образом. Отдельных слов, в силу особенностей структуры документа, заслуживает только подготовка шаблона.

@@ Строка 228: / Строка 228: @@
 * Альтернативный класс экспорта в '''html''': '''dof_im_reports_templater_grades_list_html'''.
-В плагине templater существует абстрактный базовый класс  ''dof_modlib_templater_format''. Каждый класс, который вы создаете, должен наследоваться от него.
+В плагине '''templater''' существует абстрактный базовый класс  '''dof_modlib_templater_format'''. Каждый класс, который вы создаете, должен наследоваться от него.
 При создании нового формата обязательно нужно реализовать следующие методы:
 * '''get_file'''($options) - получить файл в виде строки. Главная функция, производящая все преобразования над данными.

@@ Строка 208: / Строка 208: @@
      &lsaquo;/html&rsaquo;
-Каждый файл шаблона должен иметь имя template.тип_файла экспорта. К примеру '''template.html'''. Из этого правила есть несколько исключений. В частности, odf-формат имеет сложную структуру, поэтому и его шаблон должен быть устроен соответственно. Структура папок шаблона odf-документа описана [[Разработка:modlibs/templater#ODF|тут]]. В ряде случаев шаблон документа вообще не нужен. Так например, формат dbg - это тестовый вариант вывода данных. В этом случае неформатированные данные экспорта выводятся на экран. И все. Другой случай - экспорт в формат csv. Файл в этом формате представляет собой набор строк, в которых данные разделены запятыми. Для него шаблон также не нужен.
+Каждый файл шаблона должен иметь имя template.тип_файла экспорта. К примеру '''template.html'''. Из этого правила есть несколько исключений. В частности, odf-формат имеет сложную структуру, поэтому и его шаблон должен быть устроен соответственно. Структура папок шаблона odf-документа описана [[Разработка:modlibs/templater#ODF|тут]]. В ряде случаев шаблон документа вообще не нужен. Так например, формат dbg - это тестовый вариант вывода данных. В этом случае неформатированные данные экспорта выводятся на экран. Другой случай - экспорт в формат '''csv'''. Файл в этом формате представляет собой набор строк, в которых данные разделены запятыми. Для него шаблон также не нужен.
 === Альтернативный способ формирования документа ===

@@ Строка 131: / Строка 131: @@
      $exporter->send_file('odf');
      die;
-Функция die здесь ипсользована для того, чтобы больше ничего в файл экспорта не попало.
+Функция die здесь использована для того, чтобы больше ничего в файл экспорта не попало.
 Обратите внимание, что объект $exporter уже хранит в себе все необходимые данные. Если вы хотите еще раз экспортировать данные, но уже в другой формат - не нужно заново создавать объект, достаточно обратиться к нему еще раз, например:

@@ Строка 90: / Строка 90: @@
 ==== Подготовка к экспорту ====
 Для начала надо убедиться, что на месте вспомогательные средства. Т.е. установлен описываемый плагин '''templater''', и плагин обеспечивающий превращения шаблона документа в документ - '''pear'''. Поэтому убедитесь, что у вас
-* установлен плагин '''pear'''. Убедитесь, что на странице списка установленных плагинов, напротив модуля pear написано "Удалить, а не " "Установить".
+* установлен плагин '''pear'''. Удостоверьтесь, что на странице списка установленных плагинов, напротив модуля pear написано "Удалить, а не " "Установить".
 * в нем есть библиотека '''HTML_Template_Sigma'''. Проверьте наличие файла '''.../modlibs/pear/libs/HTML_Template_Sigma/Sigma.php'''.
 * установлен описываемый модуль - '''templater'''. Проверьте так же как и '''pear'''.
-Теперь надо подготовить плагин. В нем надо создать структуру папок. Для реализации экспорта надо создать в корневой папки плагина директорию '''templater'''. В ней нужно создать каталоги для каждого документа, который вы собираетесь экспортировать. В каждой из них нужно создать папки, названия которых - это типы файлов, в которые вы собираетесь экспортировать каждый документ. Внутри этих папок должны лежать файлы шаблонов для экспорта.
+Теперь надо подготовить плагин. В нем надо создать структуру папок. Для реализации экспорта надо создать в корневой папке плагина директорию '''templater'''. В ней нужно создать каталоги для каждого документа, который вы собираетесь экспортировать. В каждой из них нужно создать папки, названия которых - это типы файлов, в которые вы собираетесь экспортировать каждый документ. Внутри этих папок должны лежать файлы шаблонов для экспорта.
 Например, у нас есть плагин '''reports''', типа '''im'''. Из него планируется экспортировать отчеты: список оценок - '''grades_list''', список учеников - '''students_list''', список учителей - '''teachers_list'''. Список оценок будет экспортироваться в форматы odf, csv, html. Список учителей в форматы odf и html. Список студентов в csv и html. Тогда надо создать такую структуру папок:
      .../im/reports/templater/grades_list/odf

@@ Строка 213: / Строка 213: @@
 Можно изменить способ формирования документа в существующий формат. Для этого надо, в своем плагине, в папке с названием типа файла экспорта создать файл '''init.php'''. Т.е. если мы хотим изменить формирование списка оценок в файл '''html''', то должна получиться такая структура папок
      .../templater/reports/grades_list/html/init.php
-     .../templater/reports/grades_list/html/template.php
+     .../templater/reports/grades_list/html/template.html
 Внутри этого файла, должен быть определен класс, который и создает документ из шаблона. Теперь, во время экспорта, формирование документа будет производить не встроенный в '''templater''' класс, а альтернативный.
@@ Строка 235: / Строка 235: @@
 Дальнейшее использование созданного вами формата аналогично использованию готового формата. Более подробную информацию о методах и свойствах класса ''dof_modlib_templater_format'' можно найти в разделе [[Разработка:modlibs/templater#dof_modlib_templater_format|API]].
 === Альтернативный способ экспорта ===
 Если работа стандартного контейнера экспорта [[Разработка:modlibs/templater#dof_modlib_templater_package|dof_modlib_templater_package]] вас не устраивает, то вы можете создать свой. Для этого надо создать свой класс и реализовать в нем необходимые методы. Этот класс надо поместить в файл '''init.php''', а файл положить в папку того документа, для экспорта которого, вы этот контейнер создавали. Теперь при создании объекта экспорта будет создан не стандартный объект, а тот, который вы написали в файле. К примеру, вы хотите производить экспорт оценок через собственный контейнер. Тогда должна получиться такая структура папок:

← Предыдущая		Версия 14:28, 4 июня 2009
Строка 235:		Строка 235:

	Дальнейшее использование созданного вами формата аналогично использованию готового формата. Более подробную информацию о методах и свойствах класса ''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]] вас чем-либо не устраивает, то вы можете создать свой. Для этого

	== API плагина ==		== API плагина ==

@@ Строка 309: / Строка 309: @@
   |}
-====dof_modlib_templater_package:====
+====dof_modlib_templater_package====
 *'''get_file'''($type, $options) - получить отформатированные данные, пригодные для обработки функцией file_put_contents().
 **$type — в какой формат экспортировать. Должно совпадать с названием папок в ...'''/modlibs/templater/formats/''' - '''dbg''' или '''csv''', или '''odf''' и др. А также с именем папки во внешнем плагине, в котором лежит шаблон экспорта в файлы такого типа.