В данной статье приводится пример разработки собственного модуля для Drupal 5.1 с использованием библиотеки xajax версии 0.2.4.

Задача.
1. Реализовать возможность формирования пользователем в своем профиле "списка интересов" на основе одного из словарей, созданном в модуле Taxonomy.
2. Разработать систему поиска пользователей со схожими интересами.
3. Использовать в модуле технологию AJAX.

Работающий пример решения задачи можно найти здесь.

Реализация.
1. Формировать списки интересов позволяет модуль User tags.
2. Для поиска по интересам будет использоваться модуль, описанный в данной статье. Для наведения красоты будет использована библиотека xajax версии 0.2.4.

0. Предварительные действия.
Перед началом работы скачайте библиотеку xajax версии 0.2.4. На момент написания статьи эта версия xajax является последним релизом, возможно, под более новые версии этой библиотеки придется модифицировать код модуля.

Папку /xajax_js из архива скопируйте в корень Друпала (то есть в папку, в которой находится index.php). Файлы xajax.inc.php, xajaxCompress.php и xajaxResponse.inc.php скопируйте в папку /includes.

Также, скачайте файл xajax_loading.js_.txt, прикрепленный к этой статье, переименуйте его в xajax_loading.js и скопируйте в папку /xajax_js.

Пара слов о словаре со списком интересов. В меню "Categories" ("Словари" – admin/content/taxonomy) создайте новый словарь и необходимое количество терминов в нем. Словарь, для этого конкретного примера, должен быть двухуровневым. То есть, в его настройках должен быть отмечен пункт "Hierarchy – Multiple" ("Структура – Множественная"). Термины первого уровня станут категориями, которые нельзя будет выбрать, термины второго уровня станут параметрами, доступными для выбора пользователем.

1. Создание списка интересов.
Скачайте и установите модуль User tags. Далее в его настройках (admin/settings/user_tags) выберите словарь, на основе которого будет формироваться список, а в контроле доступа (admin/user/access) установите галочки "tag users" для всех ролей кроме "anonymous user".

После выполнения этого этапа в профиле пользователя появится вкладка "Tags" (user/[uid]/edit/tags), на которой он сможет выбрать необходимые значения.

2.0. Использование модуля поиска по отмеченным пользователем тэгам.
Скачайте файл user_tags_search.zip, прикрепленный к этой статье, разархивируйте его в папку /modules, включите модуль user_tags_search через админку (admin/build/modules), в контроле доступа (admin/user/access) раздайте нужным пользователям доступ на 'administer user_tags_search' и 'access user_tags_search'. Укажите словарь, используемый для списка "интересов" в меню настройки модуля (admin/settings/user_tags_search). Здесь надо указать тот же словарь, что и в настройках модуля User Tags (admin/settings/user_tags).

Теперь по адресу http://example.com/users_search должна быть доступна форма поиска пользователей по тэгам, отмеченным в профиле. Форма состоит из двух комбобоксов (select) и одного текстового поля, доступного только для чтения. В первом комбобоксе выводятся термины первого уровня (то есть не имеющие предков) из словаря, выбранного в настройках модуля user_tags_search, второй комбобокс создается пустым, при желании его вообще можно убрать, но по правилам хорошего тона, в создаваемых интерефейсах не должно быть исчезающих-появляющихся объектов.

После выбора в первом комбобоксе категории, во второй комбобокс с помощью xajax подгружаются термины-потомки. После выбора термина во втором комбобоксе он (термин) попадает в текстовое поле, в котором одновременно может находиться сразу несколько терминов. После нажатия кнопки "Поиск" с помощью все тогоже xajax данные передаются на сервер, ведется поиск и клиенту отдается результат.

2.1. Подробное описание модуля.
Модуль состоит из двух файлов: user_tags_search.info, в котороом описаны служебные параметры, и user_tags_search.module, в котором описаны функции, необходимые для работы.

Файл user_tags_search.module состоит всего из 6 функций:

user_tags_search_menu()// – реализация (implementation) функции hook_menu(). Здесь задаются пути (URL), которые будет обрабатывать модуль и функции, которые будут вызываться при запросе пользователем той или иной страницы.

user_tags_search_perm()// – реализация hook_perm(). Этой функцией создаются права доступа к разделам модуля.

user_tags_search_admin_settings()// – функция создающая интерфейс управления модулем.

