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

Класс CWizardBase

Описание

Класс СWizardBase является оболочкой мастера и содержит методы общие для всех шагов (работа с переменными мастера, управление кнопками навигации и др.). Для каждого подключаемого мастера создаётся экземпляр класса СWizardBase. Для получения доступа к методам класса СWizardBase в теле переопределяемых функций (InitStep, ShowStep, OnPostFrom) нужно получить объект мастера с помощью метода CWizardStep::GetWizard:

<?
class MyFirstStep extends CWizardStep
{
    function InitStep()
    {
        $wizard =& $this->GetWizard(); //Получаем ссылку на объект мастера
        $myVar = $wizard->GetVar("myVar"); //Используем метод мастера (класс CWizardBase)
    }
}
?>

Список методов

Метод Описание С версии
CWizardBase Конструктор.
AddStep Метод добавляет в мастер новый шаг.
AddSteps Метод добавлет шаги в мастер.
DisableAdminTemplate Метод запрещает использовать системный шаблон.
Display Метод выводит содержимое мастера на экран.
GetCancelButtonIDВозвращает значение атрибута name кнопки Отмена.
GetCancelStepIDВозвращает ID шага, на который ссылается кнопка Отмена.
GetCurrentStepМетод возвращает ссылку на объект текущего шага.
GetCurrentStepIDМетод возвращает ID текущего шага.
GetDefaultVar Метод возвращает значение по умолчанию для переменной varName.
GetDefaultVars Метод возвращает массив со значениями по умолчанию для всех переменных.
GetFinishButtonID Метод возвращает значение атрибута name кнопки Готово.
GetFinishStepID Возвращает ID шага, на который ссылается кнопка Готово.
GetFormActionScript Метод возвращает значение атрибута action формы мастера.
GetFormName Метод возвращает значение атрибута name формы мастера.
GetNextButtonID Метод возвращает значение атрибута name кнопки Далее.
GetNextStepID Возвращает ID шага, на который ссылается кнопка Далее.
GetPackage Метод возвращает ссылку на объект класса CWizard. 6.5.3
GetPrevButtonID Метод возвращает значение атрибута name кнопки Назад.
GetPrevStepID Возвращает ID шага, на который ссылается кнопка Назад.
GetRealName Метод возвращает имя переменной с префиксом.
GetVar Метод возвращает значение переменной varName.
GetVarPrefix Метод возвращает префикс для переменных мастера.
GetVars Метод возвращает массив значений всех переменных мастера.
GetWizardName Метод возвращает название мастера.
GetWizardStepsМетод возвращает ассоциативный массив шагов мастера.7.0.2
IsCancelButtonClickМетод возвращает true, если была нажата кнопка Отмена.
IsFinishButtonClickМетод возвращает true, если была нажата кнопка Готово.
IsNextButtonClick Метод возвращает true, если была нажата кнопка Далее.
IsPrevButtonClick Метод устанавливает значение атрибута name кнопки Назад.
SetCancelButtonID Метод устанавливает значение атрибута name кнопки Отмена. 6.5.3
SetCurrentStep Метод устанавливает шаг stepID текущим.
SetDefaultVar Метод устанавливает для переменной varName значение по умолчанию varValue. 6.5.3
SetDefaultVars Метод устанавливает переменным мастера значения по умолчанию.
SetFinishButtonID Метод устанавливает значение атрибута name кнопки Готово. 6.5.3
SetFirstStep Метод устанавливает шаг stepID первым в цепочке шагов мастера.
SetFormActionScriptМетод устанавливает значение атрибута action формы мастера.
SetFormNameМетод устанавливает значение атрибута name формы мастера.
SetNextButtonIDМетод устанавливает значение атрибута name кнопки Далее.6.5.3
SetPrevButtonIDМетод устанавливает значение атрибута name кнопки Назад.6.5.3
SetReturnOutputМетод устанавливает флаг возврата в значение mode.
SetTemplateМетод устанавливает шаблон obStepTemplate для шага stepID.
SetVarУстанавливает переменную мастера varName в значение varValue.
SetVarPrefixМетод устанавливает префикс для переменных мастера.
UnSetVar Уничтожает переменную с именем varName.


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

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

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

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

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