Документация по модулю BlockPro

Дефолтный префикс кеша, нужен для автоматической чистки кеша при добавлении на сайте комментария или новости.

Автоматически удаляется, если задано время жизни кеша.

Отключение суффикса кеша (будет создаваться один кеш-файл для всех пользователей).

По умолчанию для каждой группы пользователей создаётся свой кеш (на случай разного отображения контента разным юзерам). Если для всех групп пользователей контент одинаков - можно отключить.

Имена и значения допполей для фильтрации новостей по допполям с указанными значениями.

синтаксис передачи данных: &xfSearch=имя_поля|значение||имя_поля|значение

Имена и значения допполей для игнорирования показа новостей по допполям с указанными значениями.

синтаксис передачи данных: ¬XfSearch=имя_поля|значение||имя_поля|значение

Логика фильтрации по значениям допполей: "И" - совпадение нескольких значений; "ИЛИ" - совпадение любого из значений

Принимает OR или AND.

Сортировка новостей в блоке, по умолчанию аналогична выводу ТОП-новостей.

Возможные значения:

по умолчанию - стандартный для DLE топ новостей

none - без сортировки (можно использовать для вывода похожих новостей идентично стандартному выводу таковых в DLE)

date - по дате добавления

rating - по рейтингу

comms - по количеству комментариев

views - по количеству просмотров

random - в случайном порядке

randomLight - в случайном порядке (Light) Предназначен для больших БД и органиченной выборки (с фильтрацией категорий, id новостей, допполей и т.п.)

title - в алфавитном порядке

hit - Хит. Новости отбираются по формуле: (рейтинг*100 + кол-во комментариев*10 + кол-во просмотров)

download - по количеству скачиваний файлов новости

symbol - по символьному коду новости

editdate - по дате редактирования новости

xf|fielname - по значению дополнительного поля, где fielname — название дополнительного поля.
Пример строки подключения {include file="engine/modules/base/blockpro.php?xfilter=price&sort=xf|price&order=new"}xfilter=price - для отбрасывания пустых значений.

symbol - по символьному коду.

p.custom_field - по нестандартному полю БД.
Пример: &sort=p.custom_field — поле custom_field из таблицы dle_post
&sort=e.price — поле price из таблицы dle_post_extras.

old - новые в начале

old - старые в начале

asis - как есть. Выводит новости в том порядке, в котором они указаны в строке подключения. На данный момент она распространяется только на ID новостей.

Записывать в БД похожие новости.

При первом обращении к старнице в БД будут записаны id выведенных похожих новостей, используя стандартный алгоритм DLE, при повторных обращениях (при отсутсвии кеша) данные будут браться из ранее записанных. Если нужно выводить и стандартные похожие новости и похожие новости через модуль — эту переменную использовать не нужно.

Включить постраничную навигацию в блоке

Текущая страница в блоке при загрузке страницы, при постраничной конфигурации.

Стиль постраничной навигации.

Возможны следующие стили:

classic: << Первая < 1 [2] 3 > Последняя >>

digg: << Назад 1 2 ... 5 6 7 8 9 [10] 11 12 13 14 ... 25 26 Вперёд >>

extended: << Назад | Страница 2 из 11 | Показаны новости 6-10 из 52 | Вперёд >>

punbb: 1 ... 4 5 [6] 7 8 ... 15

arrows: << Назад Вперёд >>

Отслеживать стандартную навигацию DLE

При указании этого параметра модуль будет брать значение текущей страницы и формировать постраничную навигацию так же как это делается в DLE. Таким образом вы можете заменить тег {content} на строку подключения модуля в списках новостей, или просто организовать постраничную навигацию с перезагрузкой страницы.

Колонки, добавляемые в запрос на получение новостей

Префикс p. — колонка из таблицы dle_post, a e. — из таблицы dle_post_extras. Таким образом можно выводить данные из новостей даже если в БД DLE вносились дополнения.

Собственная фильтрация данных

Параметр предназначен для создания собственных условий фильтрации.
Корректность передачи данных не проверяется, будьте внимательнее при построении условий фильтрации.

Передавать каждый параметр фильтрации следует тремя частями разделяя их вертикальной чертой |.
Где:
первая часть — поле из БД,
вторая — оператор (см. ниже),
третья — значение.
При этом параметры дуг от друга следует отделять двойной вертикальной чертой ||

