$params — параметры шаблона

Параметры шаблона применяются при нестандартном выводе или редактировании данных. Эти параметры указываются в дескрипторе шаблона и задаются с помощью массива $params. Ниже приведены все возможные параметры. Имеются также параметры, относящиеся только к полям. Эти параметры выведены в отдельный массив $fields.


# Номер поля для управления скрытием записей 
$params['hiding-field'] = 1;

# Данный параметр необходимо применять, когда необходимо поместить кнопку редактирования внутрь
# какого-то элемента <a>. По умолчанию кнопка редактирования сама также сделана на основе <a>, 
# и в таком виде ее нельзя туда вкладывать внутрь другого элемента <a>. После же применения
# данного параметра, кнопка редактирования будет выведена в виде элемента <span>, а окно будет
# открываться благодаря Javascript. У этого режима есть один минус — если редактируемый блок
# подгружается методом ajax, то его кнопка редактирования перестанет работать. 
# Чтобы она начала работать, нужно заново подгружать файл BLOX/assets/blox.public.js.
$params['span-edit-buttons'] = true;

# Абсолютное позиционирование кнопки редактирования с возможностью регулировки смещения 
$params['edit-button-style'] = true;

# Заголовок шаблона
# Применяется в качестве заголовка окна редактирования
$params['heading'] = '';

# Версия шаблона
# При использовании комплекта шаблонов или шаблонов в подпапках
# рекомендуется помещать версию в головном шаблоне.
$params['version'] = '1.0.22';

# Краткое описание шаблона
$params['description'] = '';

# Тип шаблонизатора, отличного от типа, заданного в конфигурации сайта index.php 
$params['templater'] = 'PHP'; // PHP, Smarty, Twig

# Отмена серверного кэширования страницы, содержащей данный шаблон, 
# если кэширование задано в конфигурации сайта index.php 
$params['nocaching'] = true;

# Отмена браузерного кэширования страницы, содержащей данный шаблон.
# Применяется, например, если содержимое страницы зависит от значения хэша в URL.
$params['nocache'] = true;

# Не показывать главную панель управления на страницах с этим шаблоном
$params['no-bar'] = true;

# Не показывать панель в окне редактирования на страницах с этим шаблоном
$params['no-edit-bar'] = true;

# Не показывать в окне редактирования кнопки для быстрого доступа: 
# "Основные данные", "Экстраданные", "Сортировка", "Удаление".
$params['dont-output-multirec-buttons'] = true;

# Этот блок может служить контейнером (destination) для кода вставляемого методом Ajax 
$params['dst'] = true;

# Запрет индексирования содержимого блока в случае его делегирования.
# Осуществляется путем добавления тега noindex (действует только для Яндекса).
$params['no-index-if-delegated'] = true;

# Выборочное использование файлов шаблона 
$params['template-files'] = ['tdd','tpl','css','js'];

# Запускать tdd-файл только один раз на все блоки с данным шаблоном.
# Рекомендуется применять если в tdd-файле не используются данные для конкретного блока.
$params['run-tdd-once'] = true;

# Номер поля, который будет в фокусе при открытии окна редактирования, 
# чтобы в этом поле можно было сразу набирать текст.
$params['autofocus-field'] = 1;

Применяются только для многозаписных шаблонов


# Многозаписный шаблон
$params['multi-record'] = true;

# Поле для идентификатора пользователя 
$params['user-id-field'] = 5;

# Отображение записей в обратном порядке 
$params['backward'] = true;


#_______________________________ Пагинация (part) _______________________________

# Ограничение на показ записей 
$params['part']['limit'] = 40;

# Автоматический показ следующей части при выводе блока 
$params['part']['autoincrement'] = true;
# В первый раз будет показана случайная часть
$params['part']['autoincrement'] = 'random'; 

# Задать убывающую нумерацию частей 
$params['part']['numbering'] = 'desc';

# Перераспределить записи из последней части в предшествующих двух частях 
$params['part']['redistribution'] = 2;


#___________________________ Условная выборка (pick) ___________________________

# Ключевые поля pick-запросов 
$params['pick']['key-fields'] = [2, 5];

# Сделать pick-запросы регистрозависимыми 
$params['pick']['case-sensitive'] = true;

#________________________________ Поиск (search) ________________________________

# Поиск будет производиться только в начале слов текста 
$params['search']['where'] = 'beginnings';

# Поиск будет производиться только в начале всего текста
$params['search']['where'] = 'start';

# Поиск по нескольким полям с помощью одного поискового запроса 
$params['search']['fields'] = [1,2];

# Выделять найденные поисковые слова 
$params['search']['highlight'] = true;

# Сделать search-запросы регистрозависимыми 
$params['search']['case-sensitive'] = true;

#______________________________ Сортировка (sort) _______________________________

# Порядок сортировки по умолчанию 
$params['sort'][1] = 'asc';  // 'asc' — в порядке нарастания, 1 — номер поля
$params['sort'][2] = 'desc'; // 'desc' — в порядке убывания

# Сделать sort-запросы регистрозависимыми 
$params['sort']['case-sensitive'] = true;

# Выводить поле с сортировочным номером в окне редактирования
$params['sort']['editable'] = true;


#______________________ Выборка одной записи (single) ______________________

# При выборке одной записи (запрос single) не извлекать соседние записи prev и next.
# Применяется для ускорения. 
$params['single']['no-adjacents'] = true;

#_______________________________________________________________________________

# Разрешена подписка на рассылку новостей (последних записей) блока 
$params['subsription'] = true;

# Не генерировать запись, создаваемую специально для кнопки новой записи.
$params['no-new-rec-button'] = true;
# В случае необходимости, кнопку новой записи придется выводить так: 
# echo $dat['edit'] ?: $edit['new-rec']['button'];


Применяются только для посетителей


# Посетителям разрешено создание новых записей 
$params['public'] = [];

# Посетителям разрешено изменение старых записей 
$params['public']['editing-allowed'] = true;

# Посетитель видит кнопки редактирования собственных свежих записей 
$params['public']['show-fresh-recs-edit-buttons'] = true;

# Посетитель видит кнопку новой записи 
$params['public']['show-new-rec-edit-button'] = true;

Применяются только для редакторов собственных записей (авторов)


# Запретить автору создание в блоке более одной записи
$params['editor-of-records']['only-one-rec-allowed'] = true;

# Не показывать автору главную панель управления и панель окна редактирования
$params['editor-of-records']['no-bar'] = true;

# Скрытие полей в окне редактирования для авторов
$params['editor-of-records']['secred-fields'] = [2, 5]; // Не реализовано!

# Запретить редакторам собственных записей (авторам) редактировать свои старые записи 
$params['editor-of-records']['forbid-old-recs-editing'] = true;

См. также