» » Пишем свой модуль для DLE - подробная инструкция

Пишем свой модуль для DLE - подробная инструкция

29.09
68
61 563
Пишем свой модуль для DLE - подробная инструкция

В этой статье я постараюсь очень подробно разобрать процесс создания простого модуля для DLE с кешированием и собственными шаблонами. Сначала разберём модуль без шаблона, а после дополним его собственным шаблоном. Итогом статьи будет работоспособный модуль без админки, вызываемый в любом месте сайта через строку подключения.

Вступление


На написание данного поста меня натолкнул один вопрос на сайте dle-faq.ru. Точнее заставил задуматься, почему люди усложняют себе жизнь постоянными правками движка там, где это по большому счёту не нужно. Причина оказалась очень проста - мало кто умеет и знает как правильно написать свой модуль для DLE, хотя это довольно таки просто на самом деле.
Сразу стоит оговориться, что я человек, имеющий слабое знание даже основ php (что не мешает мне делать качественные модули для dle), поэтому статья для опытного программиста скорее всего не будет представлять интерес, а вот для новичка - будет крайне полезна.

С чего начать?


Пишем свой модуль для DLE - подробная инструкция

Конечно же начинать лучше с идеи или исходя из конкретной потребности!
В нашем случаи будем рассматривать необходимость вывода в профиле пользователя в любом месте сайта количество новостей определённого пользователя в определённых категориях.
Таким образом мы уже определили пару переменных, которые будут в нашем модуле - это имя пользователя и id категории.
Естественно результат работы модуля лучше кешировать т.к. лишние запросы в БД нам совершенно не нужны. Так же нам не нужен шаблон модуля, но для примера я приведу код модуля и с шаблоном, т.к. правильное подключение шаблона тоже очень важно и при более или менее сложном модуле экономит много ресурсов за счёт уменьшения кода самого модуля.
Круг задач определён, можно приступать к написанию кода. Вспоминаем что у DLE есть API, и вполне логичным кажется использование готового API для этой задачи, но я крайне не рекомендую вообще его использовать даже (особенно!) в сложных модулях.

Почему не стоит использовать DLE_API


Всё просто - это крайне кривая штука, которая не развивается аж с версии 8.2 (на момент написания текущая версия движка - 10.0 и по сравнению с предыдущей версией пофиксили лишь баг с невозможностью регистрации пользователя через api, никаких доработок не производилось).
Пишем свой модуль для DLE - подробная инструкция

Использование dle_api значительно увеличивает расход оперативной памяти, что совсем, совсем не хорошо.
Методы, описанные в dle_api расходятся с оригинальным функционалом.
Общий совет: если вам нужна какой то метод или функция из dle_api - просто скопируйте её в свой модуль.
Возможно моих скромных наработок хватит на набор методов и функций, которые можно будет использовать в дальнейшем, но это тема для отдельной статьи.

Пишем код


Прежде, чем писать любой модуль (кроме файлов, отвечающих за ajax), нужно в обязательном порядке, в самом начале прописать одну строку:
if (!defined('DATALIFEENGINE')) die("Error!");

Это не позволит пользователю обратиться к файлу модуля напрямую, а значит он не сможет передать собственные параметры в модуль и взломать сайт через этот модуль. Думаю важность этого момента трудно переоценить, но тем не менее я очень часто натыкаюсь на отсутствие подобной конструкции в коде модуля.

Конфигурация и кеширование


Я решил остановиться на этом моменте подробно, т.к. это один из самых частых вопросов, которые задаются, если человек решил написать свой модуль.

Конфигурацию модуля лучше всего записывать в массив - это даст возможность беспроблемного создания кеша для каждого вызова модуля с разным набором конфигурации, в нашем случаи для каждого пользователя.
Объясню почему. Допустим мы написали модуль, он кешируется, и строка создания кеша выглядит следующим образом:
create_cache($var1.$var2.$var3.$var4, $myModule, $config['skin']);

где:
- $var1.$var2.$var3.$var4 - переменные модуля.
- $myModule - текст, который должен записаться в кеш.

