1. class
  2. XELOS
  3. \
  4. Framework
  5. \
  6. XF
  7. \
  8. UI
  9. \
  10. Wizard

Wizard

class Wizard extends UIAjaxComponent

Constants

SYSTEM_TEMPLATE_UI_FOLDER

CONTROL_NEXT

CONTROL_PREV

CONTROL_FINAL

STATE_PROCESSING

STATE_STOPED

Properties

$xf_link from  UIComponent
$link_id from  UIComponent
array $GPvars from  UIComponent
$mod
protected array $local_template_marker from  UIComponent
protected bool $_overwrite_param_array from  UIComponent
protected bool|array|ModelCollection $marker_content from  UIComponent
string $mod_object_manager from  UIComponent
protected bool $_orig_marker_content from  UIComponent
protected array $_allowed_params_filter from  UIComponent
string $unique_dom_id from  UIComponent
protected string $uid from  UIComponent
string read-only $_content

When used in template this property will contain the XML/HTML within the XUI Nodes

 from  UIComponent
$link from  UIAjaxComponent
protected string $js_class from  UIAjaxComponent
protected array $js_options from  UIAjaxComponent
protected array $css_classes from  UIAjaxComponent
protected array $xui_payload from  UIAjaxComponent
protected bool $deferredLoading from  UIAjaxComponent
protected bool $deferredLoadingMessage from  UIAjaxComponent
$wizardData
protected $stepContentCallbacks
protected $finalCallback
protected $currentStepContent
protected $isNextEnabled
protected $isPrevEnabled
protected $ajax_reload_interval

Methods

__construct($wizardID = false, $defaultStep = 1)

UIComponent constructor.

string
__toString()

No description

from  UIComponent
add_css_class($css_class)

Adds a custom css class to the root element of this component.

from  UIAjaxComponent
add_data(mixed $data)

put your comment there.

add_dependency(string $dep_name, UIAjaxComponent $dep_obj, bool $reloadOnUpdate = false)

Add a new UIAjaxComponent object and register it under a certain name this component will use that name to retrieve the object in order to interact with it.

from  UIAjaxComponent
add_step(mixed $title, mixed $content)

put your comment there.

add_step_callback(mixed $title, array $callback, $ajax_content = false)

put your comment there.

add_url_parameter(mixed $key, mixed $value)

Adds a parameter to url parameter list.

from  UIAjaxComponent
buildControlBar()

put your comment there.

disable_control_next()

put your comment there.

disable_control_prev()

put your comment there.

enable_control_next()

put your comment there.

enable_periodical_update(int $interval)

Enables the periodical update via ajax.

from  UIAjaxComponent
mixed
get($var)

Get Variable / Option

from  UIComponent
string
getPlaceholderContent()

Returns a placeholder which is used to display while this component is loading the content.

from  UIAjaxComponent
get_data(mixed $key = false)

put your comment there.

mixed
get_dependency($dep_name)

Returns a dependent object in order to interact with it

from  UIAjaxComponent
get_model()

put your comment there.

string
get_unique_dom_id()

Generates a unique dom id, dependent on the provided UID, as well as the current context.

Template|null
get_view(string|bool $section = false)

Return new template view If using within module xui the tpl file should be named [class_name].tpl e.g. xui_core_table.tpl within the module's template folder

from  UIComponent
init()

put your comment there.

from  UIComponent
next_step()

put your comment there.

string
parse_template(string $template_content, array|bool $marker_array = false)

No description

from  UIComponent
string|null
parse_template_cb_wrapper(mixed $matches)

No description

from  UIComponent
mixed|string
parse_xtag($xml_source)

No description

from  UIComponent
prev_step()

put your comment there.

process()

dummy process method - may be overwritten

from  UIAjaxComponent
process_xui()

put your comment there.

remove_control()

put your comment there.

remove_data($key)

No description

render()

Default render method. wraps the content provided by render_xui_content in a unique div and generates a JS object for the GUI

from  UIAjaxComponent
mixed
render_xtag_element()

No description

from  UIComponent
string|Template
render_xui()

