Руководство по работе с партнерскими модулями и решениями Содержание

Скачать 264.1 Kb.

Название	Руководство по работе с партнерскими модулями и решениями Содержание
страница	1/6
Дата конвертации	14.12.2012
Размер	264.1 Kb.
Тип	Руководство

1 2 3 4 5 6

1С-Битрикс: Управление сайтом

Руководство по работе с партнерскими модулями и решениями

Содержание

Введение 3

Глава I. Подготовка архивов модуля и обновлений 4

Создание модуля 4

Структура полной сборки модуля 4

Задание демо-режима для модулей 7

Обновления модулей 7

Структура обновления модуля 7

Глава II. Размещение модуля в партнерской системе обновлений 9

Загрузка модуля 9

Загрузка обновлений 12

Расшифровка ошибок 13

Глава III. Работа с клиентами модуля 14

Скрипт для автоматической работы с клиентами модуля 14

Глава IV. Решения типовых сайтов 16

Примерный порядок создания мастера установки решения 16

Особенности, которые необходимо учитывать 16

Переустановка сайта 16

Инфоблоки, каталоги, блоги и прочее 17

Многосайтовость 17

Включаемые области 17

Другие моменты 18

Некоторые константы 18

Глава V. Установка модуля 20

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

Установка обновлений 22

Глава VI. Частые ошибки 24

Ошибки при создании модулей 24

Не запускается мастер после установки продукта 24

В состав модуля не добавляется файл с указанием версии 24

Ошибки при создании решений 24

Не импортируется часть свойств инфоблоков 24

Приложение 25

Пример класса для модуля alexey.mycar 25

Заключение 28

Введение

Расширить функционал проектов на основе "1С-Битрикс: Управление сайтом" позволяют сторонние модули и решения.

Руководство предназначено для партнеров «1С-Битрикс», которые хотят распространять (например, продавать) свои модули. В документе рассматриваются вопросы, связанные с созданием и загрузкой модулей и решений в систему Marketplaсe.

