FacetedLegacy deprecated
class FacetedLegacy extends Container
deprecated
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 |
|
| DISPLAY_TYPE_CHECKBOX |
|
| DISPLAY_TYPE_TEXT |
|
| DISPLAY_TYPE_DATE |
|
| DISPLAY_TYPE_TOGGLE |
|
| AJAX_REQUEST_FACET_PARAMETER_PLACEHOLDER |
|
Properties
| Link | $xf_link | from UIComponent | |
| string | $link_id | from UIComponent | |
| array | $GPvars | from UIComponent | |
| Controller | $mod | from UIComponent | |
| 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 | |
| protected string|callable | $content | from Container | |
| protected string | $placeholderContent | from Container |
Methods
adds a new category for items beeing grouped by the short_id will be used as parameter
adds multiple new categories for items being grouped by the short_id will be used as parameter
adds a new category for items being grouped by the short_id will be used as parameter
Adds an item to a category
Link a container that will also be reloaded, if an ajax link has the current container as target.
No description
Adds a custom css class to the root element of this component.
Add an UIAjaxComponent object and register it under a certain name.
Adds a parameter to url parameter list.
Applies scope conditions of the facets for the given ModelCollection.
Enables the periodical update via ajax.
Return all active conditions
Returns the current active filters (e.g.: ['category' => ['1' => true], 'date' => ['start' => $start, 'end' => $end]])
No description
Returns if there is an active filter
Returns the model collection
Works only after process()
returns an array of all active items
Returns a dependent object in order to interact with it
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
Returns true if the passed item is currently active
No description
Process all parameters
Default render method. wraps the content provided by render_xui_content in a unique div and generates a JS object for the GUI
Render XUI Object
The default value(s) for a category. Use item value(s) for checkbox and ['start'=>$X,'end'=>$Y] for date.
Set display type of facet (Faceted::DISPLAYTYPE[*])
Set icon class
At least one facet element has to be selected.
Set options for the category
Set subselect query to join foreign table id with title
Set a closure to process queried results CLosure signature: function($row) returns modified $row
Sets a custom value
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.
Set Display to horizontal mode
Set the items of a category manually (e.g. Start/End Date for a date filter)
Set the max amount aof facet elements per category
Setting Placeholder Content will automatically enable deferred loading
Set the target container for this facet element
Set Active Item
this class will be added to the outer wrapping div
Set Variable / Option for an array
name of the get parameter - default is uid_filter
sets marker_content to passed data -> restore original content with reset_marker_content()
Sets options. This options will be used in the JS element of this XUI class.
this class will be added to the outer wrapping div
Used to inject params. Only allowed params will be used (see $allowed_params_filter)
title displayed before the first category
Sets the url parameter that is used for component loading.
Details
in
UIComponent at line 64
__construct(string $link_id = null)
UIComponent constructor.
in
UIComponent at line 328
string
__toString()
No description
at line 944
string
addCategory(string $label, string $categoryKey, string $modelProperty = null, array $propertyLabels = null, ModelCollection $referenceCollection = null, string $referenceLableProperty = null)
adds a new category for items beeing grouped by the short_id will be used as parameter
at line 1010
void
addFacetedCategories(FacetedCategoryList $facetedCategories)
adds multiple new categories for items being grouped by the short_id will be used as parameter
at line 981
void
addFacetedCategory(FacetedCategory $category)
adds a new category for items being grouped by the short_id will be used as parameter
at line 1128
bool
addItem(string $categoryKey, string $label, string $value, int $count = null, string $condition = null)
Adds an item to a category
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.
at line 924
string
add_category(string $label, string $short_id, bool $auto_add_all_item = false, bool $as_combobox = false, bool $collapsable = false, string|null $moreLink = null)
deprecated
deprecated
No description
in
UIAjaxComponent at line 196
add_css_class($css_class)
Adds a custom css class to the root element of this component.
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 1113
bool
add_item(string $category_short_id, string $label, string $value, string|Condition $condition = null, bool $active = false, int $indent = 0)
deprecated
deprecated
No description
in
UIAjaxComponent at line 94
add_url_parameter(mixed $key, mixed $value)
Adds a parameter to url parameter list.
at line 119
Collection
applyFacetFilters(Collection $collection, string $excludeCategory = null)
Applies scope conditions of the facets for the given ModelCollection.
The scope for $excludeCategory will not be included.
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
at line 614
array|Condition[]|string[]
getAllActiveConditions()
Return all active conditions
in
UIAjaxComponent at line 456
false|mixed
getCurrentAjaxLink(array $params)
No description
at line 641
array
getCurrentFilter()
Returns the current active filters (e.g.: ['category' => ['1' => true], 'date' => ['start' => $start, 'end' => $end]])
at line 696
array
getCurrentFilterAjax()
No description
at line 725
bool
getHasFilter()
Returns if there is an active filter
in
UIAjaxComponent at line 255
XUILinkHelper
getLinkHelper()
No description
at line 561
ModelCollection
getModelCollection()
Returns the model collection
in
Container at line 54
protected string
getPlaceholderContent()
Place
at line 715
mixed
get_active_value_for_category(string $category_short_id)
Works only after process()
at line 572
array
get_all_active_items(string|bool $category_short_id = false)
returns an array of all active items
at line 622
false|string[]
get_current_filter()
deprecated
deprecated
No description
in
UIAjaxComponent at line 150
mixed
get_dependency($dep_name)
Returns a dependent object in order to interact with it
in
UIComponent at line 204
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 905
bool
is_active(mixed $category_short_id, mixed $item_value)
Returns true if the passed item is currently active
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
in
UIAjaxComponent at line 430
false|string
printAjaxLink(array $params)
No description
in
UIAjaxComponent at line 443
false|mixed
printCurrentAjaxLink(array $params)
No description
at line 392
process()
Process all parameters
in
UIAjaxComponent at line 76
protected
process_xui()
Optional processing method.
This method is called when invoke the process method or automatically before the render method is called.
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 512
string|Template
render_xui()
Render XUI Object
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
at line 1095
void
setCategoryDefaultValue(string $categoryKey, array $defaultValue)
The default value(s) for a category. Use item value(s) for checkbox and ['start'=>$X,'end'=>$Y] for date.
at line 1047
void
setCategoryDisplayType(string $categoryKey, string $displayType)
Set display type of facet (Faceted::DISPLAYTYPE[*])
at line 1059
void
setCategoryIconClass(string $categoryKey, string $iconClass)
Set icon class
at line 1083
void
setCategoryIsRequired(string $categoryKey, bool $isRequired = true)
At least one facet element has to be selected.
at line 1071
void
setCategoryOptions(string $categoryKey, array $options)
Set options for the category
at line 1035
void
setCategoryPropertySubselect(string $categoryKey, string $propertySelect)
Set subselect query to join foreign table id with title
at line 1023
void
setCategoryResultClosure(string $categoryKey, Closure $closure)
Set a closure to process queried results CLosure signature: function($row) returns modified $row
at line 825
void
setCustomValue(string $categoryShortId, array $itemValues)
Sets a custom value
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.
at line 815
setHorizontalMode($horizontal = true)
Set Display to horizontal mode
at line 1155
bool
setItems(string $categoryKey, array $items)
Set the items of a category manually (e.g. Start/End Date for a date filter)
in
UIAjaxComponent at line 102
UIAjaxComponent
setLoadURL(string $url)
No description
at line 752
void
setMaxFacetElements(int $maxElements)
Set the max amount aof facet elements per category
at line 742
void
setModelCollection(ModelCollection $modelCollection)
No description
in
Container at line 44
Container
setPlaceholderContent(string $placeholderContent)
Setting Placeholder Content will automatically enable deferred loading
at line 772
void
setTargetContainer(UIAjaxComponent $targetContainer)
Set the target container for this facet element
at line 836
set_active(mixed $categoryShortId, mixed $itemValues, mixed $overwrite = false)
Set Active Item
at line 790
set_additional_class(string $additional_class)
this class will be added to the outer wrapping div
in
UIComponent at line 124
void
set_array(mixed $member_array, mixed $vars)
Set Variable / Option for an array
in
Container at line 23
set_content(string|callable $content)
No description
at line 808
set_get_parameter_name(string $get_parameter_name)
name of the get parameter - default is uid_filter
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
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.
at line 799
set_render_mode(string $mode = 'classic')
this class will be added to the outer wrapping div
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)
at line 781
set_title(string $title)
title displayed before the first category
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 762
void
set_xui_target(UIAjaxComponent $xui_target)
deprecated
deprecated
No description