Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
DataFieldI18NEntry Class Reference
Inheritance diagram for DataFieldI18NEntry:
DataFieldEntry DataFieldTextareai18nEntry DataFieldTextlinei18nEntry DataFieldTextmarkupi18nEntry

Public Member Functions

 __construct (DataField $datafield=null, $rangeID= '', $value=null)
 
 setContentLanguage ($language)
 
 getDisplayValue ($entities=true)
 
 getHTML ($name= '', $variables=[])
 
 setValueFromSubmit ($submitted_value)
 
 store ()
 
- Public Member Functions inherited from DataFieldEntry
 __construct (DataField $datafield=null, $rangeID= '', $value=null)
 
 store ()
 
 isRequired ()
 
 getDescription ()
 
 getType ()
 
 getDisplayValue ($entities=true)
 
 getValue ()
 
 getName ()
 
 getId ()
 
 getHTML ($name= '', $variables=[])
 
 setValue ($value)
 
 setValueFromSubmit ($submitted_value)
 
 setRangeID ($range_id)
 
 setSecondRangeID ($sec_range_id)
 
 setContentLanguage ($language)
 
 isEmpty ()
 
 isValid ()
 
 numberOfHTMLFields ()
 
 getRangeID ()
 
 getSecondRangeID ()
 
 isVisible ($perm=null, $test_ownership=true)
 
 isEditable ($perms=null)
 
 getPermsDescription ()
 

Protected Member Functions

 getLocaleNames ($name)
 
- Protected Member Functions inherited from DataFieldEntry
 prettyPrintViewPerms ()
 

Additional Inherited Members

- Static Public Member Functions inherited from DataFieldEntry
static getSupportedTypes ($object_type=null)
 
static createDataFieldEntry (DataField $datafield, $rangeID= '', $value=null)
 
static getDataFieldEntries ($range_id, $object_type= '', $object_class_hint= '')
 
static removeAll ($range_id)
 
- Data Fields inherited from DataFieldEntry
 $value
 
 $model
 
 $rangeID
 
- Protected Attributes inherited from DataFieldEntry
 $language = ''
 
 $template = null
 
- Static Protected Attributes inherited from DataFieldEntry
static $supported_types
 

Constructor & Destructor Documentation

__construct ( DataField  $datafield = null,
  $rangeID = '',
  $value = null 
)

Constructs this datafield

Parameters
DataField$datafieldUnderlying model
mixed$range_idRange id (or array with range id and secondary range id)
mixed$valueValue

Member Function Documentation

getDisplayValue (   $entities = true)

Returns the display/rendered value of this datafield

Parameters
bool$entitiesShould html entities be encoded (defaults to true)
Returns
String containg the rendered value
getHTML (   $name = '',
  $variables = [] 
)

Returns the input elements as html for this datafield

Parameters
String$nameName prefix of the associated input
Array$variablesAdditional variables
Returns
String containing the required html
getLocaleNames (   $name)
protected

Returns an array containing the names for the html element by locale.

Parameters
string$nameBase name of the element
Returns
array
setContentLanguage (   $language)

Sets the prefered content language if this is an i18n datafield.

Parameters
string$languageThe prefered display language
setValueFromSubmit (   $submitted_value)

Sets the value from a post request

Parameters
mixed$submitted_valueThe value from request
store ( )

Stores this datafield entry

Returns
int representing the number of changed entries

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