Если у вас возникнут вопросы по продуктам компании "1С-Битрикс", вы можете обратиться в службу Технической поддержки (http://dev.1c-bitrix.ru/support/).

Глава I.Подготовка архивов модуля и обновлений

Система "1С-Битрикс: Управление сайтом" поставляется в различных редакциях. Каждая редакция представляет собой комбинацию стандартных модулей. При этом у партнеров есть возможность создавать свои собственные модули и распространять их через партнерскую систему обновлений. Количество модулей в системе не ограничено.

Глава содержит информацию о предварительных операциях со структурой файлов и папок, необходимых для сборки архивов модуля и обновлений.

Создание модуля

Партнерские модули отличаются от стандартных модулей следующим:

код модуля - полный код партнерского модуля, который задается в формате «код_партнера».«код_модуля». Часть «код_партнера» постоянна для партнера (задается в карточке партнера). Часть «код_модуля» вводится партнером при добавлении нового модуля. Эти коды должны быть алфавитно-цифровыми с первым алфавитным символом, и код неким образом должен соответствовать сути модуля. Например, для модуля форума желательно задать код forum. Тогда полный код будет mycompany.forum.
в файле /install/index.php кроме той информации, которая задается в любом стандартном модуле, необходимо еще указать:

$this->PARTNER_NAME = "Имя партнера - автора модуля";
$this->PARTNER_URI = "http://www.mysite.ru";

У клиента эта информация будет доступна в списке модулей.

Внимание! Модуль необходимо создавать в кодировке windows-1251, при установке его на сайт с кодировкой UTF-8 происходит автоматическая перекодировка.

Структура полной сборки модуля

Полная сборка модуля предназначена для первоначальной установки модуля (когда этого модуля ещё нет у клиента или партнера).

Полная сборка должна содержать следующую структуру обязательных файлов модуля:

/install/index.php - файл с описанием модуля, содержащий инсталлятор/деинсталлятор модуля;

/install/version.php - файл с номером версии модуля;
/include.php – подключаемый файл (файл подключается при подключении модуля во время выполнения скриптов сайта), в нем должны находиться включения всех файлов с библиотеками функций и классов модуля.

Все остальные файлы могут быть включены в модуль (могут отсутствовать), если это необходимо.

Примечание: подробная информация о структуре файлов модуля содержится в документации для разработчиков.

Перед загрузкой модуля на сайт необходимо запаковать полную сборку модуля в архив. Для этого выполните следующее:

Создайте папку .last_version.
Скопируйте в неё все файлы для полной сборки.
Заархивируйте папку .last_version в формат .zip или .tar.gz

В итоге должен получиться архив с именем .last_version.zip (.last_version.tar.gz). Для типичного модуля полная сборка может иметь следующую структуру каталогов и файлов (Рис. 1 .1):

Рис. 1.1 Пример структуры модуля

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

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

Если в силу каких-то причин необходимо запретить загрузку обновлений для каких-то пользователей (через год, например, или при новой версии), то достаточно отвязать клиента от модуля. Модуль у него останется, но обновляться он не сможет.

Полезные методы

WizardServices::SetFilePermission($path, $permissions)	по сигнатуре эквивалентен $APPLICATION->SetFileAccessPermission($path, $permissions), но с более правильной логикой добавления прав доступа (не затирает существующие права).
WizardServices::AddMenuItem($menuFile, $menuItem, $siteID)	добавление пункта меню
WizardServices::IncludeServiceLang($relativePath, $lang = false, $bReturnArray = false)	подключает произвольный языковой файл сервиса
ImportIBlockFromXML($xmlFile, $iblockXmlID, $iblockType, $siteID, $permissions = Array())	импорт инфоблока.

Если метод используется более чем в одном месте выносите его в класс WizardServices.

Сторонние библиотеки

Использование сторонних библиотек возможно если соблюдаются все лицензионные ограничения разработчиков библиотек. Если используется сторонняя библиотека, то необходимо проверить чтобы имена объектов/классов/функций не совпадали с системными.

Библиотеку не стоит размещать в папке /bitrix/modules/ (См. Структура полной сборки модуля). Необходимые для работы модуля файлы лучше положить в ваш модуль, для удобства последующего обновления. Пользовательские же файлы с подобными файлами обычно кладутся в /bitrix/php_interface/.

Пункт в меню админки

Если необходимо добавить в меню админки пункты вашего модуля, то необходимо использовать событие OnBuildGlobalMenu (http://dev.1c-bitrix.ru/api_help/main/events/onbuildglobalmenu.php).

Пример использования события для добавления собственного пункта в «Список пользователей»:

AddEventHandler("main", "OnBuildGlobalMenu", "MyOnBuildGlobalMenu");
function MyOnBuildGlobalMenu(&$aGlobalMenu, &$aModuleMenu)
{
   foreach($aModuleMenu as $k => $v)

   {
      if($v["parent_menu"] == "global_menu_settings" && $v["items_id"] == "menu_users")

      {
         $aModuleMenu[$k]["items"][] = Array(

               "text" => "Кастомный пункт пользователей",

               "url" => "user_custom.php?lang=".LANG,

               "title" => "Своя страница пользователей"

            );
      }
   }
}

Задание демо-режима для модулей

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

В модуле могут быть заданы следующие ограничения:

По новой технологии файлы include.php и install/index.php буду обфурцированны.
В файл include.php будет добавлен код проверки триального режима и его срока
В файл install/index.php будет добавлен код, который будет устанавливать дату установки модуля для дальнейших проверок.

Кроме этого, для подключения модулей теперь можно использовать новую функцию CModule::IncludeModuleEx($module_name). Отличие ее от стандартной CModule::IncludeModule() в том, что она в качестве результата может возвращать:

MODULE_NOT_FOUND (0) - модуль не найден (например скопировали ваши компоненты из модуля, а модуль удалили);

MODULE_INSTALLED (1) - модуль установлен и подключен;

MODULE_DEMO (2) - модуль работает в демо-режиме (например можно вывести сообщение, что вы можете купить версию без ограничений);

MODULE_DEMO_EXPIRED (3) - срок работы демо-режима модуля истек.

Если ваш модуль содержит только компоненты, то рекомендуется часть их функционала вынести в include.php, для того чтобы компоненты не работали без модуля.