Тут всё замечательно ровно до тех пор, пока не понадобится добавить новую переменную. Как правило автор просто забывает прописать эту новую переменную в строку формирования и получения кеша и потом гадает над причинами неработоспособности или неправильной работы модуля (что негативно сказывается на его психологическом равновесии). Таким образом конфиг модуля лучше писать так:
$myConfig = array(
'var1' => $var1,
'var2' => $var2,
'var3' => $var3,
'var4' => $var4
);
$cacheName = md5(implode('_', $myConfig));

а строка создания кеша будет такая:
create_cache($cacheName, $myModule, $config['skin']);

Таким образом нам вообще не придётся лазить в этот код никогда, всё будет происходить автоматом.

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

В DLE есть много дефолтных префиксов, но нас интересуют лишь те, которые автоматически чистятся при определённых условиях, поэтому приведу список таких префиксов:
  1. news, rss, comm - при добавлении новости или комментария.
  2. news, related, tagscloud, archives, calendar, topnews, rss - при добавлении новости.
  3. comm - при редактировании комментария.
  4. news, rss - при редактировании новости, при выcтавлении рейтинга
  5. news, full, comm, rss - при массовом удалении комментариев
  6. news, full, comm, tagscloud, archives, calendar, rss - при удалении новости

Значит в нашем случаи нужен префикс archives т.к. кеш модуля надо сбрасывать только при добавлении или удалении новости (он мне просто понравился, можно использовать и calendar и rss). Код конфига и создания кеша тут приводить не буду дабы не захламлять статью, весь код модуля можно посмотреть ниже.

Текст кеша - это результат работы модуля, который будет записан в кеш, тут всё просто.
ID кеша или его имя - сюда лучше всего передавать переменную $cacheName, о которой писалось выше и переменную $config['skin'] - это для того, чтобы иметь разные кеши для разных шаблонов сайта.
Суффикс кеша - может принимать два значения true или false, если передано значение true, то для каждой группы пользователей будет создаваться свой кеш-файл, это бывает нужно, если разным группам пользователей нужно показывать разный контент.

Универсальная заготовка для модуля с кешем, без шаблона


Учитывая всё выше написанное мы можем создать простую заготовку для модуля, который будет использовать кеш, но не будет в своей работе использовать шаблон. Всего 15 строк кода!
<?php
if (!defined('DATALIFEENGINE')) die("Go fuck yourself!");
$myConfig = array(
'cachePrefix' => !empty($cachePrefix) ? $cachePrefix : 'archives',
'cacheSuffix' => !empty($cacheSuffix) ? $cacheSuffix : false
);
$cacheName = md5(implode('_', $myConfig));
$myModule = false;
$myModule = dle_cache($myConfig['cachePrefix'], $cacheName . $config['skin'], $myConfig['cacheSuffix']);
if (!$myModule) {
$myModule = 'Hello World!'; // Результат работы модуля.
create_cache($myConfig['cachePrefix'], $myModule, $cacheName . $config['skin'], $myConfig['cacheSuffix']);
}
echo $myModule;
?>

Всё довольно просто, правда?

Запрос в БД и проверки.


Ранее мы определили, что нам потребуется две переменные - имя юзера и id категории, а для выборки нужных значений нам необходимо будет составить запрос в БД.
Заведём две переменные: $userName и $caId - эти переменные будут передаваться в модуль через строку подключения.
Однако для нормальной работы модуля нужно проверять данные (ведь от кривых рук спасения практически не существует).

Небольшое отступление:
Я советую использовать однообразный тип переменных модуля и переменных конфига модуля, т.е.
'userName' => $userName,

или
'user_name' => $user_name,

выглядит гораздо более читабельным, чем
'user_name' => $userName,

Однако использование нижней черты я не практикую в dle, т.к. разок из-за этого сработал фильтр в dle и модуль не отработал, хотя возможно это лишь единичный случай.


Самая простая проверка - условие if else:
$userName = !empty($userName) ? $db->safesql(strip_tags(stripslashes($userName))) : false;

