itemplate описание интерфейса
06.04.2010Содержание
| Методы | Свойства |
|---|---|
| getcont | description |
| getdescription | head |
| gethead | idview |
| getidview | keywords |
| getkeywords | title |
| gettitle | |
| request | |
| setidview |
| Интерфейс | itemplate |
| Исходный код | lib/interfaces.php |
Интерфейс для генерации html. Используется классом ttemplate. Метод request используется turlmap для предварительного запроса до генерации html, подробности смотрите в описании метода.
Следует сделать важное замечание. Интерфейс itemplate (как и другие интерфейсы) в неявном виде подразумевает добавление стандартных свойств в классе поддерживающим интерфейс. В интерфейсе по правилам PHP могут быть только методы, но поскольку litepublisher поддерживает добавление новых свойств через методы (смотрите описание волшебных методов tdata: __get и __set. Таким образом в документации к интерфейсу будут свойства.
Методы
| Метод | getcont |
| Тип | string |
| Доступ | public |
Центральный метод интерфейса. Возвращает html контент. Как правило внутри этого метода классы используют шаблоны текущей темы секции content для генерации html. Пример реализации в записи:
Перейти к содержанию
| Метод | getdescription |
| Тип | string |
| Доступ | public |
Возвращает строку, которая будет в description секции head html страницы.
Перейти к содержанию
| Метод | gethead |
| Тип | string |
| Доступ | public |
Возвращает строку, которая будет в секции head html страницы. Как правило используется для добавления javascript только для одной страницы или особых стилей и тому подобное.
Перейти к содержанию
| Метод | getidview |
| Тип | integer |
| Доступ | public |
Метод возвращает id вида класса. Класс ttemplate создает экземпляр tview, используя полученный id. В виде находится много информации: тема, виджеты, меню и другие настройки необходимые для генерации html страницы
Перейти к содержанию
| Метод | getkeywords |
| Тип | string |
| Доступ | public |
Возвращает строку, которая будет в keywords секции head html страницы.
Перейти к содержанию
| Метод | gettitle |
| Тип | string |
| Доступ | public |
Вызывается из ttemplate и возвращает строку - заголовок страницы. Поскольку название метода начинается с get, то этот метод добавляет свойство title к классу
Перейти к содержанию
| Метод | request |
| Тип | mixed |
| Доступ | public |
Вызывается из GenerateHTML. У метода один аргумент, который был добавлен в таблицу адресов turlmap, например для записей это id записи, другие классы могут передавать другие аргументы, в том числе и null. Если метод возвращает 404 (целое число), то будет отдана страница 404 not found. Так например 404 возвращают записи со статусом черновик. Классы генерирующие XML, должны вернуть законченный xml документ с http заголовками в этом методе. Если метод ничего не возвратит, то будет запущен процесс генерации html страницы, которое осуществляет класс ttemplate. Если будет возвращена строка, то эта строка будет выполнена как php код (eval). Так поступают классы возвращающие xml TRSS, TXMLRPC'
Перейти к содержанию
| Метод | setidview |
| Тип | void |
| Доступ | public |
Метод меняет id вида (смотрите tview) у класса. Метод вызывается если полученный getidview id вида не существует и необходимо исправить значение.
Перейти к содержанию
Свойства
| Свойство | description |
| Тип | string |
| Доступ | только чтение |
Строка description секции head html страницы. Свойство появляется в классе реализующем интерфейс itemplate.
Перейти к содержанию
| Свойство | head |
| Тип | string |
| Доступ | только чтение |
Дополнительные строки секции head html страницы. Свойство появляется в классе реализующем интерфейс itemplate.
Перейти к содержанию
| Свойство | idview |
| Тип | string |
| Доступ | чтение и запись |
id вида страницы, смотрите класс tview. Важное свойство для чтения и записи у классов поддерживающих интерфейс ]]itemplate]].
Перейти к содержанию
| Свойство | keywords |
| Тип | string |
| Доступ | только чтение |
Строка для keywords секции head html страницы. Свойство появляется в классе реализующем интерфейс itemplate.
Перейти к содержанию
| Свойство | title |
| Тип | string |
| Доступ | только чтение |
Заголовок страницы. Свойство появляется в классе реализующем интерфейс itemplate.
Перейти к содержанию
← Ранее tevents описание класса
Позже litepublisher описание класса →
Комментариев нет на запись “itemplate описание интерфейса”
Оставить комментарий