SNVote — модуль социального голосования для DLE DataLife Engine

Здарова, народ! Сегодня замечательный день, потому что я хочу представить вам новоиспеченный модуль для организации социальных голосований на базе движка DLE!
В одном из прошлых постов я говорил, что идет работа над супер-пупер модулем, так вот это он. Работа длилась, наверное, месяца два, было затрачено колоссальное количество сил и времени для реализации всех пожеланий, и вот — все готово!
Представляю вам первый паблик релиз модуля SNVote, спешите тестить.

Сразу хочется сказать в очередной раз огромное спасибо Саньку, который написал этот модуль (да и все остальные модули, выложенные на блоге) с нуля, включая яваскрипты и прочее. А еще наш модуль не похож на все остальные — он намного лучше, поверьте! А самое главное — первый релиз полностью бесплатный (а аналоги, к слову, уступающие по всем параметрам, стоят в районе 30-50$ за копию)!!!

Давайте приступим к описанию возможностей, процесса установки и примеров использования.

Назначение модуля

Организация на сайте ряда голосований при помощи социальных сетей. В процессе голосования пользователями размещаются ссылки в социальных сетях.
Подсчёт голосов ведётся согласно количеству размещенных ссылок. Поскольку невозможно контролировать процесс публикации одним пользователем в социальных сетях нескольких одинаковых ссылок, счётчики голосов не защищены от «накрутки», таким образом, данный модуль предназначен скорее для «прокачки» страниц сайта, но не для организации реальных конкурсов с призовым фондом. По умолчанию ссылки, публикуемые в социальных сетях, ведут на страницу голосования.
Модуль может работать как с ЧПУ, так и без него.

Функционал и возможности модуля

Модуль SNVote состоит из администраторской и клиентской частей.

Админпанель

Общие функции:

• Администраторская часть представляет собой общий список голосований на сайте. Вход в нее осуществляется из меню «Список всех разделов => Сторонние модули => SNVote».
• Новое голосование добавляется при помощи ссылки внизу списка «+ Создать новое голосование».
• При нажатии на наименование голосования или на ссылку "[варианты ответов]" открывается список вариантов ответов для данного голосования.
• Для добавления нового варианта ответа существует ссылка внизу списка «+ Добавить вариант ответа».
• Для редактирования и удаления как голосований, так и вариантов ответа существуют ссылки "[редактировать]" и "[удалить]".

Форма добавления / редактирования голосования:

• Название голосования — наименование голосования, как правило, является вопросом, предложенным пользователям.
• Title голосования — заголовок, используемый как содержимое тега <title> при просмотре страницы голосования. Если оставить данное поле пустым, оно заполнится содержимым поля «Название голосования»
• Псевдоним (alt-name) — альтернативный заголовок голосования, записанный латинскими буквами. Используется при построении url. Если оставить данное поле пустым, оно заполнится содержимым поля «Название голосования», переведённым в латинские символы.
• Изображение — картинка, символизирующая данное голосование. Картинка должна быть размером 100 * 100 пикселей. После загрузки картинки её можно заменить / удалить в режиме редактирования голосования.
• Начало голосования — дата и время, когда голосование будет объявлено открытым. Если оставить поле пустым, будут проставлены текущие дата и время
• Окончание голосования — дата и время, когда голосование будет объявлено закрытым. Если оставить поле пустым, голосование будет постоянным.
• Текст для социальных сетей — общий текст, для публикации в социальных сетях рядом со ссылкой. Данный текст применяется, если не заполнено аналогичное поле в форме варианта ответа. В этом тексте можно использовать тег {item} для вставки в него наименования варианта ответа при голосовании за тот или иной вариант.
• Описание — текстовое описание голосования.
• Статус — текущее состояние голосования. Опубликовано — голосование будет активно на сайте в указанный период и появится в общем списке. Скрыто — голосование не будет доступно на сайте — Вы сможете опубликовать его позднее. остановлено — ручная остановка голосования, независимо от даты его окончания.