т.е. мы просто проверяем передана ли переменная через строку подключения, если передана (т.е. не пустая) - прогоняем её значение через $db->safesql - это обезопасит нас от "неправильных" логинов пользователей, т.к. значение переменной будет вставлено в запрос к БД.
Переменную $catId фильтровать не нужно, т.к. она кроме как цифрой никак не задаётся и глупо писать что-то другое в строке подключения. Однако должно быть какое-то дефолтное значение, поэтому проверка нужна и её мы можем прописать непосредственно в конфиге модуля:
$myConfig = array(
...
'catId' => !empty($catId) ? $catId : '1', // По умолчанию id=1
...
);

С переменными разобрались, теперь запрос в БД.
В нашем случаи необходимо всего одно значение из БД и использовать полноценный запрос, а потом его разбирать - не имеет смысла, поэтому мы будем использовать метод super_query, он по умолчанию возвращает одномерный массив.
Наш итоговый запрос будет таким:
$row = $db->super_query("SELECT COUNT(*) as count FROM " . PREFIX . "_post WHERE category = '".$myConfig['catId']."' AND autor = '".$myConfig['userName']."'");

Где:
$myConfig['catId'] - id категории.
$myConfig['userName'] - имя пользователя.
ниже пропишем отладочный код:
echo "<pre>"; print_r($row); echo "</pre>";

Вызов модуля осуществляем так:
{include file="engine/modules/mymodule.php?&userName=user&catId=5"}

Если переменные указаны правильно - результатом отладки будет массив с данными, состоящий из одного элемента count
Array (
[count] => 155
)

где:
155 - количество новостей у указанного пользователя в указанной категории

Теперь можно вывести результат по нормальному:
$count = ($row['count'] > 0) ? $row['count'] : 'новостей нет';
$myModule = $count;


Тут следует отметить, что если в кеш будет записан один нолик - dle его не будет "считать кешем" и создаст новый, поэтому нужно писать туда что-то, отличное от нуля.


Итоговый код нашего модуля будет таким:
<?php
if (!defined('DATALIFEENGINE')) die("Go fuck yourself!");
$userName = !empty($userName) ? $db->safesql(strip_tags(stripslashes($userName))) : false;
$myConfig = array(
'userName' => $userName,
'catId' => !empty($catId) ? $catId : '1',
'cachePrefix' => !empty($cachePrefix) ? $cachePrefix : 'archives',
'cacheSuffix' => !empty($cacheSuffix) ? true : false
);
$cacheName = md5(implode('_', $myConfig));
$myModule = false;
$myModule = dle_cache($myConfig['cachePrefix'], $cacheName . $config['skin'], $myConfig['cacheSuffix']);
if (!$myModule) {
$row = $db->super_query("SELECT COUNT(*) as count FROM " . PREFIX . "_post WHERE category = '" . $myConfig['catId'] . "' AND autor = '" . $myConfig['userName'] . "'");
$count = ($row['count'] > 0) ? $row['count'] : 'новостей нет';
$myModule = $count;
create_cache($myConfig['cachePrefix'], $myModule, $cacheName . $config['skin'], $myConfig['cacheSuffix']);
}
echo $myModule;
?>

Всего 20 строк кода - и получаем готовое решение конкретной проблемы.
Код модуля вполне рабочий и его можно использовать в реальном проекте, однако приведён этот код для ознакомления с принципами правильного написания модулей для DLE.

На этом можно было бы закончить, но выше я обещал показать код модуля с использованием собственного шаблона.

Универсальная заготовка для модуля с кешем и собственным шаблоном


