class UserImage extends UIComponent

Class UserImage

Constants

SYSTEM_TEMPLATE_UI_FOLDER

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 int|string $user_id

The user id as integer or the string "current" for the current user as target.

protected int|bool $show_status

Whether to show the user online status or not.

protected bool $show_menu

Whether to show the user shortprofile menu when clicking image

protected bool $initial_status

Set this false to display the status initially as unknown. The status will be refreshed via ajax.

protected int $height

The height of the image in pixel.

protected int $width

The width of the image in pixel.

protected string $size
protected string $href
protected string $class

Methods

__construct(string $link_id = null)

UIComponent constructor.

__set(string $name, mixed $value)

Support for xui template usage.

string
__toString()

No description

mixed
get($var)

Get Variable / Option

int
getHeight()

No description

int
getUserId()

No description

int
getWidth()

No description

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

Load js files

bool
isShowStatus()

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

render()

No description

mixed
render_xtag_element()

No description

void
reset_marker_content()

restores original content of marker_content

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

Set Variable / Option

setHeight(int $height)

No description

setShowStatus(bool $show_status)

No description

setUserId(int $user_id)

No description

setWidth(int $width)

No description

void
set_array(mixed $member_array, mixed $vars)

Set Variable / Option for an array

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

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

at line 293
__set(string $name, mixed $value)

Support for xui template usage.

Parameters

string $name
mixed $value

in UIComponent at line 328
string __toString()

No description

Return Value

string

in UIComponent at line 187
mixed get($var)

Get Variable / Option

Parameters

$var

Return Value

mixed

at line 114
int getHeight()

No description

Return Value

int

at line 80
int getUserId()

No description

Return Value

int

at line 131
int getWidth()

No description

Return Value

int

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

Load js files

at line 97
bool isShowStatus()

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 UIComponent at line 339
process()

Declared in Classes

at line 156
render()

No description

Exceptions

Exception

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

at line 123
UserImage setHeight(int $height)

No description

Parameters

int $height

Return Value

UserImage

at line 106
UserImage setShowStatus(bool $show_status)

No description

Parameters

bool $show_status

Return Value

UserImage

at line 89
UserImage setUserId(int $user_id)

No description

Parameters

int $user_id

Return Value

UserImage

at line 140
UserImage setWidth(int $width)

No description

Parameters

int $width

Return Value

UserImage

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