Форма добавления / редактирования варианта ответа:

• Вариант ответа — наименование варианта ответа, как правило, является ответом на поставленный вопрос.
• Ссылка «подробнее» — ссылка, ведущая на страницу с описанием данного варианта ответа. При заполнении этого поля появляется возможность проставить галочку «использовать данную ссылку для публикации в социальных сетях». После её проставления при голосовании пользователей в социальных сетях будет публиковаться ссылка «подробнее» вместо ссылки на страницу голосования. Будьте внимательны! После изменения этой ссылки количество голосов за данный вариант ответа будет обнуляться. Так же стоит учесть, что количество голосов в таком случае напрямую зависит от количества публикаций в социальных сетях данной ссылки. То есть, в случае, если ссылку «подробнее» публиковали в них каким-то иным образом, результаты голосования будут некорректными.
• Изображение — картинка, символизирующая данный вариант ответа. Картинка должна быть размером 100 * 100 пикселей. После загрузки картинки её можно заменить / удалить в режиме редактирования варианта ответа.
• Текст для социальных сетей — текст, для публикации в социальных сетях рядом со ссылкой при голосовании за данный вариант ответа. Если оставить поле пустым, в социальных сетях будет опубликовано содержимое аналогичного поля в форме голосования.
• Описание — текстовое описание варианта ответа.

Клиентская часть

Общие функции:

• Клиентская часть модуля включает в себя страницы просмотра списка голосований на сайте и страницы отдельных голосований.
• При построении списка голосований используется постраничная навигация, отображаемая при помощи стандартного шаблона DataLife Engine navigation.tpl.
• Количество голосований, выводимых на одной странице, соответствует настройке скрипта «Количество новостей на странице».
• При корректной установке так же корректно на страницах модуля отображается модуль speedbar.

Страницы списка голосований формируются при помощи шаблонов snvote_poll_list.tpl и snvote_poll_list_item.tpl:

• snvote_poll_list.tpl — общий шаблон оформления списка голосований. В нём можно применить следующие теги:
  • {poll_list_items} — главный тег, содержащий вывод самого списка голосований, форматируемых при помощи шаблона snvote_poll_list_item.tpl
  • {navigation} — вывод постраничной навигации в случае, если содержимое списка голосований не умещается на одной странице. Навигация форматируется при помощи стандартного шаблона navigation.tpl
  • [first_page][/first_page] — блок тегов для вывода содержимого только на первой странице списка голосований
  • [pages][/pages] — блок тегов для вывода содержимого на второй и последующих страницах списка голосований
• snvote_poll_list_item.tpl — шаблон оформления одной позиции в списке голосований. В нём можно применить следующие теги:
  • {name} — Наименование голосования
  • {status} — Статус голосования
  • {image} — Изображение, символизирующее данное голосование
  • {time_start} — Время открытия голосования
  • {time_stop} — Время закрытия голосования
  • {description} — Текстовое описание голосования
  • {class_suffix} — Тег выводит «even» для четных позиций и «odd» для нечетных. Предназначен для оформления списка

Страницы просмотра отдельных голосований формируются при помощи шаблонов snvote_poll.tpl и snvote_poll_item.tpl:

• snvote_poll.tpl — общий шаблон оформления страницы просмотра отдельного голосования. В нём можно применить следующие теги:
  • {name} — Наименование голосования
  • {status} — Статус голосования
  • {image} — Изображение, символизирующее данное голосование
  • {time_start} — Время открытия голосования
  • {time_stop} — Время закрытия голосования
  • {description} — Текстовое описание голосования
  • {poll_items} — главный тег, содержащий вывод самого списка с вариантами ответов, форматируемых при помощи шаблона snvote_poll_item.tpl