Render the Wizard template and assign marker to template. If the wizard has the step control, a control form will be assigned to template, in other case the callback method is responsible for step controlling.

void
reset_marker_content()

restores original content of marker_content

from  UIComponent
void
set(mixed $var, mixed $value = false)

Set Variable / Option

from  UIComponent
void
setDeferredLoading(bool $bool, string $message = '')

Set true to load the content deferred. Displays a placeholder while loading the content. Optional you can pass a message which will replace the default loading message.

from  UIAjaxComponent
set_ajax_update_interval(mixed $sec)

Sets the interval for periodical update of ajax container.

void
set_array(mixed $member_array, mixed $vars)

Set Variable / Option for an array

from  UIComponent
set_final_callback(array $callback, $redirect_url = false)

put your comment there.

void
set_marker_content(mixed $marker_content = false)

sets marker_content to passed data -> restore original content with reset_marker_content()

from  UIComponent
set_mod(mixed $mod)

Set link to owning module

from  UIComponent
set_model(mixed $model)

put your comment there.

set_option(string $key, mixed $val)

Sets options. This options will be used in the JS element of this XUI class.

from  UIAjaxComponent
void
set_render_params(mixed $input_params = array())

Used to inject params. Only allowed params will be used (see $allowed_params_filter)

from  UIComponent
set_uid($uid)

No description

from  UIAjaxComponent
set_url_parameters(array $parameters)

Sets the url parameter that is used for component loading.

from  UIAjaxComponent
take_control()

put your comment there.

updateWizardData()

put your comment there.

Details

at line 48
__construct($wizardID = false, $defaultStep = 1)

UIComponent constructor.

Parameters

$wizardID
$defaultStep

in UIComponent at line 324
string __toString()

No description

Return Value

string

in UIAjaxComponent at line 139
add_css_class($css_class)

Adds a custom css class to the root element of this component.

Parameters

$css_class

at line 197
add_data(mixed $data)

put your comment there.

..

Parameters

mixed $data

in UIAjaxComponent at line 106
add_dependency(string $dep_name, UIAjaxComponent $dep_obj, bool $reloadOnUpdate = false)

Add a new UIAjaxComponent object and register it under a certain name this component will use that name to retrieve the object in order to interact with it.

Parameters

string $dep_name
UIAjaxComponent $dep_obj
bool $reloadOnUpdate

Set true to reload dependency if this component is updated.

at line 92
add_step(mixed $title, mixed $content)

put your comment there.

..

Parameters

mixed $title
mixed $content

at line 73
add_step_callback(mixed $title, array $callback, $ajax_content = false)

put your comment there.

..

Parameters

mixed $title
array $callback
$ajax_content

in UIAjaxComponent at line 80
add_url_parameter(mixed $key, mixed $value)

Adds a parameter to url parameter list.

Parameters

mixed $key
mixed $value

at line 461
buildControlBar()

put your comment there.

..

at line 172
disable_control_next()

put your comment there.

..

at line 180
disable_control_prev()

put your comment there.

..

at line 164
enable_control_next()

put your comment there.

..

in UIAjaxComponent at line 161
enable_periodical_update(int $interval)

Enables the periodical update via ajax.

The ajax calls will be execute after an interval of seconds passed by parameter one.

Parameters

int $interval

in UIComponent at line 185
mixed get($var)

Get Variable / Option

Parameters

$var

Return Value

mixed

in UIAjaxComponent at line 200
protected string getPlaceholderContent()

Returns a placeholder which is used to display while this component is loading the content.

Return Value

string

at line 207
get_data(mixed $key = false)

put your comment there.

..

Parameters

mixed $key

in UIAjaxComponent at line 122
mixed get_dependency($dep_name)

Returns a dependent object in order to interact with it

Parameters

$dep_name

Return Value

mixed

at line 224
get_model()

put your comment there.

..

at line 283
string get_unique_dom_id()

Generates a unique dom id, dependent on the provided UID, as well as the current context.

Return Value

string

in UIComponent at line 289
Template|null get_view(string|bool $section = false)

Return new template view If using within module xui the tpl file should be named [class_name].tpl e.g. xui_core_table.tpl within the module's template folder

Parameters

