eZ Publish  [4.2]
eZOption Class Reference

eZOption handles option set datatypes More...

List of all members.

Public Member Functions

 addOption ($valueArray)
 attribute ($name)
 attributes ()
 decodeXML ($xmlString)
 eZOption ($name)
 hasAttribute ($name)
 insertOption ($valueArray, $beforeID)
 name ()
 removeOptions ($array_remove)
 setName ($name)
 xmlString ()

Public Attributes

 $Name
 Contains the Option name.
 $OptionCount
 Contains the option counter value.
 $Options
 Contains the Options.

Detailed Description

eZOption handles option set datatypes

  //include_once( "kernel/classes/datatypes/ezoption/ezoption.php" );

  $option = new eZOption( "Colour" );
  $option->addValue( "Red" );
  $option->addValue( "Green" );

  // Serialize the class to an XML document
  $xmlString = $option->xmlString();

Definition at line 50 of file ezoption.php.


Member Function Documentation

eZOption::addOption ( valueArray)

Adds an option

Definition at line 79 of file ezoption.php.

Referenced by decodeXML().

eZOption::attribute ( name)

Definition at line 122 of file ezoption.php.

eZOption::attributes ( )

Definition at line 111 of file ezoption.php.

Referenced by hasAttribute().

eZOption::decodeXML ( xmlString)

Will decode an xml string and initialize the eZ option object

Definition at line 145 of file ezoption.php.

eZOption::eZOption ( name)

Definition at line 52 of file ezoption.php.

eZOption::hasAttribute ( name)

Definition at line 117 of file ezoption.php.

eZOption::insertOption ( valueArray,
beforeID 
)

Definition at line 91 of file ezoption.php.

eZOption::name ( )

Returns the name of the option set.

Definition at line 71 of file ezoption.php.

eZOption::removeOptions ( array_remove)

Definition at line 100 of file ezoption.php.

eZOption::setName ( name)

Sets the name of the option

Definition at line 62 of file ezoption.php.

Referenced by decodeXML(), and eZOptionType\initializeObjectAttribute().

eZOption::xmlString ( )

Will return the XML string for this option set.

Definition at line 175 of file ezoption.php.


Member Data Documentation

eZOption::$Name

Contains the Option name.

Definition at line 204 of file ezoption.php.

eZOption::$OptionCount

Contains the option counter value.

Definition at line 210 of file ezoption.php.

eZOption::$Options

Contains the Options.

Definition at line 207 of file ezoption.php.


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