class ThreadPreview extends Document

Class ThreadPreview

Constants

SYSTEM_TEMPLATE_UI_FOLDER

ADDITIONAL_DATA

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 Post|Thread $model
protected DocumentIndex $document_index from  Document
protected $layout from  Document
protected $sidebar from  Document

Methods

__construct(string $link_id = null)

UIComponent constructor.

string
__toString()

No description

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

Add Sidebar-Actions as section

from  Document
mixed
get($var)

Get Variable / Option

string
get_description()

No description

get_doclink_actions()

No description

from  Document
get_full_preview()

Render a preview of the thread

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

No description

get_sidebar()

Get Sidebars for Full Preview

from  Document
string
get_title()

No description

string
get_title_icon_class()

Return CSS Icon class for title

from  Document
string
get_unique_dom_id()

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

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

init()

No description

string
parse_template(string $template_content, array|bool $marker_array = false)

No description

string|null
parse_template_cb_wrapper(mixed $matches)

No description

mixed|string
parse_xtag($xml_source)

No description

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

void
reset_marker_content()

restores original content of marker_content

void
set(mixed $var, mixed $value = false)

Set Variable / Option

void
set_array(mixed $member_array, mixed $vars)

Set Variable / Option for an array

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

set_mod(mixed $mod)

Set link to owning module

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)

Details

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

UIComponent constructor.

Parameters

string $link_id

in UIComponent at line 324
string __toString()

No description

Return Value

string

in Document at line 222
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 185
mixed get($var)

Get Variable / Option

Parameters

$var

Return Value

mixed

at line 47
string get_description()

No description

Return Value

string

Exceptions

Exception

No description

at line 87
string|Template|UIComponent get_full_preview()

Render a preview of the thread

Return Value

string|Template|UIComponent

Exceptions

Exception

at line 71
string get_image($w = false, $h = false, $cropmode = false)

No description

Parameters

$w
$h
$cropmode

Return Value

string

in Document at line 237
final get_sidebar()

Get Sidebars for Full Preview

at line 32
string get_title()

No description

Return Value

string

in Document at line 156
string get_title_icon_class()

Return CSS Icon class for title

Return Value

string

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.

Return Value

string

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

Parameters

string|bool $section

Name

Return Value

Template|null

Exceptions

Exception

at line 24
init()

No description

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

No description

Parameters

mixed $matches

Return Value

string|null

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

No description

Parameters

$xml_source

Return Value

mixed|string

Exceptions

ContentException

in Document at line 39
process()

Declared in Classes

in Document at line 242
process_sidebar()

No description

in Document at line 43
render()

No description

in Document at line 119
string render_comment()

No description

Return Value

string

in Document at line 129
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 98
final xelos_global_template render_title_description_image()

Render Title/Description/Image

Return Value

xelos_global_template

in Document at line 77
final xelos_global_template render_title_only()

Render Title Only

Return Value

xelos_global_template

in UIComponent at line 268
mixed render_xtag_element()

No description

Return Value

mixed

in UIComponent at line 173
void reset_marker_content()

restores original content of marker_content

Return Value

void

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

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 122
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 211
set_force_layout(string $layout)

Set preferred layout type

Parameters

string $layout

(fullpreview)

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

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 202
set_model(DocumentModel $model)

Set Model this UI Render will be based upon

Parameters

DocumentModel $model

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)

Parameters

mixed $input_params

Return Value

void