1. class
  2. XELOS
  3. \
  4. Modules
  5. \
  6. Pages
  7. \
  8. Ui
  9. \
  10. Page

Page

class Page extends Document

Constants

SYSTEM_TEMPLATE_UI_FOLDER

ADDITIONAL_DATA

CARD_WITH_IMAGE

CARD_COMPACT_ICON

CARD_COMPACT_TITLE

CARD_COMPACT_TITLE_ONLY

Properties

$xf_link from  UIComponent
$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 from  Document
protected DocumentIndex $document_index from  Document
protected $layout from  Document
protected $sidebar from  Document

Methods

__construct(string $link_id = null)

UIComponent constructor.

from  UIComponent
string
__toString()

No description

from  UIComponent
add_sidebar(mixed $title, mixed $options, string|null $key = null)

Add Sidebar-Actions as section

from  Document
mixed
get($var)

Get Variable / Option

from  UIComponent
Template|null
getCard()

This function may be overridden by other document classes.

from  Document
Template|null
getCardCompact(string|null $cardCompactTemplate = null)

This function may be overridden by other document classes.

from  Document
string|null
getDocumentThumbnail(int|null $width = null, int|null $height = null, bool $cropMode = false)

Return Document Video Thumbnail URL

from  Document
?string
get_description()

Return Document Description

get_doclink_actions()

No description

from  Document
string|Template|UIComponent
get_full_preview()

Return Full Preview for this document

?string
get_image($w = false, $h = false, $cropmode = false)

Return Document Image URL (mod->get_file_url)

from  Document
get_sidebar()

Get Sidebars for Full Preview

from  Document
?string
get_title()

Return Document Title

?string
get_title_icon_class()

Return CSS Icon class for title

string
get_unique_dom_id()

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

from  UIComponent
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.

bool
isVideo()

No description

from  Document
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
process()

Declared in Classes

from  Document
process_sidebar()

No description

from  Document
render()

No description

from  Document
string
render_comment()

No description

from  Document
string
render_full_preview()

Render full preview and return content as string This function will resolve all renderable objects

from  Document
xelos_global_template
render_title_description_image()

Render Title/Description/Image

from  Document
xelos_global_template
render_title_only()

Render Title Only

from  Document
mixed
render_xtag_element()

No description

from  UIComponent
void
reset_marker_content()

restores original content of marker_content

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

Set Variable / Option

from  UIComponent
void
set_array(mixed $member_array, mixed $vars)

Set Variable / Option for an array

from  UIComponent
Document
set_force_layout(string $layout)

Set preferred layout type

from  Document
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(DocumentModel $model)

Set Model this UI Render will be based upon

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

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

from  UIComponent

Details

in UIComponent at line 64
__construct(string $link_id = null)

UIComponent constructor.

Parameters

string $link_id

in UIComponent at line 328
string __toString()

No description

Return Value

string

in Document at line 225
protected add_sidebar(mixed $title, mixed $options, string|null $key = null)

Add Sidebar-Actions as section

Parameters

mixed $title

string section-title
mixed $options

array with options/actions (complete <a href="..." ...> - links) (@todo: add smart parsing)
string|null $key

Uses the ADDITIONAL_DATA constant to make clear, that this key is just for appending additional data (meta data for example).

in UIComponent at line 187
mixed get($var)

Get Variable / Option

Parameters

$var

Return Value

mixed

in Document at line 359
protected Template|null getCard()

This function may be overridden by other document classes.

Return Value

Template|null

in Document at line 379
protected Template|null getCardCompact(string|null $cardCompactTemplate = null)

This function may be overridden by other document classes.

Parameters

string|null $cardCompactTemplate

Return Value

Template|null

in Document at line 330
string|null getDocumentThumbnail(int|null $width = null, int|null $height = null, bool $cropMode = false)

Return Document Video Thumbnail URL

Parameters

int|null $width
int|null $height
bool $cropMode

Shall the image be cropped?

Return Value

string|null

web url to the image

at line 23
?string get_description()

Return Document Description

Return Value

?string

No description

at line 27
string|Template|UIComponent get_full_preview()

Return Full Preview for this document

Return Value

string|Template|UIComponent

in Document at line 174
?string get_image($w = false, $h = false, $cropmode = false)

Return Document Image URL (mod->get_file_url)

Parameters

$w
$h
$cropmode

Return Value

?string

in Document at line 240
final get_sidebar()

Get Sidebars for Full Preview

at line 19
?string get_title()

Return Document Title

Return Value

?string

at line 15
?string get_title_icon_class()

Return CSS Icon class for title

Return Value

?string

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.

Return Value

string

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

Parameters

string|bool $section Name

Return Value

Template|null

Exceptions

Exception

at line 10
init()

put your comment there.

..

in Document at line 334
bool isVideo()

No description

Return Value

bool

in UIComponent at line 223
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 239
string|null parse_template_cb_wrapper(mixed $matches)

No description

Parameters

mixed $matches

Return Value

string|null

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

No description

Parameters

$xml_source

Return Value

mixed|string

Exceptions

ContentException

in Document at line 40
process()

Declared in Classes

in Document at line 245
process_sidebar()

No description

in Document at line 44
render()

No description

in Document at line 121
string render_comment()

No description

Return Value

string

in Document at line 131
final string render_full_preview()

Render full preview and return content as string This function will resolve all renderable objects

Return Value

string

in Document at line 100
final xelos_global_template render_title_description_image()

Render Title/Description/Image

Return Value

xelos_global_template

in Document at line 79
final xelos_global_template render_title_only()

Render Title Only

Return Value

xelos_global_template

in UIComponent at line 273
mixed render_xtag_element()

No description

Return Value

mixed

in UIComponent at line 175
void reset_marker_content()

restores original content of marker_content

Return Value

void

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

deprecated - It is preferred to have explicit setters/getters. Please check if you can rewrite usage to use explicit setters with documented options

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 UIComponent at line 124
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

in Document at line 213
Document set_force_layout(string $layout)

Set preferred layout type

Parameters

string $layout (fullpreview)

Return Value

Document

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()

Parameters

mixed $marker_content

Return Value

void

in UIComponent at line 90
set_mod(mixed $mod)

Set link to owning module

Parameters

mixed $mod

in Document at line 204
set_model(DocumentModel $model)

Set Model this UI Render will be based upon

Parameters

DocumentModel $model

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)

Parameters

mixed $input_params

Return Value

void