Документация для разработчиков

Файл описания мастера .description.php

Файл .description.php содержит название, описание, а также ряд других характеристик мастера. Этот файл должен всегда присутствовать в папке мастера. Языковой файл подключается автоматически (должен лежать в папке /lang/<язык>/.description.php относительно папки мастера).

Структура типичного файла .description.php такова:

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

$arWizardDescription = Array(
    "NAME" => GetMessage("WD_TITLE"), 
    "DESCRIPTION" => GetMessage("WD_TITLE_DESCR"), 
    "ICON" => "images/icon.gif",
    "VERSION" => "1.0.0",
    "DEPENDENCIES" => Array( 
        "main" => "6.5.0",
        "sale" => "6.0.0",
        "currency" => "6.0.0",
    ),
    "STEPS" => Array("Step0", "Step1", "Step2", "Step3", "Step4", "Step5","Install", "FinalStep", "CancelStep"),

    "TEMPLATES" => Array(
        Array("SCRIPT" => "wizard_template.php", "CLASS" => "DemoSiteTemplate"),
    ),
);
?>

В файле определяется массив $arWizardDescription, который описывает мастер. Этот массив может иметь следующие ключи:

  • "NAME" – название мастера;
  • "DESCRIPTION" – описание мастера;
  • "ICON" – иконка мастера, путь к файлу относительно папки мастера;
  • "VERSION" – версия мастера;
  • "DEPENDENCIES" – зависимости мастера от модулей. Значением этого ключа должен быть массив вида Array("ID модуля"=>"версия модуля" [, ...]);
  • "STEPS" – массив названий классов, определяющих шаги в файле wizard.php;
  • "TEMPLATES" – шаблоны мастера. Значением этого ключа должен быть массив, элементами которого должен быть массив, имеющий следующие ключи:
    • "CLASS" – имя класса, описывающего шаблон;
    • "SCRIPT" – путь к файлу, в котором определён класс шаблона относительно папки мастера;
    • "STEP" – ID шага, для которого определяется шаблон. Если ключ "STEP" не указан, шаблон будет определён для всех шагов мастера.

По умолчанию первый элемент в массиве названий классов является первым шагом мастера. Именно этот шаг появляется при запуске мастера. Изменить первый шаг мастера можно динамически с помощью метода CWizardBase::SetFirstStep.



Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2019, «1С-Битрикс», 2019
Наверх