- Developper API  2.0.5
Property Class Reference

A Property is a data structure that is made up of:
More...

Public Member Functions

 __construct ($name, $label, $value, $language="")
 Property constructor.
 getName ()
 Return the name of the property or false if empty.
 getLabel ()
 Return the label of the property or false if empty.
 getValue ()
 Return the value of the property or false if empty.
 getLanguage ()
 Return the language of the property or false if empty.
 __toString ()
 Return the property values as a String.

Static Public Member Functions

static getPropertyFromSXMLElement ($node)
 Build a property from a SimpleXMLElement. It returns false if the node doesn t contain a property.
static isSXMLNodeProperty ($node)
 Check whether or not the SimpleXMLElement node is a property.

Detailed Description

A Property is a data structure that is made up of:

  • name: name of the xml node
  • label: text content of label node if exists
  • value: text content of value node if exists otherwise it contains the direct text value of the node
  • language: text content of language node if exists
Author:
Thomas
Version:
1.0
Date:
08/12/2011

Constructor & Destructor Documentation

__construct ( name,
label,
value,
language = "" 
)

Property constructor.

Parameters:
Stringname of the node containing the property
Stringlabel text content of the node label (if exists)
Stringvalue text content of value node if exists otherwise it contains the direct text value of the node
Stringlanguage text content of language node if exists
Returns:
Property

Definition at line 39 of file Property.php.


Member Function Documentation

__toString ( )

Return the property values as a String.

Returns:
String

Definition at line 87 of file Property.php.

getLabel ( ) [final]

Return the label of the property or false if empty.

Returns:
String / false

Definition at line 60 of file Property.php.

getLanguage ( ) [final]

Return the language of the property or false if empty.

Returns:
String / false

Definition at line 78 of file Property.php.

getName ( ) [final]

Return the name of the property or false if empty.

Returns:
String / false

Definition at line 51 of file Property.php.

static getPropertyFromSXMLElement ( node) [static, final]

Build a property from a SimpleXMLElement. It returns false if the node doesn t contain a property.

Parameters:
SimpleXmlElementnode
Returns:
Property / false

Definition at line 97 of file Property.php.

getValue ( ) [final]

Return the value of the property or false if empty.

Returns:
String / false

Definition at line 69 of file Property.php.

static isSXMLNodeProperty ( node) [static, final]

Check whether or not the SimpleXMLElement node is a property.

Parameters:
SimpleXmlElementnode
Returns:
Boolean

Definition at line 151 of file Property.php.


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