Разработка:modlibs/nvg — различия между версиями
Ilya (обсуждение | вклад) (Создана страница справки по работе с навигацией) |
Ilya (обсуждение | вклад) (→Подключение скриптов, стилей и добавление мета-тегов) |
||
| Строка 43: | Строка 43: | ||
Параметры: | Параметры: | ||
* $tags - строка с параметрами, которые будут добавлены в тег body. | * $tags - строка с параметрами, которые будут добавлены в тег body. | ||
| + | |||
| + | === is_header_printed() === | ||
| + | Определить, был ли выведен заголовок, или еще нет. | ||
| + | |||
| + | Возвращает true или false, параметров нет. | ||
== Блоки и навигация == | == Блоки и навигация == | ||
Текущая версия на 14:45, 30 сентября 2011
| Плагин | |
| Название | nvg |
| Тип | modlibs |
Содержание
Описание
Плагин отвечает за навигацию и заголовки веб-страницы. Мета-теги, подключение скриптов и стилей, и верхняя навигация - это все находится тут.
Структура папок и блоки
Для управления блоками на страницах в плагине находится папка /cfg/ внутри которой есть (или могут быть) 3 файла
- left.php - содержит блоки, отображаемые слева
- right.php - Блоки, отображаемые справа
- center.php - содержит блоки, по умолчанию отображаемые на главной странице
Пример блока на главной странице:
$blocks[] = array('im'=>'departments','name'=>'main','id'=>1, 'title' => $DOF->get_string('title', 'departments'));
API
add_level()
Добавить уровень навигации. Например Успеваемость > Журнал
- $name, - текст ссылки
- $url, - адрес ссылки
- $addvars - Дополнительные параметры ссылки. По умолчанию NULL.
Подключение скриптов, стилей и добавление мета-тегов
add_meta()
Добавить список мета-тегов в заголовок страницы. Если заголовок уже был выведен - выдает ошибку.
Параметры:
- $meta - массив мета-тегов.
add_scripts()
Добавить список js или css-файлов в заголовок страницы. Если заголовок уже был выведен - то выдает ошибку. Таким образом в заголовок не попадут стили или скрипты которые не будут подключены. Перед тем как выводить заголовок - в списке скриптов и стилей оставляются только уникальные значения, таким образом один и тот же скрипт или стиль не будет подключен два раза.
Параметры:
- $paths - массив путей к js или css-файлам. Функция автоматически создает нужные теги для нужных списков файлов. Можно просто передать одну строку с одним путем к файлу.
add_bodytags()
Добавить дополнительные параметры в тег <body>. Крайне рекомендуется использовать
Параметры:
- $tags - строка с параметрами, которые будут добавлены в тег body.
is_header_printed()
Определить, был ли выведен заголовок, или еще нет.
Возвращает true или false, параметров нет.
Блоки и навигация
print_blocks()
Вывести блоки, которые располагаются слева, справа, или по центру (в зависимости от параметра)
Параметры:
- $side - блоки какой стороны распечатывать. Допустимые значения "left", "right", "center"
print_header()
Вывести заголовок (со всеми служебными тегами, разделом <head> и навигацией)
Параметры:
- $mode - режим отображения. Допустимые значения (задаются константами):
- NVG_MODE_FILE - режим 'без окна' - не печатаем ничего
- NVG_MODE_PRINT - версия для печати
- NVG_MODE_POPUP - всплывающее окно
- NVG_MODE_PORTAL - шапка страницы + блоки слева
- NVG_MODE_PAGE - Только шапка страницы
- $opt - путь к файлу, в котором перечислены дополнительные блоки, которые нужно подключить слева
Вывести подвал.
- $mode - режим отображения. Допустимые значения (задаются константами):
- NVG_MODE_FILE - режим 'без окна' - не печатаем ничего
- NVG_MODE_PRINT - версия для печати
- NVG_MODE_POPUP - всплывающее окно
- NVG_MODE_PORTAL - шапка страницы + блоки слева
- NVG_MODE_PAGE - Только шапка страницы
- $opt - путь к файлу, в котором перечислены дополнительные блоки, которые нужно подключить слева
Режим отображения подвала должен совпадать с режимом отображения шапки.
print_sections()
Вывести на экран список секций с содержимым (выглядят на экране как блоки со скругленными углами)
Параметры:
- $cfg - описание выводимых блоков (array), путь к конфигу с описанием или null по-умолчанию
