Stud.IP  5.4
DataFieldSelectboxEntry Class Reference
Inheritance diagram for DataFieldSelectboxEntry:
DataFieldEntry DataFieldRadioEntry DataFieldSelectboxMultipleEntry

Public Member Functions

 __construct (DataField $struct=null, $range_id='', $value=null)
 
 getHTML ($name='', $variables=[])
 
 getParameters ()
 
 getDisplayValue ($entities=true)
 
- 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 Attributes

 $template = 'selectbox.php'
 
 $type_param
 
 $is_assoc_param = false
 
- Protected Attributes inherited from DataFieldEntry
 $language = ''
 
 $template = null
 

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 Member Functions inherited from DataFieldEntry
 prettyPrintViewPerms ()
 
- Static Protected Attributes inherited from DataFieldEntry
static $supported_types
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

__construct ( DataField  $struct = null,
  $range_id = '',
  $value = null 
)

Constructs this datafield

Parameters
DataField$datafieldUnderlying model
String$rangeIDRange id
mixed$valueValue

Member Function Documentation

◆ getDisplayValue()

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

getHTML (   $name = '',
  $variables = [] 
)

Returns the according input elements as html for this datafield

Parameters
String$nameName prefix of the associated input
Array$variablesAdditional variables
Returns
String containing the required html

◆ getParameters()

getParameters ( )

Returns the individual type parameters.

Returns
array containing the individual type parameters

Field Documentation

◆ $is_assoc_param

$is_assoc_param = false
protected

◆ $template

$template = 'selectbox.php'
protected

◆ $type_param

$type_param
protected

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