Файл описания мастера создания сайта

Array

В файле .description.php определяется массив $arWizardDescription, который описывает характеристики мастера. Структура типичного файла .description.php такова:

<?
if(!defined("B_PROLOG_INCLUDED") || B_PROLOG_INCLUDED!==true)die();

$arWizardDescription = Array(
    "NAME" => "Сайт компании", 
    "DESCRIPTION" => "Мастер создания сайта компании", 
    "ICON" => "images/icon.gif",
    "VERSION" => "1.0.3",
    "DEPENDENCIES" => Array( 
        "main" => "6.0.5",
    ),

    "TEMPLATES" => Array(
        Array("SCRIPT" => "scripts/wizard_template.php", "CLASS" => "DemoSiteTemplate")
    ),

    "STEPS_SETTINGS" => Array(
        "WELCOME" => Array(
            "CONTENT" => "Добро пожаловать в мастер создания сайта компании",
        ),

        "START_INSTALL" => Array(
        "CLASS" => "MyStartInstall",
        "SCRIPT" => "scripts/start_install.php",
        ),
    )
);

?>

Массив $arWizardDescription может иметь следующие ключи:

"NAME" – название мастера;
"DESCRIPTION" – описание мастера;
"VERSION" – версия мастера;
"ICON" – иконка мастера, путь к файлу относительно папки мастера;
"CHARSET" - кодировка файлов мастера. Используется для создания дистрибутива с решением.
"DEPENDENCIES" – зависимости мастера от модулей. Значением этого ключа должен быть массив вида Array("ID модуля"=>"версия модуля" [, ...]);
"TEMPLATES" – шаблоны мастера. Значением этого ключа должен быть массив, элементами которого должен быть массив, имеющий следующие ключи:
- "CLASS" – имя класса, описывающего шаблон;
- "SCRIPT" – путь к файлу, в котором определён класс шаблона относительно папки мастера;
- "STEP" – ID шага, для которого определяется шаблон. Если ключ "STEP" не указан, шаблон будет определён для всех шагов мастера.
"STEPS_SETTINGS" – настройки системных шагов. Значением этого ключа является массив, описывающий настройки системных шагов. Массив состоит из элементов следующего вида:
"Код системного шага" => Array(
   "TITLE" => заголовок шага,
   "SUBTITLE" => подзаголовок шага,
   "CONTENT" => описание шага,
   "CLASS" => имя класса, определяющего пользовательский шаг,
   "SCRIPT" => путь к файлу, в котором определён класс CLASS и/или классы STEPS относительно папки мастера,
   "STEPS" => массив названий классов вида Array("ID шага" => "Название класса шага"), определяющих дополнительные шаги после системных шагов Приветствие, Лицензионное соглашение, Готовность к установке, Установка завершена, Установка прервана;
)
Код системного шага может принимать следующие значения:
- WELCOME – шаг Приветствие;
- LICENSE – шаг Лицензионное соглашение;
- SELECT_SITE – шаг Выбор сайта;
- SELECT_GROUP – шаг Выбор группы шаблона;
- SELECT_TEMPLATE – шаг Выбор шаблона;
- SELECT_SERVICE – шаг Выбор сервисов;
- START_INSTALL – шаг Готовность к установке;
- INSTALL_SITE – шаг Установка сайта;
- INSTALL_TEMPLATE – шаг Установка шаблона;
- INSTALL_SERVICE – шаг Установка сервиса;
- FINISH – шаг Установка завершена;
- CANCEL – шаг Установка прервана;
Только шаги Приветствие, Готовность к установке, Установка завершена, Установка прервана можно подменить на собственные пользовательские шаги. Для этого необходимо в ключах CLASS и SCRIPT указать имя класса и путь к файлу, в котором определён класс, соответственно.

Наверх