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

Translation

class Translation extends UIComponent

xtag to provide a translation service via the Translation module.

Use </xui:translation> to encapsulate content which should be translated. (TBD not final) Possible xtag parameters are: document_index_id [int]: Translations will be linked to this document. Document will also be indexed for the search in its translated version. cache_key [string]: Custom cache key used as identifier. Example: document with id 1234 (forum post) displays its 'title' at one place and its 'body' somewhere else. Translations are stored seperately for the document based on this key. '_default' is used if cache_key is empty. target_language [string]: The target language. If empty, the language of the current set user language is used. translation_only [bool, default: false]: if set to true, only the translated content (or the original content if not ranslation is available) will be displayed. minimal [bool, default: false] Translation template will only indicate the automatic translation via symbol minimal_switch [bool, default: true] Only if minimal is set: A click on the symbol will switch between the translated and original content.

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 string $_overwrite_param_array

All parameters of the xtag are written into $xtag_params, so they can be passed to the called instance
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 $xtag_params

Methods

__construct(string $link_id = null)

UIComponent constructor.

from  UIComponent
string
__toString()

No description

from  UIComponent
mixed
get($var)

Get Variable / Option

from  UIComponent
string|Template
getTranslationTemplate(TranslationController $translationModule, array $translationResult, bool $minimal = false, bool $translationOnly = false, bool $minimalSwitch = true)

Returns the template for the given $translationResult.

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.

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

Renders the xui:translation tag

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
void
set_array(mixed $member_array, mixed $vars)

Set Variable / Option for an array

from  UIComponent
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
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 324
string __toString()

No description

Return Value

string

in UIComponent at line 185
mixed get($var)

Get Variable / Option

Parameters

$var

Return Value

mixed

at line 133
string|Template getTranslationTemplate(TranslationController $translationModule, array $translationResult, bool $minimal = false, bool $translationOnly = false, bool $minimalSwitch = true)

Returns the template for the given $translationResult.

WARNING: CSS and JS files are not addedhere. If this getTranslationTemplate() function is called during the backround updater and/or via ajax, it expects that these files are already present on the page. See previous render() method.

Parameters

TranslationController $translationModule

The main controller
array $translationResult

The result array
bool $minimal

Render minimal template?
bool $translationOnly

Render translation only?
bool $minimalSwitch

If minimal, should the original content be switchable?

Return Value

string|Template

Exceptions

Exception

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

in UIComponent at line 72
init()

put your comment there.

..

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

Renders the xui:translation tag

Exceptions

Exception

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