В целом тот же модуль, что мы написали без шаблона вполне легко перетащить и на "шаблонный" модуль, однако в нашем случаи это не имеет смысла, т.к. модуль выводит всего одну цифру. Собственный шаблон в модуле лучше использовать когда необходимо вывести несколько значений с разным оформлением в разных местах сайта.
Не буду расписывать что к чему, т.к. статья уже и так довольно таки большая, а лучше оставлю два листинга кода, один без комментариев - для использования в качестве заготовки:
<?php
if (!defined('DATALIFEENGINE'))
die("Go fuck yourself!");
$userName = !empty($userName) ? $db->safesql(strip_tags(stripslashes($userName))) : false;
$myConfig = array(
'userName' => $userName,
'catId' => !empty($catId) ? $catId : '1',
'template' => !empty($template) ? $template : 'default',
'cachePrefix' => !empty($cachePrefix) ? $cachePrefix : 'news',
'cacheSuffix' => !empty($cacheSuffix) ? true : false
);
$cacheName = md5(implode('_', $myConfig));
$myModule = false;
$myModule = dle_cache($myConfig['cachePrefix'], $cacheName . $config['skin'], $myConfig['cacheSuffix']);
if (!$myModule) {
if (file_exists(TEMPLATE_DIR . '/' . $myConfig['template'] . '.tpl')) {
if (!isset($tpl)) {
$tpl = new dle_template();
$tpl->dir = TEMPLATE_DIR;
} else {
$tpl->result['myModule'] = '';
}
$tpl->load_template($myConfig['template'] . '.tpl');
$row = $db->super_query("SELECT COUNT(*) as count FROM " . PREFIX . "_post WHERE category = '" . $myConfig['catId'] . "' AND autor = '" . $myConfig['userName'] . "'");
$count = ($row['count'] > 0) ? $row['count'] : 'новостей нет';
$tpl->set('{tag_name}', $count);
$tpl->compile('myModule');
$myModule = $tpl->result['myModule'];
create_cache($myConfig['cachePrefix'], $myModule, $cacheName . $config['skin'], $myConfig['cacheSuffix']);
$tpl->clear();
} else {
$myModule = '<b style="color:red">Отсутствует файл шаблона: ' . $config['skin'] . '/' . $myConfig['template'] . '.tpl</b>';
}
}
echo $myModule;
?>

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


Вот теперь пожалуй можно закончить статью!
Если будет время, идея и желание - я постараюсь написать про создание более сложного модуля.
А пока жду ваших вопросов и мнений.

Похожие материалы

Комментарии

ПафНутиЙ
ПафНутиЙ 6 октября 2014 18:37
{include file="engine/modules/mymodule/info.php"}

прописать в fullstory.tpl, но использовать свой шаблон. А то, что должен выводить одуль и писать в свой шаблон.
DeL Esprit
DeL Esprit 6 октября 2014 22:13
delete
DeL Esprit
DeL Esprit 6 октября 2014 22:13
ПафНутиЙ,
у меня сейчас так и сделано.
но, например, я хочу вывести какой-то свой созданный тег до {fullstory}, а какой-то после (как пример).
Так можно как-то сделать? или дважды вызывать модуль?
locksmith
locksmith 12 октября 2014 15:46
Почему дополнительно не используется trim? в $db->safesql(strip_tags(stripslashes($userName)))
ПафНутиЙ
ПафНутиЙ 12 октября 2014 20:28
потому, что это всего лишь пример модуля.
locksmith
locksmith 13 октября 2014 05:51
Решил проверить. Попробовал без trim послать переменную из POST с пробелами. Пробелы удалились. Непонятно почему?
locksmith
locksmith 14 октября 2014 05:42
Как узнать, что запись успешно занесена в кеш? просто у меня в папке \engine\cache не появилось файла с нужным именем.
ПафНутиЙ
ПафНутиЙ 14 октября 2014 11:57
либо нет прав на запись в папку, либо отключен кеш в DLE, либо написано неправильно.
Ну или пишется пустота в кеш, тогда он не создастся.
locksmith
locksmith 14 октября 2014 12:01
Блин! Ну точно кэширование в настройках сам же когда-то отрубил. Сайт локально стоит. Спасибо Павел! Теперь файл кеша появился!!!
locksmith
locksmith 17 октября 2014 11:06
Сляпал постраничную навигацию. Встроил в ваш макет модуля Павел. При включении кеширования в настройках при перелистывании страниц везде показывает одно и тоже. При выключенном кеше такого нет. Не подскажете где копать?
ПафНутиЙ
ПафНутиЙ 17 октября 2014 11:17
Добавьте переменную, отвечающую за номер страницы в конфиг модуля - тогда она будет учавствовать в формировании кеша и будет всё ок.
locksmith
locksmith 17 октября 2014 11:49
Спасибо! Помогло! Подскажите Павел у меня в модуле дополнительно загружается шаблон navigation.tpl так вот откуда-то в кнопках в теге span подгружается класс из вообще другого шаблона - не того, что по умолчанию.
locksmith
locksmith 17 октября 2014 11:52
<span class="masha_index masha_index19" rel="19"></span>
откуда он вообще мог взяться?
ПафНутиЙ
ПафНутиЙ 17 октября 2014 12:46
В настройках движка уберите галочку "разрешить делиться контентом" это дибильный скрипт masha
locksmith
locksmith 17 октября 2014 12:52
Спасибо! Уже нашел.
locksmith
locksmith 17 октября 2014 16:27
Немного не понимаю по работе кеша. Если все нужные переменные заносятся в массив $myconfig а в функцию добавления в кеш create_cache($cacheName, $myModule, $config['skin']); не входит как таковой весь массив, а только его части, в которые не входят переменные. Скажите Павел как так? Я что-то не могу до конца понять сути.
ПафНутиЙ
ПафНутиЙ 17 октября 2014 17:35
$cacheName = md5(implode('_', $myConfig));

