BasicAttribute Class Reference

Inheritance diagram for BasicAttribute:

Collaboration diagram for BasicAttribute:

Public Member Functions
	__construct ($id, $docid, $label)
	getLabel ()
	getOption ($x, $def="")
	getOptions ()
	setOption ($x, $v)
	setVisibility ($vis)
	setNeeded ($need)
	isReal ()
	inArray ()
	isMultiple ()
	getTab ()
	getXmlSchema ()
	getXmlValue ()
	getTextualValue ()
	common_getXmlSchema (&$play)

Static Public Member Functions
static	encodeXml ($s, $quot=false)

Data Fields
	$id
	$docid
	$labelText
	$visibility
	$options
	$docname
	$type

Detailed Description

Generic attribute class

Author

anakeen

Definition at line 23 of file Class.DocAttribute.php.

Constructor & Destructor Documentation

__construct	(		$id,
			$docid,
			$label
	)

Construct a basic attribute

Parameters

string	$id	logical name of the attr
string	$docid
string	$label

Definition at line 41 of file Class.DocAttribute.php.

Member Function Documentation

common_getXmlSchema

(

&

$play

)

Generate XML schema layout

Parameters

unknown_type

$play

Definition at line 235 of file Class.DocAttribute.php.

Here is the call graph for this function:

static encodeXml (   $s,   $quot = false  )

static

Escape value with xml entities

Parameters

string

$s

value

Returns

string

Definition at line 144 of file Class.DocAttribute.php.

getLabel

(

)

Return attribute label

Returns

string

Definition at line 52 of file Class.DocAttribute.php.

getOption	(		$x,
			$def = ""
	)

Return value of option $x

Parameters

$x	option name
$def	default value

Returns

string

Definition at line 67 of file Class.DocAttribute.php.

getOptions

(

)

Return all value of options

Returns

array

Definition at line 88 of file Class.DocAttribute.php.

Here is the call graph for this function:

getTab

(

)

Get tab ancestor

Returns

FieldSetAttribute

Definition at line 196 of file Class.DocAttribute.php.

getTextualValue

(

)

Get human readable textual value Fallback method

Returns

NULL

Definition at line 226 of file Class.DocAttribute.php.

getXmlSchema

(

)

Export values as xml fragment

Returns

string

Definition at line 207 of file Class.DocAttribute.php.

getXmlValue

(

)

Export values as xml fragment

Returns

string

Definition at line 216 of file Class.DocAttribute.php.

inArray

(

)

to see if an attribute is n item of an array

Returns

boolean

Definition at line 175 of file Class.DocAttribute.php.

isMultiple

(

)

verify if accept multiple value

Returns

boolean

Definition at line 187 of file Class.DocAttribute.php.

Here is the call graph for this function:

isReal

(

)

test if attribute is not a auto created attribute

Returns

void

Definition at line 133 of file Class.DocAttribute.php.

Here is the call graph for this function:

setNeeded

(

$need

)

temporary change need

Parameters

bool

$need

true means needed, false not needed

Returns

void

Definition at line 124 of file Class.DocAttribute.php.

setOption	(		$x,
			$v
	)

Temporary change option

Parameters

$x	name
$v	value

Returns

void

Definition at line 103 of file Class.DocAttribute.php.

Here is the call graph for this function:

setVisibility

(

$vis

)

temporary change visibility

Parameters

char

$vis

new visibility : R|H|W|O|I

Returns

void

Definition at line 115 of file Class.DocAttribute.php.

Field Documentation

$docid

Definition at line 26 of file Class.DocAttribute.php.

$docname

Definition at line 30 of file Class.DocAttribute.php.

$id

Definition at line 25 of file Class.DocAttribute.php.

$labelText

Definition at line 27 of file Class.DocAttribute.php.

$options

Definition at line 29 of file Class.DocAttribute.php.

$type

Definition at line 31 of file Class.DocAttribute.php.

$visibility

Definition at line 28 of file Class.DocAttribute.php.

---

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

• Class.DocAttribute.php