• snvote_poll_item.tpl — шаблон оформления одной позиции в списке вариантов ответа. В нём можно применить следующие теги:
  • {name} — Наименование варианта ответа
  • {image} — Изображение, символизирующее данный вариант ответа
  • {description} — Текстовое описание варианта ответа
  • {count} — Общее количество голосов за данный вариант ответа
  • {class_suffix} — Тег выводит «even» для четных позиций и «odd» для нечетных. Предназначен для оформления списка
  • [vote_link][/vote_link] — блок тегов для вывода ссылки для осуществления голосования. Выводится только в случае, если голосование открыто и активно
  • [no_vote][/no_vote] — содержимое данного блока тегов выводится, если голосование не открыто или не активно, т.е. возможность голосовать отсутствует
  • [readmore_link][/readmore_link] — блок тегов для вывода ссылки «подробнее», ведущей на подробное описание данного варианта ответа

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

• Распакуйте архив с модулем
• Переименуйте папку /upload/templates/Default на название шаблона, используемого на Вашем сайте
• Скопируйте содержимое папки upload на Ваш сервер
• Отредактируйте необходимые файлы (см. ниже)
• Запустите файл http://site.ru/snvote_installer.php и следуйте его инструкциям

Редактирование файлов

Откройте файл /engine/engine.php

Найдите код:

switch ( $do ) {

После него вставьте код:

case "snvote" :
    include ENGINE_DIR . '/modules/snvote.php';
    break;

Найдите код:

elseif ($do == 'stats') $nam_e = $lang['title_stats'];

После него вставьте код:

elseif ($do == 'snvote') $titl_e = $metatags['title'];

Найдите код:

if ($config['allow_rss']) $metatags .= <<<HTML
 
<link rel="alternate" type="application/rss+xml" title="{$rss_title}" href="{$rss_url}" />
HTML;

После него вставьте код:

if(!empty($snvote_headers)) $metatags .= $snvote_headers;

Найдите код:

if ($titl_e) $s_navigation .= " » " . $titl_e;

После него вставьте код:

if($do=='snvote') $s_navigation = $snvote_speedbar;

Откройте файл .htaccess

Найдите код:

RewriteEngine On

После него вставьте код:

# Модуль SNVote
RewriteRule ^snvote/([0-9]+)-(.*).html(/?)+$ index.php?do=snvote&poll_id=$1&alt_name=$2 [L]
RewriteRule ^snvote/page/([0-9]+)(/?)+$ index.php?do=snvote&cstart=$1 [L]
RewriteRule ^snvote(/?)+$ index.php?do=snvote [L]

Удаление модуля

• Загрузите файл snvote_uninstaller.php на сервер
• Запустите его и следуйте инструкциям
• Не забудьте удалить файл snvote_uninstaller.php

Скачать модуль SNVote

АКТУАЛЬНАЯ ВЕРСИЯ: ver.1.0 — snvote_v.1.0
АРХИВ ВЕРСИЙ: —
ЖИВОЙ ПРИМЕР: http://www.winterlife.ru/snvote

История развития (History Log)

• 31.08.2011: v.1.0 — Паблик релиз.

Текущие баги и что с ними делать!

• Обнаружен баг. В поле «Текст для публикации в соцсетях» недопустимы переносы на новую строку. При наличии таких переносов голосование перестаёт работать. Баг будет исправлен в следующей версии модуля.
  • Временное решение — при написании текста для соц-сетей не нажимайте enter — пишите описание в одну строку.

Запланированное развитие модуля

Есть еще много интересных решений, которые пока еще не внедрены в модуль:

• Добавление социальной сети my.mail.ru
• Поиск решения для зашиты от накрутки
• Вывод голосования на любую страницу методом {include file="/engine/modules/snvote.php?...параметры..."}
• Предложенные вами идеи ;)

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

Ну вот, вроде бы все основные моменты описаны, можете приступать к тестированию на своих сайтах.

И да, не будьте мудаками — не удаляйте копирайт!

Жду от вас отзывов, предложений, а самое главное — сообщайте обо всех найденных ошибках или неточностях в комментариях, все оперативно поправим.