пз (1218617), страница 5
Текст из файла (страница 5)
Рисунок 20 – Установка модуля CAPTCHA для форм
Рисунок 21 – Настройка параметров кэширования
3.3 Разработка специализированных модулей
Разработка модуля начинается с создания директории модуля в папке sites/all/modules. Первым необходимым файлом является информационный файл с расширением info. Пример такого файла одного из модулей.
name = Limonad module
core = 7.x
dependencies[]=ctools
В нём обязательными параметрами является название модуля и версия Drupal, под которую ведётся разработка. Кроме этого возможно указать дополнительные файлы стилей и скриптов, а также зависимости модуля.
Основными составляющими модулей являются так называемые «хуки» – php функции, вызываемые ядром Drupal в определённый момент времени.
Наиболее часто используемые функции Drupal представлены ниже.
Hook_menu – определяет новые ссылки на страницы, их заголовки, функцию для вызова и параметры доступа. Пример такого объекта меню:
$items['ucs/test/%'] = array(
'title' => 'UCS Test',
'page callback' => 'limonad_ucs_socket',
'page arguments' => array(2),
'access arguments' => array('administer'),
'file' => 'limonad_ucs.socket.inc',
);
Hook_init – содержит в себе действия, которые будут выполнятся каждый раз при инициализации модуля.
Hook_form_alter – даёт возможность изменить любую форму на сайте. Все формы на сайте определены в т.н. «визуализируемом массиве» (renderable array) и перед каждый выводом формы на сайт, происходит запуск данного «хука». Внутри функции программист имеет доступ ко всем полям, возможность изменять условия проверки и назначать дополнительные действия при отправке формы.
Hook_views_pre_render, hook_page_alter и hook_preprocess_node – поддерживает схожие функции с hoom_form_alter. Каждый из перечисленных «хуков» имеет собственный набор переменных доступных для изменения и соответствует шаблонам темы.
Hook_cron – определяет последовательность действия, которая будет выполнена каждый раз при запуске планировщика задач Cron.
В модуле имеется возможность создания форм. Как уже описано выше, формы определяются в массиве со специальной структурой. Данный массив должен возвращаться функцией, которая вызывается методом drupal_get_form. Пример простой формы с одним текстовым полем и кнопкой «Сохранить»:
function module_example($form, $form_state){
$form['field'] = array( '#type' => textfield', '#title' => 'Поле');
$form['submit'] = array('#type' => 'submit', '#value' => 'Сохранить');
return $form;
}
Функция drupal_get_form возвращает массив, который затем может быть выведен как обычный HTML-код при помощи drupal_render.
Проверка данных, введённых в поля выше определённой формы, может быть произведена в функции module_example_validate($form, $form_state). После успешной проверки будет вызвана функция module_example_submit($form, $form_state), в которой эти данные можно, например, сохранить или отправить в электронном письме.
Для сайта «Лимонад» было создано 6 модулей, реализующих дополнительный функционал.
3.3.1 Модуль «Поиск Лимонад»
Небольшой модуль создающий форму со строкой поиска.
function limonad_search_form($form, $form_state){
$form['#attributes'] = array('class' => array('search-form'), 'autocomplete' => 'off');
$form['#method'] = 'get';
$form['string'] = array(
'#type' => 'textfield',
'#title' => 'Поиск:',
'#default_value' => (isset($_GET['string']))?$_GET['string']:'',
);
$form['submit'] = array(
'#type' => 'submit',
'#value' => '',
);
return $form;
}
Данная форма отправляет GET запрос с поисковой строкой на страницу poisk, которая содержит представления для фильмов и новостей. Таким образом, форма служит для отправки фильтра в представления.
Кроме того, модуль реализует вывод формы в виде блока, находящимся в верхней части страницы.
function limonad_search_block_view($delta){
if($delta == 'limonad-search'){
$form = drupal_get_form('limonad_search_form');
$form['#attributes']['class'] = array('header-search-form');
unset($form['string']['#title']);
$form['string']['#attributes']['placeholder'] = 'Поиск';
$form['#action'] = '/poisk';
$block['content'] = $form;
return $block;
}
3.3.2 Модуль «Рейтинг фильмов»
Модуль содержит два обработчика ajax запросов, которые возвращают описание фильма и информацию о пользователе. Данные запросы происходят на странице рейтингов.
Функционал выше упомянутых обработчиков реализован при помощи дополнительного модуля CTools. CTools представляет собой библиотеку дополнительных функций существенно расширяющую Ajax функционал Drupal, представляющих собой аналог методов jQuery.
Некоторые из них:
– ajax_command_remove($selector) – удаление элемента $selector;
– ajax_command_append ($selector, $html) – добавление содержимого $html в конец элемента $selector;
– ctools_ajax_command_reload() – обновление страницы;
– ctools_modal_command_display($title, $html) – открытие модального окна с заголовокм $title и содержимым $html;
– ctools_modal_form_wrapper($form_id, $form_state) – открытие формы с id $form_id в модальном окне.
Данные функции добавляются в массив команд, который затем возвращаются в виде json строки при помощи функции ajax_render.
Например, функция возвращающая последние комментарии пользователя выглядит следующим образом:
function limonad_rating_user_description($uid, $ajax){
drupal_add_js(drupal_get_path('module', 'limonad_rating').'/limonad_rating.js');
if(!$ajax){
drupal_goto('top-kritikov');
}
ctools_include('ajax');
$comments = db_select('comment', 'c')->fields('c')->condition('uid', $uid, '=')->orderBy('created', 'DESC')->range(0, 5)->execute()->fetchAll();
if($comments) $output = '<div class="movie-detail user-detail"><h2>Последние комментарии</h2>';
else $output = '<div class="movie-detail user-detail"><h2>Комментарии отсутствуют</h2>';
foreach($comments as $comment){
$node = node_load($comment->nid);
$output .= '<div class="comment">'.l($node->title, 'node/'.$node->nid);
$output .= '<div class="date">'.date('d.m.Y').'</div>';
$output .= '<div class="body">'.$comment->subject.'</div></div>';
}
$output .= '<a href="#" class="close"></a></div>';
$commands[0] = ajax_command_remove('.movie-detail');
$commands[1] = ajax_command_append('body', $output);
$commands[1]['effect'] = 'slide';
$commands[1]['speed'] = 200;
$commands[2] = ajax_command_invoke('a[href="/userinfo/'.$uid.'/nojs"]', 'movie_detail');
print ajax_render($commands);
drupal_exit();
}
Помимо обработки ajax, модуль рейтингов содержит в себе процедуры планировщика Cron – утилиты, которая позволяет запускать UNIX команды по установленном расписанию.
function limonad_rating_cron(){
if(date('H:i') == '00:00'){
$movies = views_get_view_result('movies', 'page_1');
foreach($movies as $place => &$item){
$node = node_load($item->nid);
$node->field_rating_position_before['und'][0]['value'] = $node->field_rating_position['und'][0]['value'];
$node->field_rating_position['und'][0]['value'] = $place + 1;
$node->field_total_rating_week['und'][0]['value'] = $node->field_total_rating['und'][0]['value'];
node_save($node);
}
$users = views_get_view_result('critics_rating', 'page_1');
foreach($users as $place => &$item){
$user = user_load($item->uid);
$user->field_user_rating_position_befo['und'][0]['value'] = $user->field_user_rating_position['und'][0]['value'];
$user->field_user_rating_position['und'][0]['value'] = $place + 1;
$user->field_user_total_rating_week['und'][0]['value'] = $user->field_user_rating['und'][0]['value'];
user_save($user);
}
}
}
Данный код каждый день сохраняет текущую позицию фильма или пользователя в рейтинге, а также позицию за предыдущий день. Это позволяет рассчитать изменение позиции в рейтинге.
3.3.3 Модуль «Limonad Payment»
Модуль представляет функционал оплаты и использует API Сбербанка для реализации транзакций.
Связь с API Сбербанка происходит при помощи POST запросов на определённые адреса, использующих некоторый набор параметров. В данном модуле используются два вида запросов: register и getOrderStatus.
register – осуществляет создание заказа внутри системы Сбербанка.
Его параметры:
– amount – сумма оплаты;
– orderNumber – идентификатор заказа на сайте;
– password – пароль от пользователя Сбербанка;
– userName – логин пользователя сбербанка;
– returnUrl – url, на который следует вернуться после успешной оплаты;
– description – описание заказа.
getOrderStatus – получает статус заказа.
Его параметры:
– orderId – идентификатор заказа;
– password – пароль от пользователя Сбербанка;
– userName – логин пользователя сбербанка.
Например, код, делающий запрос на создание заказа, выглядит следующим образом:
$params = array(
'amount' => $amount * 100,
'orderNumber' => $oid,
'password' => '123',
'userName' => 'kamkino',
'returnUrl' => 'http://kamkino.ru/paydone',
'description' => 'Покупка билетов на фильм "'.$movie.'"'
);
$opts = array(
'http' => array(
'method' => 'POST',
'header' => "Content-type: application/x-www-form-urlencoded",
'content' => http_build_query($params),
'timeout' => 60
)
);
$context = stream_context_create($opts);
$result = file_get_contents('https://securepayments.sberbank.ru/payment/rest/register.do', false, $context);
$arSbrfResult = (array) json_decode($result);
При успешном запросе массив $arSbrfResult будет содержать адрес страницы, на которою нужно переадресовать пользователя. После оплаты, пользователь будет возвращен обратно на сайт. В случае с запросом статуса, ответный массив будет содержать статус заказа, где статус 2 означает, что заказ успешно оплачен.
Модуль Limonad Payment использует собственную таблицу в базе данных для хранения заказов. Реализация такой таблицы происходит при помощи API Drupal [26]. Описание структуры таблицы содержится в обычном массиве, который возвращается функцией. Данная функция должна находится внутри файла с расширением install. В данном случае это файл limonad_payment.install. Часть кода, описывающего таблицу представлена ниже.
function limonad_payment_schema()
{
$schema['orders'] = array(
'fields' => array(
'oid' => array(
'type' => 'serial',
'not null' => true,
'unsigned' => true,
),
'uid' => array(
'type' => 'int',
'not null' => true,
'unsigned' => true,
),
'description' => array(
'type' => 'text',
),
'ucs' => array(
'type' => 'int',
'unsigned' => true,
'default' => NULL
),
'bid' => array(
'type' => 'text',
),
'url' => array(
'type' => 'text',
),
…
}
Данная функция вызывается каждый раз при изменении состояния активности модуля.
Доступ к таблице также реализован при помощи API Drupal. Например, запрос заказа выглядит следующим образом:
$order = db_select('orders', 'o')
->fields('o')
->where('oid='.$id)
->execute()
->fetchAssoc();
Создание заказа:
$oid = db_insert('orders')
->fields(array(
'uid' => $user->uid,
'description' => 'Покупка билетов на фильм "'.$movie.'"',
'nid' => $nid,
'amount' => $amount,
'places' => serialize($places),















