ReferenceDescription Class Reference

Detailed Description

Instances of ReferenceDescription describe reference attributes of PersistentObjects.

Author

ingo herwig ingo@.nosp@m.wemo.nosp@m.ve.co.nosp@m.m

Definition at line 21 of file ReferenceDescription.php.

Inheritance diagram for ReferenceDescription:

Public Member Functions
	__construct ($name, $otherType, $otherName)
	getOtherType ()
	getOtherName ()
	getName ()
	getType ()
	getTags ()
	getDefaultValue ()
	getValidateType ()
	getValidateDescription ()
	getIsEditable ()
	getInputType ()
	getDisplayType ()
Public Member Functions inherited from AttributeDescription
	__construct ($name, $type, array $tags, $defaultValue, $validateType, $validateDescription, $isEditable, $inputType, $displayType)
	hasTag ($tag)
	matchTags (array $tags=array(), $matchMode='all')
	getPropertyNames ()
	getName ()
	getType ()
	getTags ()
	getDefaultValue ()
	getValidateType ()
	getValidateDescription ()
	getIsEditable ()
	getInputType ()
	getDisplayType ()

Protected Attributes
	$otherType = ''
	$otherName = ''
Protected Attributes inherited from AttributeDescription
	$name = ''
	$type = 'String'
	$tags = array()
	$defaultValue = null
	$validateType = ''
	$validateDescription = ''
	$isEditable = true
	$inputType = 'text'
	$displayType = 'text'

Constructor & Destructor Documentation

__construct	(		$name,
			$otherType,
			$otherName
	)

Constructor.

Parameters

$name	The name of the reference
$otherType	The name of the referenced type (must be the role name,

See also

RelationDescription)

Parameters

$otherName

The name of the referenced attribute in the referenced type

Definition at line 32 of file ReferenceDescription.php.

Member Function Documentation

getOtherType

(

)

Get the name of the referenced type.

Returns

String

Definition at line 42 of file ReferenceDescription.php.

getOtherName

(

)

Get the name of the referenced attribute in the referenced type.

Returns

String

Definition at line 50 of file ReferenceDescription.php.

getName

(

)

Get the attribute name.

Returns

String

Definition at line 58 of file ReferenceDescription.php.

getType

(

)

Get the attribute type.

Returns

String

Definition at line 66 of file ReferenceDescription.php.

getTags

(

)

Get the application specific tags that this attribute is tagged with.

Returns

Array of String

Definition at line 75 of file ReferenceDescription.php.

getDefaultValue

(

)

Get the default value.

Returns

Mixed

Definition at line 84 of file ReferenceDescription.php.

getValidateType

(

)

Get the validation type for the value.

Returns

String

Definition at line 93 of file ReferenceDescription.php.

getValidateDescription

(

)

Get the description for the validation type.

Returns

String

Definition at line 102 of file ReferenceDescription.php.

getIsEditable

(

)

Check whether the attribute should be editable.

Returns

Boolean

Definition at line 111 of file ReferenceDescription.php.

getInputType

(

)

Get the input type for the value.

Returns

String

Definition at line 119 of file ReferenceDescription.php.

getDisplayType

(

)

Get the display type for the value.

Returns

String

Definition at line 128 of file ReferenceDescription.php.

Member Data Documentation

$otherType = ''

protected

Definition at line 23 of file ReferenceDescription.php.

$otherName = ''

protected

Definition at line 24 of file ReferenceDescription.php.