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)
	isReal ()
	inArray ()
	isMultiple ()
	isMultipleInArray ()
	getTab ()
	getXmlSchema ($la)
	getXmlValue (Doc &$doc, $opt=false)
	getTextualValue (Doc $doc, $index=-1, Array $configuration=array())
	common_getXmlSchema (&$play)

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

Data Fields
const	hiddenFieldId = Adoc::HIDDENFIELD
	$id
	$docid
	$labelText
	$visibility
	$mvisibility
	$options
	mask visibility More...
	$docname
	$type
	$usefor
	$ordered
	$format
	$isNormal = null
	$fieldSet
	$_topt = null

Detailed Description

Generic attribute class

Author

Anakeen

Definition at line 21 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 51 of file Class.DocAttribute.php.

Member Function Documentation

common_getXmlSchema

(

&

$play

)

Generate XML schema layout

Parameters

Layout

$play

Definition at line 259 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
bool	$quot	to encode also quote "

Returns

string

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

getLabel

(

)

Return attribute label

Returns

string

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

getOption	(		$x,
			$def = ""
	)

Return value of option $x

Parameters

string	$x	option name
string	$def	default value

Returns

string

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

getOptions

(

)

Return all value of options

Returns

array

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

Here is the call graph for this function:

getTab

(

)

Get tab ancestor false if not found

Returns

FieldSetAttribute|bool

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

getTextualValue	(	Doc	$doc,
			$index = - 1,
		Array	$configuration = array()
	)

Get human readable textual value Fallback method

Parameters

Doc	$doc	current Doc
int	$index	index if multiple
array	$configuration	value

Returns

string

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

getXmlSchema

(

$la

)

Export values as xml fragment

Parameters

array

$la

array of DocAttribute

Returns

string

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

getXmlValue	(	Doc &	$doc,
			$opt = false
	)

export values as xml fragment

Parameters

Doc	$doc	working doc
bool | \exportOptionAttribute	$opt

Deprecated:

use class instead

Returns

string

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

inArray

(

)

to see if an attribute is n item of an array

Returns

boolean

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

isMultiple

(

)

verify if accept multiple value

Returns

boolean

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

Here is the call graph for this function:

isMultipleInArray

(

)

verify if attribute is multiple value and if is also in array multiple^2

Returns

boolean

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

Here is the call graph for this function:

isReal

(

)

test if attribute is not a auto created attribute

Returns

boolean

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

Here is the call graph for this function:

setOption	(		$x,
			$v
	)

Temporary change option

Parameters

string	$x	name
string	$v	value

Returns

void

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

Here is the call graph for this function:

setVisibility

(

$vis

)

temporary change visibility

Parameters

string

$vis

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

Returns

void

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

Field Documentation

$_topt = null

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

$docid

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

$docname

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

$fieldSet

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

$format

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

$id

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

$isNormal = null

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

$labelText

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

$mvisibility

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

$options

mask visibility

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

$ordered

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

$type

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

$usefor

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

$visibility

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

const hiddenFieldId = Adoc::HIDDENFIELD

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

---

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

• Class.DocAttribute.php