Stud.IP  4.2 Revision
DataFieldPhoneEntry Class Reference
Inheritance diagram for DataFieldPhoneEntry:
Inheritance graph
Collaboration diagram for DataFieldPhoneEntry:
Collaboration graph

Public Member Functions

 numberOfHTMLFields ()
 
 setValueFromSubmit ($value)
 
 getDisplayValue ($entities=true)
 
 getHTML ($name='', $variables=array())
 
 isEmpty ()
 
 isValid ()
 
- 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=array())
 
 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

 getNumberParts ()
 
- Protected Member Functions inherited from DataFieldEntry
 prettyPrintViewPerms ()
 

Protected Attributes

 $template = 'phone.php'
 
- Protected Attributes inherited from DataFieldEntry
 $language = ''
 

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
 
- Static Protected Attributes inherited from DataFieldEntry
static $supported_types
 

Detailed Description

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
Here is the call graph for this function:

◆ getHTML()

getHTML (   $name = '',
  $variables = array() 
)

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
Here is the call graph for this function:

◆ getNumberParts()

getNumberParts ( )
protected

Retturns the individual parts of the telephone number. The resulting array is always padded to contain at least three items.

Returns
array containing the individual parts.
Here is the caller graph for this function:

◆ isEmpty()

isEmpty ( )

Checks if the datafield is empty (was not set)

Returns
bool true if empty, else false
Here is the call graph for this function:

◆ isValid()

isValid ( )

Returns whether the datafield contents are valid

Returns
boolean indicating whether the datafield contents are valid

◆ numberOfHTMLFields()

numberOfHTMLFields ( )

Returns the number of html fields this datafield uses for input.

Returns
int representing the number of html fields

◆ setValueFromSubmit()

setValueFromSubmit (   $value)

Sets the value from a post request

Parameters
mixed$submitted_valueThe value from request

Field Documentation

◆ $template

$template = 'phone.php'
protected

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