1. class
  2. XELOS
  3. \
  4. Framework
  5. \
  6. XF
  7. \
  8. UI
  9. \
  10. Image

Image

class Image extends UIComponent

enable link abilities

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
string $class
$style

Methods

__construct(array $param_array = array())

Constructor

__set(mixed $key, mixed $value)

setter for beeing able to collect all params setted by xTag for transfering to link object in render function

string
__toString()

No description

from  UIComponent
debug()

No description

determine_url()

put your comment there.

fit_attributes()

should be called before render!

string
generate_absolute_path()

No description

string
generate_full_url()

No description

mixed
get($var)

Get Variable / Option

from  UIComponent
string
get_alt()

No description

string
get_appearance_mode()

No description

string
get_content_type()

No description

string
get_crop()

No description

get_disable_replacer()

No description

string
get_folder_prefix()

No description

int
get_height()

No description

string
get_label()

No description

string
get_placeholder_image_by_content_type(mixed $content_type = false)

put your comment there.

get_public_file_link()

No description

string
get_resize()

No description

bool
get_static_url()

No description

string
get_unique_dom_id()

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

from  UIComponent
string
get_url()

No description

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

No description

init()

put your comment there.

from  UIComponent
is_replacer_disabled()

No description

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

Render XUI Object

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)

Set Variable / Option

from  UIComponent
set_alt($_alt)

No description

set_appearance_mode($_appearance_mode)

No description

void
set_array(mixed $member_array, mixed $vars)

Set Variable / Option for an array

from  UIComponent
set_content_type($_content_type)

No description

set_crop($_crop)

No description

set_disable_replacer($value)

No description

set_folder_prefix($_folder_prefix)

No description

set_height($_height)

No description

set_label($_label)

No description

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_public_file_link($public_file_link)

No description

void
set_render_params(mixed $input_params = array())

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

from  UIComponent
set_resize($_resize)

No description

set_url($_url)

No description

set_width($_width)

No description

Details

at line 110
__construct(array $param_array = array())

Constructor

Parameters

array $param_array

Param Array

at line 139
__set(mixed $key, mixed $value)

setter for beeing able to collect all params setted by xTag for transfering to link object in render function

Parameters

mixed $key
mixed $value

in UIComponent at line 324
string __toString()

No description

Return Value

string

at line 468
debug()

No description

at line 304
determine_url()

put your comment there.

..

at line 286
fit_attributes()

should be called before render!

at line 431
string generate_absolute_path()

No description

check if last char of folder_prefix is "/"

Return Value

string

absolute image path on server (needed for file_exists check)

at line 421
string generate_full_url()

No description

check if last char of folder_prefix is "/"

Return Value

string

image path (relative to mod-folder)

in UIComponent at line 185
mixed get($var)

Get Variable / Option

Parameters

$var

Return Value

mixed

at line 528
string get_alt()

No description

Return Value

string

at line 538
string get_appearance_mode()

No description

Return Value

string

at line 556
string get_content_type()

No description

Return Value

string

at line 551
string get_crop()

No description

Return Value

string

at line 672
get_disable_replacer()

No description

at line 518
string get_folder_prefix()

No description

Return Value

string

at line 561
int get_height()

No description

Return Value

int

at line 523
string get_label()

No description

Return Value

string

at line 447
string get_placeholder_image_by_content_type(mixed $content_type = false)

put your comment there.

..

Parameters

mixed $content_type

if false, then using internal content-type field

Return Value

string

url-path (relative to wwwres of system)

No description

at line 546
string get_resize()

No description

Return Value

string

boolean??

at line 533
bool get_static_url()

No description

Return Value

bool

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

at line 513
string get_url()

No description

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 566
int get_width()

No description

Return Value

int

in UIComponent at line 72
init()

put your comment there.

..

at line 667
is_replacer_disabled()

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

Declared in Classes

at line 156
render()

Render XUI Object

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

at line 590
set_alt($_alt)

No description

Parameters

$_alt

at line 596
set_appearance_mode($_appearance_mode)

No description

Parameters

$_appearance_mode

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

at line 647
set_content_type($_content_type)

No description

Parameters

$_content_type

at line 632
set_crop($_crop)

No description

Parameters

$_crop

at line 676
set_disable_replacer($value)

No description

Parameters

$value

at line 580
set_folder_prefix($_folder_prefix)

No description

Parameters

$_folder_prefix

at line 637
set_height($_height)

No description

Parameters

$_height

at line 585
set_label($_label)

No description

Parameters

$_label

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

No description

Parameters

$public_file_link

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

at line 620
set_resize($_resize)

No description

Parameters

$_resize

at line 575
set_url($_url)

No description

Parameters

$_url

at line 642
set_width($_width)

No description

Parameters

$_width