Inheritance diagram for NormalAttribute:

Collaboration diagram for NormalAttribute:

Public Member Functions
	__construct ($id, $docid, $label, $type, $format, $repeat, $order, $link, $visibility, $needed, $isInTitle, $isInAbstract, &$fieldSet, $phpfile, $phpfunc, $elink, $phpconstraint="", $usefor="", $eformat="", $options="", $docname="")

	getXmlSchema ($la)

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

	text_getXmlSchema ()

	enum_getXmlSchema ()

	docid_getXmlSchema ()

	date_getXmlSchema ()

	timestamp_getXmlSchema ()

	color_getXmlSchema ()

	int_getXmlSchema ()

	longtext_getXmlSchema ()

	float_getXmlSchema ()

	time_getXmlSchema ()

	file_getXmlSchema ()

	array_getXmlSchema (&$la)

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

	getEnum ()

	getEnumLabel ($enumid=null)

	addEnum ($dbaccess, $key, $label)

	existEnum ($key)

Public Member Functions inherited from BasicAttribute
	__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)

Data Fields
	$needed

	$format

	$eformat

	$repeat

	$isInTitle

	$isInAbstract

	$fieldSet

	$link

	$phpfile

	$phpfunc

	$elink

	$ordered

	$phpconstraint

	$usefor

Data Fields inherited from BasicAttribute
	$id

	$docid

	$labelText

	$visibility

	$options

	$docname

	$type

Protected Attributes
	$textualValueMultipleSeparator

Additional Inherited Members
Static Public Member Functions inherited from BasicAttribute
static	encodeXml ($s, $quot=false)

Detailed Description

NormalAttribute Class Non structural attribute (all attribute except frame and tab)

Author: anakeen

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

Constructor & Destructor Documentation

__construct	(		$id,
			$docid,
			$label,
			$type,
			$format,
			$repeat,
			$order,
			$link,
			$visibility,
			$needed,
			$isInTitle,
			$isInAbstract,
		&	$fieldSet,
			$phpfile,
			$phpfunc,
			$elink,
			$phpconstraint = `""`,
			$usefor = `""`,
			$eformat = `""`,
			$options = `""`,
			$docname = `""`
	)

Normal Attribute constructor : non structural attribute

Parameters

int	$id	id of the attribute
int	$docid	id of the family
string	$label	default translate key
string	$type	kind of attribute
string	$format	format option
string	$repeat	is repeteable attr
int	$order	display order
string	$link	link option
string	$visibility	visibility option
char	$needed	is mandotary attribute
char	$isInTitle	is used to compute title
char	$isInAbstract	is used in abstract view
string	$fieldSet	parent attribute
string	$phpfile	php file used with the phpfunc
string	$phpfunc	helpers function
string	$elink	eling option
string	$phpconstraint	class php function
string	$usefor	Attribute or Parameter
string	$eformat	eformat option
string	$options	option string
unknown_type	$docname

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

Member Function Documentation

addEnum	(	$dbaccess,
		$key,
		$label
	)

add new item in enum list items

Parameters

string	$dbaccess	dbaccess string
string	$key	database key
string	$label	human label

Returns: string error message (empty means ok)

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

Here is the call graph for this function:

array_getXmlSchema ( & $la )

Array XML schema

Returns: string

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

Here is the call graph for this function:

color_getXmlSchema ( )

Color XML schema

Returns: string

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

Here is the call graph for this function:

date_getXmlSchema ( )

date XML schema

Returns: string

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

Here is the call graph for this function:

docid_getXmlSchema ( )

docid XML schema

Returns: string

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

Here is the call graph for this function:

enum_getXmlSchema ( )

enum XML schema

Returns: string

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

Here is the call graph for this function:

existEnum ( $key )

Test if an enum key existe

Parameters

string $key enumKey

Returns: boolean

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

Here is the call graph for this function:

file_getXmlSchema ( )

File XML schema

Returns: string

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

Here is the call graph for this function:

float_getXmlSchema ( )

Float XML schema

Returns: string

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

Here is the call graph for this function:

getEnum ( )

Return array of enumeration definition the array's keys are the enum key and the values are the labels

Returns: array

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

Here is the call graph for this function:

getEnumLabel ( $enumid = null )

return array of enumeration definition the array'skeys are the enum single key and the values are the complete labels

Parameters

string $enumid the key of enumerate (if no parameter all labels are returned

Returns: array

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

Here is the call graph for this function:

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

Get the textual value of an attribute

Parameters

Doc	$doc	current Doc
int	$index	index if multiple
array	$configuration	value config array : dateFormat => 'US' 'ISO', decimalSeparator => '.', multipleSeparator => array(0 => 'arrayLine', 1 => 'multiple') (defaultValue : dateFormat : 'US', decimalSeparator : '.', multiple => array(0 => "\n", 1 => ", "))

Returns: string

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

getXmlSchema ( $la )

Generate the xml schema fragment

Parameters

array $la array of DocAttribute

Returns: string

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

Here is the call graph for this function:

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

export values as xml fragment

Parameters

Doc	$doc	working doc
StdObject	$opt

Returns: string

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

Here is the call graph for this function:

int_getXmlSchema ( )

int XML schema

Returns: string

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

Here is the call graph for this function:

longtext_getXmlSchema ( )

longText XML schema

Returns: string

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

Here is the call graph for this function:

text_getXmlSchema ( )

custom textual XML schema

Returns: string

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

Here is the call graph for this function:

time_getXmlSchema ( )

Time XML schema

Returns: string

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

Here is the call graph for this function:

timestamp_getXmlSchema ( )

timeStamp XML schema

Returns: string

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

Here is the call graph for this function:

Field Documentation

$eformat

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

$elink

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

$fieldSet

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

$format

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

$isInAbstract

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

$isInTitle

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

$link

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

$needed

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

$ordered

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

$phpconstraint

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

$phpfile

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

$phpfunc

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

$repeat

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

$textualValueMultipleSeparator

protected

Initial value:

= array(
        0 => "\n",
        1 => ", "
    )

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

$usefor

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

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

Class.DocAttribute.php

Public Member Functions

Data Fields

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation