DataFieldPhoneEntry Class Reference

Inheritance diagram for DataFieldPhoneEntry:

Public Member Functions
	numberOfHTMLFields ()
	setValueFromSubmit ($value)
	getDisplayValue ($entities=true)
	getHTML ($name='', $variables=[])
	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=[])
	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 = ''
	$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
Static Protected Attributes inherited from DataFieldEntry
static	$supported_types

Detailed Description

Author

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

Marcus Lunzenauer mlunz.nosp@m.ena@.nosp@m.uos.d.nosp@m.e

Martin Gieseking mgies.nosp@m.eki@.nosp@m.uos.d.nosp@m.e GPL2 or any later version

Member Function Documentation

getDisplayValue()

getDisplayValue

(

$entities = true

)

Returns the display/rendered value of this datafield

Parameters

bool

$entities

Should 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	$name	Name prefix of the associated input
Array	$variables	Additional variables

Returns

String containing the required html

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.

isEmpty()

isEmpty

(

)

Checks if the datafield is empty (was not set)

Returns

bool true if empty, else false

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_value

The value from request

Field Documentation

$template

$template = 'phone.php'

protected

---

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

• lib/classes/DataFieldPhoneEntry.php