Модуль для 1С:Битрикс

Материал из Alawar
Перейти к: навигация, поиск

Введение

Модуль «Витрина Alawar» – программный модуль системы управления 1С-Bitrix, позволяющий принять участие в партнерской программе Alawar и развернуть витрину с игровым контентом Alawar. Это позволит увеличить монетизацию любого интернет-ресурса.

Данный документ описывает установку и внедрение этого модуля и предназначен для программистов.


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

Для установки модуля необходимо скачать архив модуля из Marketplace компании 1C-Bitrix по указанной ссылке:


Marketplace компании 1С-Bitrix


Модуль необходимо скачать и распаковать в папку /bitrix/modules/alawar.agsn так, чтобы структура папок выглядела вот так:


-bitrix
--modules
---alawar.agsn
----admin
----classes
----install
----lang
----include.php
----option

Далее необходимо зайти в Административную часть управления Битрикс и перейти на вкладку управления модулями в пункте Настройки – Настройки продукта – Модули (ссылка http://host/bitrix/admin/module_admin.php?lang=ru , где host – адрес хоста Вашего сайта) и нажать кнопку «Установить».

Bitr 1.png

После успешной установки статус модуля станет «Установлен»:

Bitr 2.png

Модуль установлен. Далее необходимо перейти к настройке модуля.

Настройка модуля

Параметры модуля

Страница настройки модуля находится в пункте меню Настройки – Настройки продукта – Настройки модуля – Витрина Alawar (ссылка http://host/bitrix/admin/settings.php?lang=ru&mid=alawar.agsn&mid_menu=1 ). Страница настройки модуля имеет следующий вид:

Bitr 3.png

Рассмотрим параметры настройки витрины:

  • Ссылка на XML – необходимо указать ссылку на XML для Вашей партнерской записи в партнерской программе Alawar. Ссылка должна выглядеть вот так http://export.alawar.ru/games_agsn_xml.php?pid={pid}&lang=ru, где {pid} – Ваш идентификатор в партнерской программе Alawar (PID).

Ссылку брать тут http://partner.alawar.ru/vitr/vconfig/xml/. Если Вы ещё не зарегистрировались, то сделать можно это тут http://partner.alawar.ru/signup.php .

  • Добавлять новые игры неактивными – при обновлении новые игры добавляются неактивными и редактор сайта имеет возможность отредактировать описания игры;
  • Обновлять PC-игры? – позволяет загрузить и отображать на витрине каталог PC-игр;
  • Обновлять онлайн-игры? – позволяет загрузить и отображать на витрине каталог онлайн-игр;
  • Режим обновления – позволяет выбрать надежный вариант обновления данных витрины при ограничениях хостинга;
  • Лимит времени в секундах для пошагового обновления – позволяет выбрать интервал шага при обновлении данных. Рекомендуемое значение составляет 30 секунд;
  • Загружать картинки в папку upload? – позволяет сохранить всю графику игр на сайте. Внимание! Объем всей графики игр составляет несколько гигабайт, что может привести к увеличению затрат на хостинг.
  • Включить обновление записей из XML? – необходимо включить эту опцию, когда все параметры настроены.

После корректного заполнения полей, необходимо нажать кнопку «Сохранить».

Обновление данных

После сохранения данных необходимо пройти на вкладку «Обновить данные» и произвести загрузку данных на витрину, нажав кнопку «Обновить сейчас!»:

Bitr 4.png

Процесс обновления может занять несколько минут.

После корректной загрузки данных лог обновления должен выглядеть вот так:

Bitr 5.png

Данные на витрину успешно загружены.


В случае ошибок попробуйте повторить обновление данных, нажав последовательно кнопки «Сбросить дату» и «Обновить сейчас!».

Работа с данными витрины

После успешной загрузки данных Вы можете редактировать в инфоблоках «PC-игры» и «Онлайн-игры» по в пунктах меню «Контент» - «Игры Alawar» - «PC игры» и «Контент» - «Игры Alawar» - «Онлайн игры».

Bitr 6.png

Так, страница редактирования описания игры «Фантазмат» будет выглядеть вот так:

Bitr 7.png

Варианты подключения витрины

Для того чтобы отобразить витрину на Вашем сайте, необходимо выбрать один из способов отображения контента. Вариантов отображения игрового контента несколько:

1. Использование комплексного компонента – самый простой способ
2. Использование простых компонентов – способ индивидуального подключения витрины
3. Использование шаблона сайта – наиболее подходящий вариант, когда у вас нет своего шаблона сайта

Список компонентов по отображению витрины

В модуле доступны компоненты Битрикс (подробнее по их использованию тут), которые облегчают работу с контентом витрины. Список компонентов представлен ниже в таблице.

Название компонента Описание Вариант использования
agsn.games Комплексный компонент. Выводит витрину целиком. <?$APPLICATION->IncludeComponent(
"alawar:agsn.games",
"mini",
Array()
);?>
agsn.games.content Компонент выводит списки игр и страницу с подробным описанием игры. Есть дополнительные параметры жанров и тип каталога <?$APPLICATION->IncludeComponent(
"alawar:agsn.games",
"mini",
Array()
);?>
agsn.games.detail Компонент вывода подробной информации об игре <?$APPLICATION->IncludeComponent(
"alawar:agsn.games.detail",
"mini",
Array(
"CODE" => $code,
"CACHE_TIME" => $arParams
"CACHE_TIME"],
),
);?>
agsn.games.list Компонент вывода списка игр. Есть дополнительные параметры жанров и тип каталога <?$APPLICATION->IncludeComponent(
"alawar:agsn.games.list",
"mini_list",
Array(
"COUNT" => "36",
"TITLE" => GetMessage('hit games'),
"ORDER" => array("SORT" => "DESC"),
"SECTION_CODE" => $sectionCode,
"DETAIL_URL" => $detailUrl,
"CACHE_TIME" => $arParams["CACHE_TIME"],
),);?>
agsn.menu.catalogs Компонент вывода меню каталогов игр (PC и онлайн игр) <?$APPLICATION->IncludeComponent(
"alawar:agsn.menu.catalogs",
"mini",
Array(
"ONLINE_LIST_URL" => $onlineListUrlTmpl,
"CASUALPCGAMES_LIST_URL" => $ casualpcgamesListUrlTmpl,
"PAGE_NAME" => $pageName,
),
);?>
agsn.menu.genres Компонент вывода меню игр - жанры для PC игр <?$APPLICATION->IncludeComponent(
"alawar:agsn.menu.genres",
"mini",
Array(
"GENRE_CODE" => $sectionCode,
"LIST_URL" => $listUrlTmpl,
"PC_CATALOG_URL" => casualpcgamesListUrlTmpl,
"PC_CATALOG_NEWGAMES_URL" => $newgamesUrlTmpl,
"PAGE_NAME" => $pageName,
),
);?>
agsn.onlinegames.detail Компонент вывода страницы подробного описания онлайн-игры <?$APPLICATION->IncludeComponent(
"alawar:agsn.onlinegames.detail",
"mini",
Array(
"CODE" => $code,
"CACHE_TIME" => $arParams["CACHE_TIME"],
),);?>
agsn.onlinegames.list Компонент вывода списка онлайн-игр <?$APPLICATION->IncludeComponent(
"alawar:agsn.onlinegames.list",
"mini",
Array(
"COUNT" => "23",
"TITLE" => GetMessage('online hit games'),
"ORDER" => array("SORT" => "DESC"),
"SECTION_CODE" => $sectionCode,
"DETAIL_URL" => $onlineDetailUrlTmpl,
"CACHE_TIME" => $arParams["CACHE_TIME"],
),);?>

Все компоненты поддерживают параметр кеширования результата вывода CACHE_TIME.


Использование комплексного компонента

Для того чтобы развернуть витрину в один клик, Вам необходимо разместить следующий код на одной из страниц своего сайта:

<?$APPLICATION->IncludeComponent(
       "alawar:agsn.games",
       "",
       Array()
);?>


Вторым параметром Вы можете изменять шаблон отображения компонентов – dark или mini или другой предоставленный шаблон. Например,

<?$APPLICATION->IncludeComponent(
       "alawar:agsn.games",
       "mini",
       Array()
);?>

У данного компонента имеется несколько параметров гибкой настройки. Подробнее смотрите в описании компонента. Скрин данного метода подключения:

Bitr 8.png

Использование простых компонентов

В случае, когда необходимо разместить разные блоки витрины с играми в разные места страницы, необходимо выбрать данный способ подключения. В этом варианте разные компоненты витрины (например, блок новых игр или меню витрины) размещается в индивидуальном месте. Блок TOP-10 в правой колонке:

<?$APPLICATION->IncludeComponent(
"alawar:agsn.games.list",
"dark_top",
Array(
       "COUNT" => "6",
       "TITLE" => GetMessage('Top games'),
       "DETAIL_URL" => $APPLICATION->GetCurPage()."?game=#CODE#",
       "CACHE_TIME" => $arParams["CACHE_TIME"],
       "TITLE_ALL_GAMES" => GetMessage('all new games'),
)
);?>

Блок меню в произвольном месте:

<?$APPLICATION->IncludeComponent(
"alawar:agsn.menu.genres",
"dark",
Array(
       "GENRE_CODE" => $_GET['genre'],
       "LIST_URL" => htmlspecialchars($APPLICATION->GetCurPage()."?genre=#CODE#"),
       "PC_CATALOG_URL" => $APPLICATION->GetCurPage()."",
       "PC_CATALOG_NEWGAMES_URL" => $APPLICATION->GetCurPage()."?newgames=1",
)
);?>


Основной блок (отображения списков игр и отображения страницы игры), в блоке основного контента: <? $APPLICATION->IncludeComponent( "alawar:agsn.games.content", "dark", array(

       "COUNT" => "22",

), );?>


Использование шаблона сайта

Этот метод подходим тем программистам, у которых нет своего шаблона сайта Битрикс и они готовы сделать сайт полностью под игры. Для интеграции этого метода Вам необходимо воспользоваться кастомным компонентом alawar:agsn.games (полностью аналогичным способом в п.1.):

<?$APPLICATION->IncludeComponent(
       "alawar:agsn.games",
       "",
       Array()
);?>

Разместив этот код, например, в разделе /content/alawar_games/ И в настройках сайта Битрикса указать использование шаблона сайта Mini для указанного раздела:

Bitr 9.png

После чего необходимо сохранить результат. Выглядит этот шаблон вот так:

Bitr 10.png

В модуле витрины доступны шаблоны Mini и Full dark:

Bitr 11.png


Обратная связь

При возникновении вопросов по использованию данного модуля или предложений, просьба обращаться по e-mail partner@alawar.ru