Document
class Document extends UIComponent
Class Document
Constants
SYSTEM_TEMPLATE_UI_FOLDER |
|
ADDITIONAL_DATA |
|
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 DocumentModel | $model | ||
protected DocumentIndex | $document_index | ||
protected | $layout | ||
protected | $sidebar |
Methods
Add Sidebar-Actions as section
Return Document Description
No description
Return Full Preview for this document
Return Document Image URL (mod->get_file_url)
Get Sidebars for Full Preview
Return Document Title
Return CSS Icon class for title
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
Declared in Classes
No description
No description
No description
Render full preview and return content as string This function will resolve all renderable objects
Render Title/Description/Image
Render Title Only
Set Variable / Option for an array
Set preferred layout type
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 324
string
__toString()
No description
at line 222
protected
add_sidebar(mixed $title, mixed $options, string|null $key = null)
Add Sidebar-Actions as section
in
UIComponent at line 185
mixed
get($var)
Get Variable / Option
at line 164
string
get_description()
Return Document Description
at line 273
protected
get_doclink_actions()
No description
at line 180
string|Template|UIComponent
get_full_preview()
Return Full Preview for this document
at line 172
string
get_image($w = false, $h = false, $cropmode = false)
Return Document Image URL (mod->get_file_url)
at line 237
final
get_sidebar()
Get Sidebars for Full Preview
at line 145
string
get_title()
Return Document Title
at line 156
string
get_title_icon_class()
Return CSS Icon class for title
in
UIComponent at line 202
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 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
at line 35
init()
put your comment there.
..
in
UIComponent at line 221
string
parse_template(string $template_content, array|bool $marker_array = false)
No description
in
UIComponent at line 234
string|null
parse_template_cb_wrapper(mixed $matches)
No description
in
UIComponent at line 260
mixed|string
parse_xtag($xml_source)
No description
at line 39
process()
Declared in Classes
at line 242
process_sidebar()
No description
at line 43
render()
No description
at line 119
string
render_comment()
No description
at line 129
final string
render_full_preview()
Render full preview and return content as string This function will resolve all renderable objects
at line 98
final xelos_global_template
render_title_description_image()
Render Title/Description/Image
at line 77
final xelos_global_template
render_title_only()
Render Title Only
in
UIComponent at line 268
mixed
render_xtag_element()
No description
in
UIComponent at line 173
void
reset_marker_content()
restores original content of marker_content
in
UIComponent at line 106
void
set(mixed $var, mixed $value = false)
Set Variable / Option
in
UIComponent at line 122
void
set_array(mixed $member_array, mixed $vars)
Set Variable / Option for an array
at line 211
set_force_layout(string $layout)
Set preferred layout type
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()
in
UIComponent at line 90
set_mod(mixed $mod)
Set link to owning module
at line 202
set_model(DocumentModel $model)
Set Model this UI Render will be based upon
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)