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

Файлы папки с обновлением:

• /install/version.php - файл содержит номер версии обновления и дату его выпуска. Обязательный файл.
• description.* - содержит описание обновления, где * - идентификатор языка в системе. Например, описание обновления модуля на русском языке будет содержаться в файле description.ru, на английском - description.en. Обязательный файл.
  В описании допустимо использование html тегов: <b>,<i>,<u>,<li>,<ul>,<span>,<p>, <br>
• updater.php – файл запускается при установке обновления. С помощью этого файла выполняются действия для обновления на новую версию. Файл может содержать произвольный PHP код, который выполняется в контексте сайта. Необязательный файл.
  В каждом обновлении может быть только один апдейтер. Но может и не быть ни одного, если требуется обновить только ядро.
• version_control.txt - служит для организации связи между версиями модулей. Файл содержит ссылки на версии модулей, от которых зависит данное обновление. Например, файл может содержать iblock,13.8.0. Это означает, что данное обновление будет установлено, если в системе установлен модуль Информационные блоки версии не ниже 13.8.0. Либо модуль Информационные блоки не установлен вообще. Необязательный файл.

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

• Создайте каталог с названием версии обновления. Например, 0.0.2, 0.0.5 и т.д.
• Скопируйте в созданную папку файлы и каталоги обновления модуля.
• Заархивируйте папку в формат .zip или .tar.gz.

В результате должно получиться, например, 0.0.2.zip, 0.0.5.zip. Например, папка с обновлением может иметь следующую структуру:

  Обновление

Все файлы обновления просто копируются как есть в папку модуля. И если ваш модуль полностью расположен в этом каталоге, то обновление завершено. Если же по логике работы модуля требуется чтобы часть файлов была вне ядра, в какой-либо другой папке, то с помощью updater.php нужно перенести их в нужное место.

Механизм апдейтеров (updater.php) служит именно для того, чтобы применить необходимые изменения к тем частям сайта, которые не являются ядром. С помощью этого механизма можно привести структуру базы данных, системные и публичные файлы в соответствие с текущей версией ядра.

Если возникла необходимость скопировать файлы в обновлении самостоятельно, то нужно использовать:

$updater->CopyFiles("install/classes", "modules/quintura.search/classes");

В этом случае файлы из папки /install/classes, находящиеся в папке обновления, скопируются в папку /local/modules/quintura.search/classes.

При выпуске последующих обновлений может возникнуть потребность установить его зависимость от новых модулей. Ссылки на версии модулей, от которых зависит данное обновление, содержатся в файле version_control.txt. Но необходимо помнить, что само обновление с зависимостью не будет по умолчанию требовать установки указанных модулей. В этом случае возможны два варианта:

1. Обновление всё равно устанавливать, проверять присутствие нужного модуля уже в функционале модуля.
2. Добавить в код обновления проверку на нужный модуль, и при его отсутствии выводить ошибку пользователю. Обновление не будет установлено, если присвоить переменной $errorMessage строку сообщения.