Страничные TPL-теги
- 292 просмотра
- 16 октября, 2023
- Обновлено: 12 декабря, 2023
- admin
- Время чтения: 3 минуты
- 2 (Подробно)
В API модуля Page присутствует полезная функция cot_generate_pagetags(), которая создает набор TPL-тегов, включающий в себя всю информацию о странице, т.е. содержимое всех ее полей и экстраполей, а также некоторые другие данные.
Функция cot_generate_pagetags() используется практически во всех плагинах, предназначенных для вывода данных страницы или страниц. В модуле Page дистрибутива Cotonti данная функция отвечает за создание TPL-тегов в локации страницы и в регулярном блоке LIST_ROW страничного раздела. В первом случае используется префикс PAGE_, во втором – LIST_ROW_. Например:
// На странице:
{PAGE_SHORTTITLE}
// В разделе:
{LIST_ROW_CAT}
// В плагине Pagelist
{PAGE_ROW_URL}
В релизе 0.9.24 будут введены более понятные и логичные имена для страничных тегов. Старые будут оставлены для совместимости в течение разумного срока, необходимого для обновления.
Перечислим все TPL-теги (с учетом нового нейминга) с кратким их описанием:
| TPL-тег | Имя поля в таблице | Описание |
|---|---|---|
| URL | page_url | URL страницы |
| ID | page_id | ID страницы |
| TITLE | Заголовок страницы |
|
| BREADCRUMBS | Навигационная цепочка или "хлебные крошки" страницы | |
| ALIAS | page_alias | Алиас страницы |
| STATE | page_state | Состояние страницы (0 опубликована, 1 снята с публикации) |
| STATUS | Результат выполнения функции cot_page_status() (expired, approved, published, draft, pending) |
|
| LOCAL_STATUS |
Локализованный результат выполнения функции cot_page_status (срок публикации окончен, подтверждена, опубликована, черновик или в ожидании) |
|
| CAT | page_cat | Код раздела |
| CAT_URL |
URL раздела | |
| CAT_TITLE |
structure_title | Заголовок раздела |
| CAT_PATH |
Навигационная цепочка или "хлебные крошки" раздела | |
| CAT_PATH_SHORT |
Готовая ссылка на раздел | |
| CAT_DESCRIPTION |
structure_desc | Описание раздела |
| CAT_ICON |
Иконка раздела в виде готового HTML-тега IMG | |
| CAT_ICON_SRC | Путь к иконке раздела | |
| KEYWORDS | page_keywords | Meta keywords (данный meta-тег не актуален) |
| DESCRIPTION |
page_desc | Описание страницы |
| TEXT | page_text | Текст страницы |
| TEXT_CUT | Часть текста, обрезанная до тега 'more' | |
| TEXT_IS_CUT | Флажок наличия обрезки текста | |
| DESCRIPTION_OR_TEXT |
При наличии описания страницы выведет его. В противном случае выведет текст страницы. | |
| DESCRIPTION_OR_TEXT_CUT |
При наличии описания страницы выведет его. В противном случае выведет обрезанный текст страницы. | |
| MORE | Ссылка с анкором "Читать дальше" и адресом страницы | |
| AUTHOR | page_author | Автор публикации (не владелец) |
| OWNER_ID |
page_ownerid | ID владельца страницы |
| OWNER_NAME |
Имя владельца страницы | |
| DATE | page_date | Дата создания страницы |
| BEGIN | page_begin | Дата начала публикации страницы |
| EXPIRE | page_expire | Дата окончания публикации страницы |
| UPDATED | page_updated | Дата обновления страницы |
| DATE_STAMP | Дата создания страницы в формате UNIX Timestamp | |
| BEGIN_STAMP | Дата начала публикации страницы в формате UNIX Timestamp | |
| EXPIRE_STAMP | Дата окончания публикации страницы в формате UNIX Timestamp | |
| UPDATED_STAMP | Дата обновления страницы в формате UNIX Timestamp | |
| FILE | Флажок наличия файла | |
| FILE_URL | Ссылка загрузки файла | |
| FILE_SIZE | Размер файла в кБ | |
| FILE_SIZE_BYTES | page_size | Размер файла в байтах |
| FILE_SIZE_READABLE | Человекопонятный размер файла (результат выполнения функции cot_build_filesize()) | |
| FILE_ICON | page_fileicon | Иконка файла |
| FILE_DOWNLOADS |
page_filecount | Количество скачиваний файла |
| FILE_DOWNLOAD_TIMES |
Количество скачиваний файла, обработанное функцией cot_declension() | |
| FILE_NAME | Имя файла | |
| HITS |
Количество просмотров страницы | |
| NOT_AVAILABLE |
Если дата публикации превышает текущую, выведет сообщение "Страница будет опубликована через ..." |
Кроме "штатных" полей функция cot_generate_pagetags() генерит TPL-теги для все созданных вами экстраполей. Например, если вы создали экстраполе version, будут доступны следующие теги:
| TPL-тег | Имя поля в таблице | Описание |
|---|---|---|
| VERSION | page_version | Значение экстраполя или (при наличии соответствующей lang-строки) его локализованное значение Подробно о локализации значений экстраполей |
| VERSION_TITLE | Наименование экстраполя | |
| VERSION_VALUE | page_version | Всегда "чистое" значение экстраполя |
В дополнение к этому формируются и TPL-теги для экстраполей элемента структуры страницы. Например, если в структуре страниц создано экстраполе minidesc, будут доступны следующие теги:
| TPL-тег | Имя поля в таблице | Описание |
|---|---|---|
| CAT_MINIDESC | structure_minidesc | Значение экстраполя или (при наличии соответствующей lang-строки) его локализованное значение Подробно о локализации значений экстраполей |
| CAT_MINIDESC_TITLE | Наименование экстраполя | |
| CAT_MINIDESC_VALUE | structure_minidesc | Всегда "чистое" значение экстраполя |
И это еще не все. При наличии прав администратора, вы получите доступ к следующим TPL-тегам:
| TPL-тег | Имя поля в таблице | Описание |
|---|---|---|
| ADMIN_EDIT | Готовая ссылка на форму редактирования страницы | |
| ADMIN_EDIT_URL | URL ссылки для редактирования страницы | |
| ADMIN_UNVALIDATE | Переключающаяся в зависимости от статуса страницы ссылка либо на утверждение страницы, либо на снятие ее с публикации (с подтверждением) | |
| ADMIN_UNVALIDATE_URL | Переключающийся в зависимости от статуса страницы URL либо на утверждение страницы, либо на снятие ее с публикации (с подтверждением) | |
| ADMIN_DELETE | Готовая ссылка для удаления страницы (с подтверждением) | |
| ADMIN_DELETE_URL | URL для удаления страницы (с подтверждением) |
Для владельца страницы доступны следующие TPL-теги:
| TPL-тег | Имя поля в таблице | Описание |
|---|---|---|
| ADMIN_EDIT | Готовая ссылка на форму редактирования страницы | |
| ADMIN_EDIT_URL | URL ссылки для редактирования страницы |
При наличии прав записи в любой раздел модуля Page будут доступны следующие TPL-теги:
| TPL-тег | Имя поля в таблице | Описание |
|---|---|---|
| ADMIN_CLONE | Готовая ссылка для дублирования (клонирования) страницы | |
| ADMIN_CLONE_URL | URL ссылки для дублирования (клонирования) страницы |
Новый комментарий