string|bool $section

Name

Return Value

Template|null

Exceptions

Exception

in UIComponent at line 72
init()

put your comment there.

..

at line 120
next_step()

put your comment there.

..

in UIComponent at line 221
string parse_template(string $template_content, array|bool $marker_array = false)

No description

Parameters

string $template_content

HTML Template
array|bool $marker_array

Markers and Values

Return Value

string

Parsed HTML Content

in UIComponent at line 234
string|null parse_template_cb_wrapper(mixed $matches)

No description

Parameters

mixed $matches

Return Value

string|null

in UIComponent at line 260
mixed|string parse_xtag($xml_source)

No description

Parameters

$xml_source

Return Value

mixed|string

Exceptions

ContentException

at line 134
prev_step()

put your comment there.

..

in UIAjaxComponent at line 168
process()

dummy process method - may be overwritten

at line 291
process_xui()

put your comment there.

..

at line 156
remove_control()

put your comment there.

..

at line 214
remove_data($key)

No description

Parameters

$key

in UIAjaxComponent at line 214
render()

Default render method. wraps the content provided by render_xui_content in a unique div and generates a JS object for the GUI

Exceptions

Exception

in UIComponent at line 268
mixed render_xtag_element()

No description

Return Value

mixed

at line 267
protected string|Template render_xui()

Render the Wizard template and assign marker to template. If the wizard has the step control, a control form will be assigned to template, in other case the callback method is responsible for step controlling.

Folowing marker are assign to template: => currentStep The number of the curent step. => stepContentCallbacks An array contains all callback infomation. => currentContent The content that will be show. => backlink This link will be only show, if the wizard control form is not responsible for step controlling. => progress Procent value. => wizardHasControl Boolean, true when wizard control form is responsible for controlling, not assign if the callbacks controls the steps.

Return Value

string|Template

in UIComponent at line 173
void reset_marker_content()

restores original content of marker_content

Return Value

void

in UIComponent at line 106
void set(mixed $var, mixed $value = false)

Set Variable / Option

Parameters

mixed $var

Name of Variable to Set (Alternative: Assoc-Array for multiple variables)
mixed $value

Value of Variable

Return Value

void

in UIAjaxComponent at line 92
void setDeferredLoading(bool $bool, string $message = '')

Set true to load the content deferred. Displays a placeholder while loading the content. Optional you can pass a message which will replace the default loading message.

Parameters

bool $bool
string $message

Return Value

void

at line 188
set_ajax_update_interval(mixed $sec)

Sets the interval for periodical update of ajax container.

Parameters

mixed $sec

in UIComponent at line 122
void set_array(mixed $member_array, mixed $vars)

Set Variable / Option for an array

Parameters

mixed $member_array

Name of Variable to Set (Alternative: Assoc-Array for multiple variables)
mixed $vars

Value of Variable

Return Value

void

at line 108
set_final_callback(array $callback, $redirect_url = false)

put your comment there.

..

Parameters

array $callback
$redirect_url

in UIComponent at line 165
void set_marker_content(mixed $marker_content = false)

sets marker_content to passed data -> restore original content with reset_marker_content()

Parameters

mixed $marker_content

Return Value

void

in UIComponent at line 90
set_mod(mixed $mod)

Set link to owning module

Parameters

mixed $mod

at line 233
set_model(mixed $model)

put your comment there.

..

Parameters

mixed $model

in UIAjaxComponent at line 150
set_option(string $key, mixed $val)

Sets options. This options will be used in the JS element of this XUI class.

Parameters

string $key

update_interval (int) | hide_loading (bool)
mixed $val

in UIComponent at line 135
void set_render_params(mixed $input_params = array())

Used to inject params. Only allowed params will be used (see $allowed_params_filter)

Parameters

mixed $input_params

Return Value

void

in UIAjaxComponent at line 129
set_uid($uid)

No description

Parameters

$uid

in UIAjaxComponent at line 70
set_url_parameters(array $parameters)

Sets the url parameter that is used for component loading.

Parameters

array $parameters

at line 148
take_control()

put your comment there.

..

at line 360
updateWizardData()

put your comment there.

..