В этом приложении приведено подробное описание всех переменных и функций.

    %Footer
    Доступность: хедер и футер макета дизайна
    Макропеременная содержит текст футера родительского макета. Если текущий макет -корневой, значение макропеременной будет пустым. Используется в случаях, когда необходимо вывести футер родительского раздела, добавив что-либо до или после него.
    Пример использования
    Необходимо модифицировать родительский макет, введя еще одну колонку таблицы, выводимую справа от содержательной части страницы и содержащую новости. Текст футера макета:

</td><td valign='top'>".s_list_class(1,2,""),” %Footer

    %Header
    Доступность: хедер и футер макета дизайна
    Макропеременная содержит текст хедера родительского макета. Назначение аналогично макропемеренной %Footer.

    %АтрибутСайтаИлиРаздела
    Доступность: шаблоны вывода навигации макета дизайна
    Используется для генерации HTML-текст навигационных элементов по сайту.Так, элемент навигации «Путь до текущей страницы» (s_browse_path($browse_path)) может иметь такие настройки:

$browse_path[prefix] = ""; $browse_path[active] = "%NAME"; $browse_path[active_link] = "%NAME"; $browse_path[unactive] = "<a href=%URL>%NAME</a>"; $browse_path[divider] = " / "; $browse_path[suffix] = "";

    Макропеременная %URL обозначает ссылку на сайт/раздел/компонент раздела, который соответствует названию. Другие доступные значения:
    %NAME – название
    %PARENT_SUB – номер родительского раздела (только для разделов)
    %KEYWORD – ключевое слово раздела (только для разделов)
    %SUB – номер раздела (только для разделов)
    %COUNTER – номер выводимого элемента в списке (начиная с нуля)
    Пример использования
    Учитывая, что все шаблоны навигации активизируются при помощи функции eval(), при необходимости Вы можете встраивать в эти шаблоны различные функции. Например, шаблон навигации для отображения разделов и подразделов будет выглядеть следующим образом:
    Шаблон навигации второго уровня:

$browse_sub[1][prefix] = "<font size=-2>"; $browse_ sub[1][active] = "<li><b><a href=%URL>%NAME</a></b>"; $browse_ sub[1][active_link] = "<li><b>%NAME</b>"; $browse_ sub[1][unactive] = "<li><a href=%URL>%NAME</a>"; $browse_ sub[1][divider] = ""; $browse_ sub[1][suffix] = "</font>";

    Шаблон навигации первого уровня:

$isub1 = “\”.s_browse_sub(\$data[\$i][Subdivision_ID],\$browse_sub[1]).\””; $browse_sub[0][prefix] = "\”;global \$browse_sub;\$result.=\”"; $browse_ sub[0][active] = "<li><b><a href=%URL>%NAME</a></b>".$isub1; $browse_ sub[0][active_link] = "<li><b>%NAME</b>".$isub1; $browse_ sub[0][unactive] = "<li><a href=%URL>%NAME</a>".$isub1; $browse_ sub[0][divider] = ""; $browse_ sub[0][suffix] = "</font>";

    Таким образом, после каждого элемента меню (раздела) первого уровня вызывается функция отображения его подразделов.

    %ПолеМакета
    Доступность: хедер и футер макета дизайна
    Если таблица Template (в ней хранятся тексты макетов дизайна) содержит дополнительные поля, в хедере и футере макета доступны переменные %ПолеМакета, где ПолеМакета – название поля в таблице MySQL. Управление дополнительными полями (добавление, удаление, изменение свойств) производится на странице «Системные таблицы» системы администрирования.
    Пример использования
    Необходимо вывести в хедере содержимое поля «Таблица CSS» (в базе данных поле имеет название CSS). Фрагмент текста хедера:

... <style><!— %CSS_Table --></style> ...

    $admin_mode
    Доступность: макеты и компоненты
    Логическая переменная. Истина, если страница выводится в режиме администрирования, и наоборот.
    Пример использования
    В режиме администрирования для каждого объекта на странице (например, в гостевой книге) необходимо показать IP-адрес добавившего объект. Фрагмент шаблона вывода объекта в списке компонента:

$f_Name “.opt($admin_mode, “(IP: $f_IP)”).” пишет: $f_Text

    $begRow
    Доступность: шаблоны вывода компонента
    Порядковый номер объекта, с которого начинается вывод списка объектов на текущей странице. Нумерация начинается с первого объекта на первой странице. Таким образом, если объекты какого-либо компонента выводятся по 15 штук на странице, на второй странице листинга значение $begRow будет равно 16.
    Пример использования
    Необходимо в суффиксе вывода списка новостей отобразить номера объектов, выводимых на странице. Фрагмент суффикса вывода списка объектов компонента:
    На странице показаны новости $begRow - $endRow

    $catalogue
    Доступность: везде
    Номер текущего сайта. Переменной присваивается значение поля Catalogue_ID таблицы Catalogue, соответствующее текущему сайту.
    Пример использования
    В макете дизайна, который используется сразу на нескольких сайтах, необходимо ставить ссылку на основной сайт, кроме, разумеется, страниц самого основного сайта. Фрагмент хедера макета:

".opt($catalogue!=1, "Посетите наш <a href=http://www.site.ru>основной сайт</a>!")."

    $cc
    Доступность: везде
    Номер (ID) текущего компонента раздела. Переменной присваивается значение поля Sub_Class_ID таблицы Sub_Class, соответствующей текущему компоненту раздела.
    Пример использования
    На странице необходимо вывести ссылку на ту же страницу в редиме администрирования. Фрагмент хедера/футера макета или суффикса/префикса компонента:

<a href=/netcat/?action=index&sub=$sub&cc=$cc>Редактировать эту страницу</a> (только для модераторов!)

    $cc_array[]
    Доступность: везде
    Массив индексов (номеров) компонентов текущего раздела, отсортированных по приоритету. Нулевой элемент ($cc_array[0]) – компонент с наименьшим приоритетом.
    Пример использования
    Предположим, что для текущего раздела компоненты выводятся не списком на одной странице, а каждый в отдельной «закладке» (см. настройки раздела). Один из компонентов раздела – основной, например, «оглавление раздела», в тексте которого нужно вывести ссылки на все компоненты раздела. Фрагмент системных настроек компонента:

$links=""; for_each($some_cc=$cc_array) { if ($cc !=$some_cc) $links .= listQuery("select Sub_Class_Name, EnglishName from Sub_Class where Sub_Class_ID=$some_cc", “<a href=$subLink\$data[EnglishName].html>\$data[Sub_Class_Name]</a> "); }

    Переменная $links будет доступна в любых полях вывода компонента.

    $ccLink
    Доступность: шаблоны вывода объектов компонента
    Переменная содержит путь к текущему компоненту раздела вида «/about/pr/news.html.
    Пример использования
    Необходимо вывести ссылку на постоянный адрес страницы этого компонента раздела. Фрагмент суффикса/префикса шаблона вывода компонента:
    Постоянный адрес этой страницы: $ccLink

    $current_catalogue[], $current_sub[], $current_сс[], $current_user[] (хэш-массивы)
    Доступность: везде
    Содержат значения свойств текущего каталога, раздела, компонента раздела соответственно, и текущего авторизованного пользователя. Индекс массива должен соответствовать запрашиваемому полю таблицы, например, $current_sub[Subdivision_Name].
    Массив $current_user[] может быть установлен только для авторизованного пользователя, он доступен только при наличии установленного модуля «Интерфейс пользователя». Без этого модуля Вы можете узнать ID авторизованного пользователя через переменную $AUTH_USER_ID (при ее отсутствии необходимо сделать ее global).
    Пример использования
    В таблице «Разделы» (Subdivision) при помощи страницы «Системные таблицы» добавлено поле MetaKeywords, куда прописываются ключевые слова( значения мета-тегов Keywords) страницы. Если для какого-то раздела ключевые слоа не прописаны, используются стандартные ключевые слова «рога, копыта, стерилизация». Фрагмент хедера макета дизайна:

<meta name=keywords content='".opt_case($current_sub[MetaKeywords], $current_sub[MetaKeywords], "рога, копыта, стерилизация")."'>

    $endRow
    Доступность: шаблоны вывода компонента
    Порядковый номер объекта, с которого начинается вывод списка объектов на текущей странице. Нумерация начинается с первого объекта на первой странице.
    Пример использования: см. $begRow

    $f_AdminButtons
    Доступность: шаблоны вывода объекта в списке и объекта на одной странице компонента
    В режиме администрирования содержит блок статусной информации об объекте и ссылки на действия для данного объекта «изменить», «удалить», «включить/выключить» (только в поле «Объект в списке»). Если в шаблоне вывода объекта в списке или объекта на одной странице эта переменная указана не будет, вы не сможете изменить или удалить объекты этого компонента стандартными средствами системы.
    Пример использования
    Для каждого объекта компонента в режиме администрирования выводить блок статусной информации и ссылки на действия для объекта. Фрагмент шаблона вывода объекта в списке:

Имя: $f_Name $f_AdminButtons<br> Фамилия: $f_LastName

    $f_AdminCommon
    Доступность: шаблоны вывода компонента
    В режиме администрирования содержит блок статусной информации о компоненте раздела и ссылку на добавление объекта в данный компонент раздела и удаление всех объектов из этого же компонента (только в поле «Объект в списке»).
    Пример использования
    Необходимо в режиме администрирования вывести соответствующий блок перед содержимым компонента раздела. Начало префикса списка объектов:

$f_AdminCommon <table...>

    $f_Checked
    Доступность: шаблон вывода объекта в списке и шаблон вывода объекта на одной странице
    Истина, если объект включен, и наоборот.
    Пример использования
    В режиме редактирования необходимо ясно обратить внимание модератора на выключенные объекты. Фрагмент шаблона вывода объекта в списке:

".opt($f_Checked, "<font color=red size=+2>объект выключен!!</a>")."

    $f_Created
    Доступность: шаблон вывода объекта в списке и шаблон вывода объекта на одной странице
    Дата и время создания (добавления) объекта в формате “гггг-мм-дд чч:мм:сс”. Помимо полного формата вывода даты и времени доступны переменные $f_Created_year, $f_Created_month, $f_Created_day, $f_Created_hours,$f_Created_minutes, $f_Created_seconds, содержащие соответственно год, месяц, день, час, минуту и секунду добавления объекта.
    Пример использования
    В компоненте “Вакансии” необходимо выводить дату и время создания вакансии в удобной формате. Фрагмент шаблоны вывода объекта в списке:

Вакансия добавлена $f_Created_day.$f_Created_month.$f_Created_year в $f_Created_hours:$f_Created_minutes

    $f_IP
    Доступность: шаблон вывода объекта в списке и шаблон вывода объекта на одной странице IP посетителя, добавившего этот объект.
    Пример использования
    Вывести IP посетителя, добавившего объект. Фрагмент шаблоны полного вывода объекта:

IP: $f_IP

    $f_LastIP
    Доступность: шаблон вывода объекта в списке и шаблон вывода объекта на одной странице
    IP посетителя, последним изменившего этот объект.
    Пример использования: аналогично $f_IP

    $f_LastUpdated
    Доступность: шаблон вывода объекта в списке и шаблон вывода объекта на одной странице
    Дата и время последнего изменения этого объекта.
    Пример использования: аналогично $f_IP

    $f_LastUserAgent
    Доступность: шаблон вывода объекта в списке и шаблон вывода объекта на одной странице
    Содержимое переменной окружения HTTP_USER_AGENT пользователя, последним изменившего этот объект.
    Пример использования: аналогично $f_IP

    $f_LastUserID
    Доступность: шаблон вывода объекта в списке и шаблон вывода объекта на одной странице
    Номер (ID) пользователя, последним изменившего этот объект.
    Пример использования: аналогично $f_IP

    $f_RowID
    Доступность: шаблон вывода объекта в списке и шаблон вывода объекта на одной странице
    Номер (ID) объекта в таблице MySQL.
    Пример использования: аналогично $f_IP

    $f_RowNum
    Доступность: шаблон вывода объекта в списке
    Порядковый номер объекта на странице. Нумерация начинается с первого объекта, отображенного на странице.
    Пример использования: аналогично $f_IP

    $f_title
    Доступность: макет дизайна
    Заголовок текущей страницы. Выводит название текущего раздела за исключением случая, когда текущая страница представляет собой вывод одного объекта на странице и поле «Заголовок страницы» данного компонента определено.
    Пример использования
    Вывести заголовок страницы в макете. Фрагмент хедера страницы:

$f_title

    $f_UserID
    Доступность: шаблон вывода объекта в списке и шаблон вывода объекта на одной странице
    Номер (ID) пользователя, добавившего этот объект.
    Пример использования: аналогично $f_IP

    $f_UserAgent
    Доступность: шаблон вывода объекта в списке и шаблон вывода объекта на одной странице
    Содержимое переменной окружения HTTP_USER_AGENT пользователя, добавившего этот объект.
    Пример использования: аналогично $f_IP

    $f_ИмяПоля
    Доступность: шаблон вывода объекта в списке и шаблон вывода объекта на одной странице
    Выводит значение поля с названием “ИмяПоля” данного объекта. Например, если поле “Фамилия” имеет имя LastName, вывести фамилию для текущего объекта можно переменной $f_LastName.
    Для разных типов полей доступны также следующие варианты суффиксов:
    • Дата и время: $f_ИмяПоля_year, $f_ИмяПоля_month и т.д. - аналогично переменной $f_Created
    • $f_ИМЯПОЛЯ_name, $f_ИМЯПОЛЯ_type, $f_ИМЯПОЛЯ_size переменные, содержащие соответственно оригинальное имя закачанного файла, его тип (mime type) и размер в байтах. При этом переменная $f_ИМЯПОЛЯ содержит путь к файлу на сервере. Только для полей типа «Файл»
    • $f_ИМЯПОЛЯ_id содержит ID элемента типа «Список». При этому $f_ИМЯПОЛЯ содержит его название.
    Пример использования: аналогично $f_IP

    $fullDateLink
    Доступность: шаблон вывода объекта в списке и шаблон вывода объекта на одной странице
    Ссылка на страницу с полным выводом объекта в виде «…/2002/02/02/message_2.html» (устанавливается в случае если в компоненте имеется поле типа «Дата и время» с форматом «event», иначе значение переменной идентично значению $fullLink).
    Пример использования
    В списке новостей около анонса каждой новости выводить ссылку «подробнее» на полный текст страницы. Фрагмент шаблона вывода объекта в списке:

$f_Anons // <a href=$fullDateLink>подробнее</a>

    $fullLink
    Доступность: шаблон вывода объекта в списке и шаблон вывода объекта на одной странице
    Ссылка на страницу с полным выводом объекта. Ссылка формируется в «человеко-понятном» формате:
    /URLРаздела/КлючСловоКомпонентаРаздела_КлючСловоОбъекта.html или
    /URLРаздела/КлючСловоОбъекта.html, например, /about/team/ivanov.html
    Пример использования: аналогично $fulldateLink

    $MODULE_VARS[КлючевоеСловоМодуля][ИмяПеременной]
    Массив содержит значения переменных настроек модулей.
    Пример использования
    В компоненте “результаты поиска” необходимо указать все сайты, индексируемые поисковым роботом NetCat. Фрагмент суффикса списка объектов:
    Внимание!
    Поиск ведется на сайтах:". $MODULE_VARS[search][ALLOWED_URLS]."

    $nextLink
    Доступность: поля шаблона вывода объектов компонента Переменная содержит ссылку на следующую страницу в листинге компонента (если текущее положение в списке – его конец, то переменная пустая).
    Пример использования
    После вывода списка объектов необходимо вывести ссылку на следующую страницу. Фрагмент суффикса списка объектов:

".opt($nextLink, "<a href=$nextLink>далее</a>")."

    $parent_sub_tree[]
    Доступность: макеты дизайна, компоненты
    Массивы свойств раздела различных уровней вложенности в реверсивном порядке (от текущего раздела $parent_sub_tree[0] до свойств головного сайта $parent_sub_tree[$sub_level_count-1]).
    Пример использования
    Идентификатор текущего раздела - $parent_sub_tree [0][Subdivision_ID]
    Идентификатор родительского раздела - $parent_sub_tree [1][Subdivision_ID]

    $prevLink
    Доступность: поля шаблона вывода объектов компонента
    Переменная содержит ссылку на следующую страницу в листинге компонента (если текущее положение в списке – его конец, то переменная пустая).
    Пример использования: аналогично $nextLink

    $recNum
    Доступность: поля шаблона вывода объектов компонента
    Максимальное количество объектов для вывода. Переменную можно подать в адресной строке (/news/?recNum=3), в функции s_list_class(), в системных настройках компонента.
    Пример использования
    На титульной странице сайта необходимо вывести 3 последних новости. Раздел “Новости” имеет ID 1, нужный компонент раздела “Новости”- ID 2. Фрагмент футера или хедера макета титульной страницы:

    ".s_list_class(1, 2, "&recNum=3")."

    $sub
    Доступность: везде
    Номер (ID) текущего раздела.
    Пример использования: см. $cc

    $sub_level_count
    Доступность: макеты дизайна
    Переменная содержит текущий уровень вложенности навигации.
    Пример использования
    Уровень вложенности от корня сайта - $sub_level_count

    $subHost
    Доступность: везде
    Переменная содержит текущий хост (домен) вида «www.company.ru».

    $subLink
    Доступность: везде
    Переменная содержит URI текущего раздела вида «/about/news/».

    $totRows
    Доступность: поля редактирования шаблонов вывода компонента
    Содержит общее количество объектов данного компонента раздела.
    Пример использования
    Необходимо вывести общее количество объектов компонента раздела (например, вакансий). Фрагмент префикса шаблона вывода списка объектов:
    Всего вакансий в базе: $totRows.