Вот эта строка что делает?
locksmith
locksmith 17 октября 2014 17:43
Я так понял назначает имя файла кеша в виде кучи символов
ПафНутиЙ
ПафНутиЙ 17 октября 2014 18:18
да, уникальное для каждой неодинаковой строки подключения
locksmith
locksmith 17 октября 2014 18:45
Так а переменные в массиве где хранятся?
DreamFix
DreamFix 6 декабря 2014 20:57
Отличная статья, спасибо ПафНутиЙ! Ждем реализацию нового DLE_API от ПафНутиЯ
ПафНутиЙ
ПафНутиЙ 6 декабря 2014 23:36
Этого точно не будет.
Есть определённые наработки, но не факт, что они подойдут на роль API и не факт, что вообще кому то захочется в этом разбираться.
DreamFix
DreamFix 7 декабря 2014 02:44
Жаль, намного бы упростило разработку модулей для тех кто только что познакомился с DLE.
locksmith
locksmith 15 февраля 2015 10:02
Скажите пожалуйста Павел если в $config нужно занести массив переменных
$myConfig  = array(
	'userName' => $userName,
	'myarray' => $myarray,
	'cachePrefix' => !empty($cachePrefix) ? $cachePrefix : 'news',
	'cacheSuffix' => !empty($cacheSuffix) ? true : false
);
. Вот в таком виде не работает. А если прописать
'myarray' => $myarray['id']
то работает. Как занести весь массив?
ПафНутиЙ
ПафНутиЙ 15 февраля 2015 11:13
А как вы определили, что не работает?
locksmith
locksmith 15 февраля 2015 14:39
Я изменял эту переменную - она у меня отвечает за кол-во пользователей в списке. Когда написано вот так
myarray['id']
то кол-во сраазу без проблем меняется. По другому не хочет.
locksmith
locksmith 15 февраля 2015 14:55
А вот так работает
create_cache($myConfig['cachePrefix'], $myModule, $cacheName . $config['skin'].$myarray, $myConfig['cacheSuffix']);
ПафНутиЙ
ПафНутиЙ 17 февраля 2015 13:42
переменная $myarray как определяется?
locksmith
locksmith 18 февраля 2015 14:47
массив $myarray берется из подключаемого файла конфигурации типа
include ENGINE_DIR . '/data/my_config.php';
rusork
rusork 14 декабря 2015 03:26
Здравствуйте.

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

Написал себе модуль (заготовку взял из Вашей инструкции), который меняет данные в доп.полях новости, в момент когда пользователь открывает её (если требуется поменять).

В БД всё нормально - новые значения, но страница закеширована и получается, что выводит старые данные, пока не почистить кеш или не пересохранить новость.

Можно ли как-то в тот момент, когда модуль меняет доп.поля, почистить удалить кеш для этой конкретной новости?

Добавить комментарий

Комментировать могут только зарегистрированные пользователи

Информация

Посетители, находящиеся в группе Гости, не могут оставлять комментарии к данной публикации.