Wizard
class Wizard extends UIAjaxComponent
Constants
| SYSTEM_TEMPLATE_UI_FOLDER |
|
| CONTAINER_LINK_MODE_REPLACE |
Link modes. Should the ajax respone replace the original content, or should it be appended/prepended |
| CONTAINER_LINK_MODE_APPEND |
|
| CONTAINER_LINK_MODE_PREPEND |
|
| CONTROL_NEXT |
|
| CONTROL_PREV |
|
| CONTROL_FINAL |
|
| STATE_PROCESSING |
|
| STATE_STOPED |
|
Properties
| Link | $xf_link | from UIComponent | |
| string | $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 |
| XUILinkHelper | $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 array | $xuiLinkedContainers | 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
UIComponent constructor.
Link a container that will also be reloaded, if an ajax link has the current container as target.
Adds a custom css class to the root element of this component.
put your comment there.
Add an UIAjaxComponent object and register it under a certain name.
put your comment there.
put your comment there.
Adds a parameter to url parameter list.
put your comment there.
put your comment there.
put your comment there.
put your comment there.
Enables the periodical update via ajax.
Returns a placeholder which is used to display while this component is loading the content.
put your comment there.
Returns a dependent object in order to interact with it
put your comment there.
Generates a unique dom id, dependent on the provided UID, as well as the current context.
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
put your comment there.
No description
put your comment there.
put your comment there.
put your comment there.
No description
Default render method. wraps the content provided by render_xui_content in a unique div and generates a JS object for the GUI
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.
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.
Sets the interval for periodical update of ajax container.
Set Variable / Option for an array
put your comment there.
sets marker_content to passed data -> restore original content with reset_marker_content()
put your comment there.
Sets options. This options will be used in the JS element of this XUI class.
Used to inject params. Only allowed params will be used (see $allowed_params_filter)
Sets the url parameter that is used for component loading.
put your comment there.
put your comment there.
Details
at line 48
__construct($wizardID = false, $defaultStep = 1)
UIComponent constructor.
in
UIComponent at line 328
string
__toString()
No description
in
UIAjaxComponent at line 158
void
addLinkedContainer(UIAjaxComponent $linkedContainer, $linkMode = self::CONTAINER_LINK_MODE_REPLACE)
Link a container that will also be reloaded, if an ajax link has the current container as target.
in
UIAjaxComponent at line 196
add_css_class($css_class)
Adds a custom css class to the root element of this component.
at line 197
add_data(mixed $data)
put your comment there.
..
in
UIAjaxComponent at line 134
add_dependency(string $dep_name, UIAjaxComponent $dep_obj, bool $reloadOnUpdate = false)
Add an 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.
If reloadOnUpdate is set, the dependent container will be reloaded after the update of the current container. !Beware: The reload url of the dependency container will be the one set in its data attribute and not a possible "new url" used to update the current container. If you want to reload multiple containers at once when the current container is an ajax link target, use $this->addLinkedContainer()
at line 92
add_step(mixed $title, mixed $content)
put your comment there.
..
at line 73
add_step_callback(mixed $title, array $callback, $ajax_content = false)
put your comment there.
..
in
UIAjaxComponent at line 94
add_url_parameter(mixed $key, mixed $value)
Adds a parameter to url parameter list.
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 218
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.
in
UIComponent at line 187
mixed
get($var)
Get Variable / Option
in
UIAjaxComponent at line 456
false|mixed
getCurrentAjaxLink(array $params)
No description
in
UIAjaxComponent at line 255
XUILinkHelper
getLinkHelper()
No description
in
UIAjaxComponent at line 267
protected string
getPlaceholderContent()
Returns a placeholder which is used to display while this component is loading the content.
at line 207
get_data(mixed $key = false)
put your comment there.
..
in
UIAjaxComponent at line 150
mixed
get_dependency($dep_name)
Returns a dependent object in order to interact with it
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.
in
UIComponent at line 294
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
in
UIComponent at line 72
init()
put your comment there.
..
at line 120
next_step()
put your comment there.
..
in
UIComponent at line 223
string
parse_template(string $template_content, array|bool $marker_array = false)
No description
in
UIComponent at line 239
string|null
parse_template_cb_wrapper(mixed $matches)
No description
in
UIComponent at line 265
mixed|string
parse_xtag($xml_source)
No description
at line 134
prev_step()
put your comment there.
..
in
UIAjaxComponent at line 430
false|string
printAjaxLink(array $params)
No description
in
UIAjaxComponent at line 443
false|mixed
printCurrentAjaxLink(array $params)
No description
in
UIAjaxComponent at line 225
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
in
UIAjaxComponent at line 281
render()
Default render method. wraps the content provided by render_xui_content in a unique div and generates a JS object for the GUI
in
UIComponent at line 273
mixed
render_xtag_element()
No description
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.
in
UIComponent at line 175
void
reset_marker_content()
restores original content of marker_content
in
UIComponent at line 108
void
set(mixed $var, mixed $value = false)
deprecated
deprecated
Set Variable / Option
in
UIAjaxComponent at line 115
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.
in
UIAjaxComponent at line 102
UIAjaxComponent
setLoadURL(string $url)
No description
at line 188
set_ajax_update_interval(mixed $sec)
Sets the interval for periodical update of ajax container.
in
UIComponent at line 124
void
set_array(mixed $member_array, mixed $vars)
Set Variable / Option for an array
at line 108
set_final_callback(array $callback, $redirect_url = false)
put your comment there.
..
in
UIComponent at line 167
void
set_marker_content(mixed $marker_content = false)
sets marker_content to passed data -> restore original content with reset_marker_content()
in
UIComponent at line 90
set_mod(mixed $mod)
Set link to owning module
at line 233
set_model(mixed $model)
put your comment there.
..
in
UIAjaxComponent at line 207
set_option(string $key, mixed $val)
Sets options. This options will be used in the JS element of this XUI class.
in
UIComponent at line 137
void
set_render_params(mixed $input_params = array())
Used to inject params. Only allowed params will be used (see $allowed_params_filter)
in
UIAjaxComponent at line 177
set_uid($uid)
No description
in
UIAjaxComponent at line 83
UIAjaxComponent
set_url_parameters(array $parameters)
Sets the url parameter that is used for component loading.
at line 148
take_control()
put your comment there.
..
at line 360
updateWizardData()
put your comment there.
..