I18N Class Reference

Inheritance diagram for I18N:

Public Member Functions
	setReadonly ($state=true)
	checkMvvPerms (ModuleManagementModel $object, $perm=MvvPerm::PERM_WRITE)
	render (array $attributes=[])
	__toString ()

Static Public Member Functions
static	input ($name, $value, array $attributes=[])
static	textarea ($name, $value, array $attributes=[])
static	isEnabled ()

Protected Member Functions
	__construct ($template, $name, $value, array $attributes)

Protected Attributes
	$template
	$name
	$value
	$attributes

Detailed Description

Translation class

Automatic generation of inputs and textareas for i18n

Author

Jan-Hendrik Willms tleil.nosp@m.ax+s.nosp@m.tudip.nosp@m.@gma.nosp@m.il.co.nosp@m.m

Peter Thienel pthie.nosp@m.nel@.nosp@m.data-.nosp@m.ques.nosp@m.t.de

Elmar Ludwig elmar.nosp@m..lud.nosp@m.wig@u.nosp@m.os.d.nosp@m.e

Florian Bieringer GPL2 or any later version

Constructor & Destructor Documentation

__construct()

__construct (   $template,   $name,   $value, array  $attributes  )

finalprotected

Protected constructor in order to always force a specific input type.

Parameters

string | Flexi_Template	$template	Template to use
string	$name	Name of the element
string | I18NString	$value	Value of the element
array	$attributes	Additional variables for the element

Member Function Documentation

__toString()

__toString

(

)

Converts the object to a string by rendering it.

Returns

string

See also

I18N::render()

checkMvvPerms()

checkMvvPerms	(	ModuleManagementModel	$object,
			$perm = MvvPerm::PERM_WRITE
	)

MVV: Check user's permissions for an object and set the readonly state accordingly.

Parameters

ModuleManagementModel	$object	Object to check permissions for
string	$perm	Permission to check (default create)

Returns

I18N object to allow chaining

input()

static input (   $name,   $value, array  $attributes = []  )

static

Creates a set of HTML input elements for this form element in text form. One element will be generated for each configured content language.

Parameters

string	$name	HTML name of the Inputfild
I18NString	$value	(Needs to be an i18n input string)
array	$attributes	Additional attributes of the input

Returns

I18N Crafted input

isEnabled()

static isEnabled ( )

static

Returns whether the i18n functionality is enabeld i.e. more than the default language is configured in config_defaults.inc.php.

Returns

bool True if i18n is enabled.

render()

render

(

array

$attributes = []

)

Renders the element as html.

Parameters

array

$attributes

Additional attributes

Returns

string

setReadonly()

setReadonly

(

$state = true

)

Sets the readonly state of the element.

Parameters

bool

$state

State of the readonly attribute (default true)

Returns

I18N object to allow chaining

textarea()

static textarea (   $name,   $value, array  $attributes = []  )

static

Create a set of HTML textarea elements for this form element in text form. One element will be generated for each configured content language.

Parameters

string	$name	HTML name of the Textarea
I18NString	$value	(Needs to be an i18n input string)
array	$attributes	Additional attributes of the input

Returns

I18N Crafted textarea

Field Documentation

$attributes

$attributes

protected

$name

$name

protected

$template

$template

protected

$value

$value

protected

---

The documentation for this class was generated from the following file:

• lib/classes/I18N.php