DocumentList
class DocumentList extends UIComponent
Class DocumentList
Constants
| SYSTEM_TEMPLATE_UI_FOLDER |
|
| VIEWSTYLE_LIST |
|
| VIEWSTYLE_GALLERY |
|
| VIEWSTYLE_NATIVE |
|
| VIEWSTYLE_CARD |
|
| VIEWSTYLE_CARD_COMPACT |
|
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 |
| protected bool | $has_legacy |
Methods
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
No description
Render XUI Object
Adds document indexes to a DocumentIndex ModelCollection. Will merge with already existing ModelCollection or will create/search a new one
Only supported with VIEWSTYLE_LIST or VIEWSTYLE_GALLERY
No description
Alternative to setDocumentIndexCollection is to give a generic (Document)ModelCollection which will be transformed during rendering
Set View Style of XUI, self::VIEWSTYLE_AUTO will mix GRID and LIST depending on the given documents
Set Variable / Option for an array
sets marker_content to passed data -> restore original content with reset_marker_content()
Used to inject params. Only allowed params will be used (see $allowed_params_filter)
Details
in
UIComponent at line 64
__construct(string $link_id = null)
UIComponent constructor.
in
UIComponent at line 328
string
__toString()
No description
in
UIComponent at line 187
mixed
get($var)
Get Variable / Option
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.
..
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
UIComponent at line 339
process()
Declared in Classes
at line 173
render()
Render XUI Object
in
UIComponent at line 273
mixed
render_xtag_element()
No description
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 109
DocumentList
setDocumentIndexCollection(ModelCollection $documentIndexCollection)
Adds document indexes to a DocumentIndex ModelCollection. Will merge with already existing ModelCollection or will create/search a new one
at line 140
DocumentList
setLegacyDocuments(array $documentArray)
deprecated
deprecated
Only supported with VIEWSTYLE_LIST or VIEWSTYLE_GALLERY
at line 98
DocumentList
setLimitLoadMore(int $limit)
No description
at line 126
DocumentList
setModelCollection(ModelCollection $modelCollection)
Alternative to setDocumentIndexCollection is to give a generic (Document)ModelCollection which will be transformed during rendering
at line 87
DocumentList
setViewStyle(string $style = DocumentList::VIEWSTYLE_GALLERY, bool $renderSingleDocument = false)
Set View Style of XUI, self::VIEWSTYLE_AUTO will mix GRID and LIST depending on the given documents
in
UIComponent at line 124
void
set_array(mixed $member_array, mixed $vars)
Set Variable / Option for an array
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
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)