📚 Looking for current Exponential documentation? This site contains legacy SDK & API reference docs (eZ Publish era). For up-to-date 2026 product documentation, visit doc.exponential.earth.

  class / eZOption  

API Reference
 

Sections

Todo

eZOption Class Reference
[Kernel system]

eZOption handles option set datatypes More...

List of all members.


Public Methods

 setName ($name)
& name ()
 addOption ($valueArray)
 decodeXML ($xmlString)
& xmlString ()

Public Attributes

 Name
 Contains the Option name.

 Options
 Contains the Options.

 OptionCount
 Contains the option counter value.

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 ezoption.php.

Member Function Documentation

eZOption::addOption (  $    valueArray ) 
 

Adds an option

Definition at line ezoption.php.

References Options.

Referenced by decodeXML().

eZOption::decodeXML (  $    xmlString ) 
 

Will decode an xml string and initialize the eZ option object

Definition at line ezoption.php.

References xmlString().

& eZOption::name (    ) 
 

Returns the name of the option set.

Definition at line ezoption.php.

References Name.

Referenced by xmlString().

eZOption::setName (  $    name ) 
 

Sets the name of the option

Definition at line ezoption.php.

References name().

Referenced by decodeXML().

& eZOption::xmlString (    ) 
 

Will return the XML string for this option set.

Definition at line ezoption.php.

References name().

Referenced by decodeXML().

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

Exponential Copyright © 1998 - 2026 7x