Документация по модулю Block.Pro.3

Общая информация о модуле

Бесплатный модуль Block.Pro.3 предназначен для пользовательского вывода новостей на сайте под управлением CMS DLE.

Благодаря гибкости настроек и уникальным возможностям, модуль может использоваться как аналог {custom}, {topnews} и [related-news] вместе взятых!

Особенности Block.Pro.3

• Вывод популярных (топ по комментариям, рейтингу, просмотрам или как стандартный топ в dle), похожих, случайных (с возможностью отключения кеширования блока) или последних новостей.
• Подключение одной строкой в любой шаблон сайта.
• Нет обязательных переменных, достаточно просто подключить модуль
  {include file="engine/modules/blockpro/block.pro.3.php"}
  и выведется топ 10 новостей за всё время.
• Полноценный вывод дополнительных полей.
• Полноценный вывод похожих новостей без правок движка. Можно использовать параллельно со стандартным выводом, можно вывести похожие новости даже на странице кратких новостей или профиля пользователя или в любом другом месте. (добавляется +1 запрос на блок при отсутствии кеша)
• Кеширование каждого блока с возможностью установки времени жизни или отключения кеша для каждого блока.

• Фильтры новостей

  • По авторам
  • По категориям (3.3.1 можно указывать диапазон ID через тире)
  • По новостям (3.3.1 можно указывать диапазон ID через тире)
  • По дополнительным полям (указанные допполя проверяются на заполненность)
  • По тегам новостей 3.3.5

  Все фильтры могут принимать множественные свойства, перечисляемые через запятую. Могут исключать из вывода указанные значения, а так же могут сочетаться исключающие и разрешающие фильтры. (к примеру фильтрация по авторам с логинами username, username2, но за исключением автора с логином username3)

• У модуля собственный класс для работы с картинками.
• Разные методы уменьшения (точный размер, уменьшение по высоте, уменьшение по ширине, "умное" уменьшение, кроп).
• Уменьшенная копия создаётся из полноразмерной картинки, а не thumb или thumb в зависимости от настроек.
• Можно задавать качество создаваемой уменьшенной копии картинки, что дополнительно повышает скорость загрузки страницы.
• Картинку можно брать из допполя, краткой или полной новости. При этом в дополнительном поле кртинка может содержаться в любом виде, а не только в виде прямой ссылки
• Выводится только первая картинка, если попадается смайлик или спойлер - выводится заглушка.
• Выводится уменьшенная и оригинальная картинки, если таковых нет - выводится настраиваемая заглушка.
• Настраиваемая заглушка для отсутствующих иконок (для удобства стилизации картинка имеет class="bp-cat-icon". Загушки настраиваются для уменьшенной и оригинальной картинок)
• Можно выводить картинки, хранящиеся на сторонних сайтах (radikal и т.п.) при этом они не будут уменьшаться, а выведутся как есть в зависимости от настроек они будут так же уменьшаться или выводиться как есть (рекомендую в этом случаи уменьшать такие картинки средствами CSS).
• 3.3 Добавлена защита от кривых рук, когда админ не склеивает зеркала и люди ходят на сайт и с www и без www (картинки в этом случаи показывались только на одном из сайтов (т.к. для модуля (как и для самого движка) сайт с www и без www - разные сайты.(см настройки DLE, там можно указать только один домен). Теперь картинки будут показываться всегда.
• 3.3.3 Вывод аватара автора новости (добавляется +1 запрос на блок при отсутствии кеша)
• 3.3.3 Вывод новостей за заданный интервал времени (к примеру за прошлую неделю).
• Вывод всех иконок категорий, к которым принадлежит новость, а не только первой, как в стандарте DLE.
• Автоматическое создание папок для уменьшенных копий изображений и выставление нужных прав (папки создаются в соответствии с размером уменьшенных картинок, и наименованием месяца и года создания новости), таким образом иерархия папок на сервере становится более понятной и в случаи большого числа изображений не тормозит работу сервера.
• Обрезка заголовка новости до заданного количества символов.
• Обрезка текста новости (до заданного количества символов или до конца слова).
• Все настройки блока вынесены в строку подключения, это уменьшает нагрузку и упрощает настройку.
• Более детальную информацию по возможностям модуля можно найти в таблице сравнения Block.Pro.3 и {custom}.

Установка модуля

1. Распаковать содержимое папки upload/engine из архива в корень сайта. Имейте ввиду, что необходимо предварительно переименовать папку upload/THEME в соответствии с именем вашего шаблона сайта.
2. В нужном месте прописать строку подключения модуля:
   {include file="engine/modules/blockpro/block.pro.3.php"}
3. Настроить дополнительные переменные строки подключения и шаблон. При этом не забывайте про знак вопроса перед первым параметром строки подключения.
4. Для правильного составления строки подключения пользуйтесь генератором

Таблица сравнения Block.Pro.3 и {custom}

Если вы не можете решить, стоит ли использовать модуль Block.Pro.3 или стандартный тег {custom}, то таблица сравнения функционала поможет определиться с выбором.

Проблемные места

• Вывод {title limit="XX"} {short-story limit="XX"} {full-story limit="XX"}. На данный момент ограничение количества символов задаётся через строку подключения, и добавлены теги для вывода необрезанного текста.

Переменные строки подключения

Типичная строка подключения {include file="engine/modules/blockpro/block.pro.3.php"}

Переменные строки подключения указываются в виде кнструкции: &param-value

К примеру такая строка подключения:

{include file="engine/modules/blockpro/block.pro.3.php?&showstat=y&limit=5&sort=random&textLimit=150&imgSize=100x150"}

Теги шаблона

Спасибо:

Александру Фомину за разрешение использовать его наработки.

Sander за поддержку и подсказки по коду.

n0wheremany за советы и практическую помощь в оптимизации модуля, и особая благодарность за идею реализации допполей.