In-Portal Developers Guide

This is a wiki-based Developers Guide for In-Portal Open Source CMS. The purpose of this guide is to provide advanced users, web developers and programmers with documentation on how to expand, customize and improve the functionality and the code the In-Portal software. Please consider contributing to our documentation writing effort.

K4:Работа с блоком "combined header"

From In-Portal Developers Guide

Jump to: navigation, search

Alex (Talk)
(категория)
Next diff →

Revision as of 13:44, 25 December 2008

Работа с шаблонами и блоками Работа с шаблонами и блоками
Статьи в этой категории

Блок combined_header используется для формирования заголовка шаблонов, напр. форм редактирования и выполняет следующие функции:

  • проверка права доступа к операциям над элементами (view, add, edit, delete);
  • подключение шаблона с описанием вкладок (tabs);
  • подключение элемента, показывающего номера страниц (pagination);
  • установку заголовка окна (title).

Contents

Обрабатываемые параметры

параметр описание
pagination (int) Параметр указывает на необходимость выведения нумерации страниц в bluebar. Используется только на списках. Не работает на списках подчинённых префиксов.
perm_section (string) Параметр PermSection из конфигa отображаемого элемента или списка элементов, идентифицирует секцию, чтобы можно было применить к ней систему прав доступа. Будет определён автоматически, если параметр не передан.
permission_type (string) Параметр указывает на то, какие права необходимы для получения доступа (view, add, edit, delete). Если параметр не передан, по умолчанию проверяется право view.
prefix (string) * Префикс отображаемого элемента или списка элементов. В качестве значения данного параметра для подчинённых префиксов необходимо использовать префикс главного.
grid (string) Название списка, который показывается на шаблоне (т.е. название ключа в опции Grids в unit config). Применяется только на шаблонах со списком.
section (string) * Используемая секция, которой принадлежит элемент или список элементов. Используется для отображения пиктограмм и названия раздела над списком элементов, а так же для проверки прав доступа.
tabs (string) Параметр указывает на необходимость подключить шаблон вкладок (переданное значение - название и путь к шаблону).
tab_preset (string) В конфиге используемого префикса (ключ EditTabPresets) можно указать несколько наборов предопределённых вкладок, с помощью этого параметра можно указать какой из наборов надо использовать.
title_preset (string) Указывает на то, какой из заголовков, описанных в конфиге, необходимо использовать в bluebar.
Image:Tipbox Icon.gif * - параметр обязателен.

Шаблоны вкладок

Шаблоны вкладок задаются при помощи опции EditTabPresets в unit config: 

'EditTabPresets' => Array (
	'Default' => Array (
		Array ('title' => 'la_tab_General', 't' => 'in-portal/users/users_edit',        'priority' => 1),
		Array ('title' => 'la_tab_Groups',  't' => 'in-portal/users/users_edit_groups', 'priority' => 2),
		Array ('title' => 'la_tab_Images',  't' => 'in-portal/users/user_edit_images',  'priority' => 3),
		Array ('title' => 'la_tab_Custom',  't' => 'in-portal/users/users_edit_custom', 'priority' => 4),
	),
	'Custom' => Array (
		...
	),
	'Test' => Array (
		...
	),
	...
),

Именно значение одного из ключей верхнего уровня требуется указывать в качестве значения параметра tab_preset блоку "combined_header". Как видно из выше приведённого примере описание самого tab preset является массивом, в каждый элемент которого описывает одну вкладку:

название описание
title Фраза, перевод которой будет показан в качестве названия вкладки в браузере.
t Путь к шаблону, содержащему тело вкладки.
priority Порядок вкладки относительно остальных вкладок данного tab preset.

Использование

На списке

Результат использования тэга combined_header на списке
Результат использования тэга combined_header на списке
<inp2:m_include t="incs/header" />
<inp2:m_RenderElement name="combined_header" section="custom:tracking" prefix="tracking" pagination="1" />


На форме редактирования

Результат использования тэга combined_header на странице редактирования
Результат использования тэга combined_header на странице редактирования
<inp2:m_include t="incs/header"/>
<inp2:m_RenderElement name="combined_header" section="custom:tracking" prefix="tracking" title_preset="tracking_edit"/>


В обоих примерах можно видеть действие параметра title_preset (надпись на синем фоне), а так же параметра section - с его помощью во время обработки тэга можно определить значение некоторых параметров, если они не были переданы. К таким относятся prefix и prem_section. Так же с помощью параметра section определяется необходимая пиктограмма и название родительской секции, в которой находится данная секция.

Retrieved from "http://guide.in-portal.org/eng/index.php/K4:%D0%A0%D0%B0%D0%B1%D0%BE%D1%82%D0%B0_%D1%81_%D0%B1%D0%BB%D0%BE%D0%BA%D0%BE%D0%BC_%22combined_header%22"