Т.к. DLE, в целях безопасности, не позволяет передавать напрямую символы '>' и '<' через строку подключения, было принято решение использовать следующий порядок передачи операторов:
gt или + — >
lt или - — <
eq или = — =
gte или += — >=
lte или -= — <=
not или -+ или +- — !=
SEARCH — LIKE new
NOT_SEARCH — NOT LIKE new

Таким образом переданная строка
p.comm_num|gt|100||e.news_read|lt|500
превратится в часть запроса:
p.comm_num > 100 AND e.news_read < 500

new Если третья часть параметра будет указана как NOW(), то будет подставлен текущий timestamp.

Примеры:
&setFilter=YEAR(p.date)|eq|2016 — новости, опубликованные в 2016 году.
&setFilter=p.event_start|gte|NOW() — новости, у которых дата начала события (нестандартное поле) больше или равна текущему моменту времени.
&setFilter=p.title|SEARCH|Добро пожаловать — новости, в заголовке которых содержится словосочетание "Добро пожаловать".
&setFilter=p.title|NOT_SEARCH|Добро пожаловать — новости у которых в заголовке нет текста "Добро пожаловать".

Включает экспериментальные функции модуля. Этот параметр включает улучшенные, но не оттестированные до конца, функции модуля.

Ограничение количества символов контента.

Принимает два параметра:

1. Количество символов.
2. Текст, показываемый в конце обрезанной строки.

Применение:

Получение изображения из контента.

image — встроенный функционал.

tinypng — получение картинки через сервис tinypng.com

kraken — получение картинки через сервис kraken.io

Принимает следующие параметры:

1. (string) $data — Строка, из которой будем брать картинку/картинки
2. (string) $noimage — Картинка-заглушка
3. (string) $imageType — Тип картинки (small/original/intext) - для получения соответствующей картинки или массива картинок
4. (integer/string) $number — Номер картинки в контенте или all для вывода всех картинок
5. (string) $size — Размер картики (например 100 или 100x150)
6. (string) $quality — Качество картинки (0-100)
7. (string) $resizeType — Тип ресайза (exact, portrait, landscape, auto, crop)
8. (boolean) $grabRemote — Грабить сторонние картинки к себе (true/false)
9. (boolean) $showSmall — Обрабатывать уменьшенную копию, если есть
10. (string) $subdir — Подпапка для картинок (иногда бывает нужно)

Применение:
{$el.short_story|image:$noimage:'small':'1':'':'':'':true:false:'/uploads/myfolder'} {$el.full_story|image:$noimage:'intext':'all':'150x450':'':'landscape':true:false} {$el.full_story|tinypng:$noimage:'small':'1':'150':'':'crop':true:false} {$el.full_story|kraken:$noimage:'small':'1':'150':'':'crop':true:false}

Склонение слова в соответствии с количеством. (например: 1 коментарий, 2 комментария, 100 комментариев)

Применение:
{$el.comm_num|declination:'комментари|й|я|ев'}

Форматирование даты в соответствии с маской (аналог {date="D m Y"})

Применение:
{$el.date|dateformat} {$el.date|dateformat:"d F Y"}

Форматирование даты в формате "time ago". В качестве параметра модификатор принимает цифру от 0 до 6, указывающую точность вывода от года до минут. По умолчанию установлено значение 2.

Например код {$el.date|timeago:6} выведет результат: 2 года, 4 месяца, 1 неделю, 6 дней, 12 часов и 5 минут назад.

Применение:
{$el.date|timeago} {$el.date|timeago:3}

Выводит информацию о категории/категориях новости.

Применение:
Весь массив данных: {$el.category|catinfo}
Название категории: {$el.category|catinfo:'name'}
Ссылка на категорию: {$el.category|catinfo:'link'}
URL категории: {$el.category|catinfo:'url'}
Иконка категории: {$el.category|catinfo:'icon'}
Иконка категории (с заглушкой): {$el.category|catinfo:'icon':$noimage}

Выводит данные через php-функцию print_r. Крайне полезно для отладки во время разработки шаблона.

Применение:
{$el|dump} — выведет распечатку массива новости.

Получает информацию о пользователях, добавивших новости непосредственно в шаблоне.

Применение:
{$arUsers|getAuthors:'email, name, foto'}. Более детальную информацию о процедуре получения пользователей можно увидеть в шаблоне getuserinfo.tpl или в примере.

Модификатор ematch_all является аналогом php-функции preg_match_all. Применяется к любой строке. В качестве параметра принимает регулярное выражение. Возвращает массив с найденными совпадениями или пустой массив.

Пример использования