select_sub_cat($arg)// – функция, обрабатывающая ajax-запрос от клиента. На входе получает tid термина, на выходе отдает новый комбобокс с потомками входящего термина.

select_data($tags)// – функция, обрабатывающая ajax-запрос от клиента. На входе получает массив имен терминов, затем находит tid'ы этих терминов, затем ищет юзеров, которые отметили у себя в профиле эти термины и отдает их список клиенту.

users_search()// – функция, которая рисует пользовательский интерфейс.
?>

Первые три функции не представляют особенного интереса, так как во-первых, их аналоги можно встретить в любом другом модуле, во вторых по их описанию не трудно разобраться как они работают. На последних трех функциях остановлюсь подробнее.

Небольшое отступление.

Логика работы любого ajax-приложения имеет примерно такую структуру:

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

При нажатии кнопки выполняется java-script функция, которая передает данные на сервер;

Сервер обрабатывает полученные данные и передает их браузеру;

Браузер отображает данные в заранее определенном для этих целей слое;

Пока идет обмен данными между клиентом и сервером пользователь видит на экране браузера сообщение типа "Идет загрузка".

Логика работы с библиотекой xajax:

На сервере в php-файле создается функция (например my_func()), которая будет обрабатывать клиентский запрос;

На клиенте средствами xajax регистрируется функция созданная на предыдущем этапе, после чего xajax автоматически создает java-script функцю вида xajax_my_func(), которая будет передавать данные серверной функции my_func().

/*
Функция рисует пользовательский интерфейс модуля.
*/
function users_search()
{
// подключаю файл, который будет выводить сообщение "Подождите идет загрузка", во время обработки ajax-запроса
drupal_add_js("xajax_js/xajax_loading.js");
// подключаю xajax
require_once('includes/xajax.inc.php' );
// создаю новый объект
$xajax = new xajax();
// регистрирую функции, которые будут передавать данные на сервер
$xajax->registerFunction("select_sub_cat");
$xajax->registerFunction("select_data");
drupal_set_html_head($xajax->getJavascript());
$xajax->processRequests();

// создаю форму поиска
$content .= "\n";
$content .= "

\n";
$content .= "

";

// Запуск поиска при клике по соответствующей кнопке
$content .= "

";
$content .= "

"; // при выделении элемента комбобокса, выполняется функция, посылающая серверу запрос на получение комбобокса с потомками $content .= "\n"; $content .= "Выберите категорию: "; // заполняю первый комбобокс терминами, у которых нет предков foreach (taxonomy_get_tree(variable_get('user_tags_search_root', '')) as $tid => $term) { if($term->depth == 0)$content .= "tid . "\">" . $term->name . "\n"; } $content .= "	"; // Создаю слой, в котором будет выводиться комбобокс с терминами-потомками. Теоретически можно не создавать в этом слое комбобокс, то есть просто использовать код типа , но, как я уже писал выше, по правилам хорошего тона, лучше не создавать интерфейсы с исчезающими-появляющимися контролами. $content .= " <-- Выберите категорию"; $content .= "
"; $content .= "Выберите категорию в первом списке, а затем один или несколько тэгов во втором, нажмите кнопку \"Поиск\" и система найдет людей, которые отметили выбранные вами тэги.\n"; // Этот слой не отображается по умолчанию, а выводится только во время обмена данными между клиентом и сервером $content .= " Подождите, идет загрузка данных "; $content .= "\n

";
$content .= "";
$content .= "

";

return $content;
}

/*
Выбор терминов-потомков
*/
function select_sub_cat($arg)
{
// инициализация объекта xajax
$objResponse = new xajaxResponse();
$output = "";
$output .= "Выберите тэг:";

// выбор данныих из базы
$my_r = db_query("SELECT t.tid, t.name from {term_data} t INNER JOIN {term_hierarchy} h ON t.tid = h.tid WHERE h.parent = '" . $arg . "' ORDER BY t.name ASC");

while($my_obj = db_fetch_object($my_r))
{
$output .= "name . "'>" . $my_obj->name . "\n";
}
$output .= "";

// передача данных клиенту в слой updatableDiv, который создан в функции users_search
$objResponse->addAssign('updatableDiv', 'innerHTML', $output);

return $objResponse->getXML();
}
?>

Функция select_data($tags) имеет немного более сложный алгоритм выбора данных, но с точки зрения работы с клиентским скриптом она абсолютно идентична предыдущей функции, по этому подробнее на ней я останавливаться не буду.