Encapsulates multiple options in one datatype. More...

Public Member Functions
	addChildGroup ($group, $multioptionID=false)
	addMultiOption ($name, $multiOptionPriority, $defaultValue, $multiOptionID)
	addOption ($newID, $OptionID, $optionValue, $optionAdditionalPrice, $isSelectable=1, $objectID=0)
	addOptionForMultioptionID ($multioptionID, $OptionID, $optionValue, $optionAdditionalPrice)
	addOptionToRules ($multioptionID, $optionID)
	attribute ($name)
	attributes ()
	changeMultiOptionId ()
	cleanupRules ()
	createDomElementForGroup ($doc, $groupNode, $depth=0)
	decodeXML ($xmlString)
	eZMultiOption2 ($name, $id=0, $multioptionIDCounter=0, $optionCounter=0, $groupID=0)
	findGroup ($groupID, $depth=0, $groupStack=array())
	findMultiOption ($multioptionID, $depth=0)
	findOption ($multioption, $optionID)
	getGroupIDCounter ()
	getIDsFromMultioptions ($params)
	getMultiOptionIDCounter ()
	getOptionCounter ()
	hasAttribute ($name)
	initCounters ($group)
	initCountersRecursive ()
	initFromXMLCompat ($root, $new=false)
	initGroupFromDom ($root, $new=false)
	removeChildGroup ($groupID, $depth=0)
	removeMultiOptions ($array_remove)
	removeObjectFromOption ($multioptionID, $optionID)
	removeOptions ($arrayRemove, $optionId)
	resetCounters ()
	resetOptionCounter ()
	runFunctionForAllGroups ($func, $params)
	setGroupIDCounter ($groupIDCounter)
	setMultiOptionIDCounter ($multioptionIDCounter)
	setObjectForOption ($multioptionID, $optionID, $objectID)
	setOptionCounter ($optionCounter)
	xmlString ()
Public Attributes
	$ChildGroupList
	$GroupID
	$GroupIDCounter
	$MultiOptionIDCounter
	Contains the multioption counter value.
	$MultioptionIDList = array()
	$Name
	Contains the Option name.
	$OptionCounter
	Contains the option counter value.
	$OptionIDList = array()
	$Options
	Contains the Options.

Detailed Description

Encapsulates multiple options in one datatype.

Definition at line 16 of file ezmultioption2.php.

Member Function Documentation

eZMultiOption2::addChildGroup	(	$	group,
		$	multioptionID = `false`
	)

Definition at line 62 of file ezmultioption2.php.

Referenced by eZMultiOption2Type\customObjectAttributeHTTPAction(), and decodeXML().

eZMultiOption2::addMultiOption	(	$	name,
		$	multiOptionPriority,
		$	defaultValue,
		$	multiOptionID
	)

Adds an Multioption named $name

Parameters:

$name	contains the name of multioption.
$multiOptionPriority	is stored for displaying the array in order.
$defaultValue	is stored to display the options by default.

Returns:: The ID of the multioption that was added.

Definition at line 92 of file ezmultioption2.php.

Referenced by initGroupFromDom().

eZMultiOption2::addOption	(	$	newID,
		$	OptionID,
		$	optionValue,
		$	optionAdditionalPrice,
		$	isSelectable = `1`,
		$	objectID = `0`
	)

Adds an Option to multioption $name

Parameters:

$newID	is the element key value to which the new option will be added.
$optionValue	is the original value to display for users.
$optionAdditionalPrice	is a price value that is used to store price of the option values.

Definition at line 123 of file ezmultioption2.php.

Referenced by initGroupFromDom().

eZMultiOption2::addOptionForMultioptionID	(	$	multioptionID,
		$	OptionID,
		$	optionValue,
		$	optionAdditionalPrice
	)

Definition at line 149 of file ezmultioption2.php.

eZMultiOption2::addOptionToRules	(	$	multioptionID,
		$	optionID
	)

Definition at line 488 of file ezmultioption2.php.

eZMultiOption2::attribute ( $ name )

Returns an attribute. The valid attributes are name and multioption_list name contains the name of multioption multioption_list contains the list of all multioptions.

Definition at line 531 of file ezmultioption2.php.

Referenced by findGroup(), initCounters(), and removeChildGroup().

eZMultiOption2::attributes ( )

Returns:: list of supported attributes

Definition at line 506 of file ezmultioption2.php.

Referenced by hasAttribute().

eZMultiOption2::changeMultiOptionId ( )

Change the id of multioption in ascending order.

Definition at line 342 of file ezmultioption2.php.

Referenced by initGroupFromDom(), and removeMultiOptions().

eZMultiOption2::cleanupRules ( )

Definition at line 442 of file ezmultioption2.php.

eZMultiOption2::createDomElementForGroup	(	$	doc,
		$	groupNode,
		$	depth = `0`
	)

Definition at line 786 of file ezmultioption2.php.

Referenced by xmlString().

eZMultiOption2::decodeXML ( $ xmlString )

Will decode an xml string and initialize the eZ Multi option object. If $xmlString is on empty then it will call addMultiOption() and addOption() functions to create new multioption else it will decode the xml string.

Parameters:

$xmlString contain the complete data structure for multioptions.

See also:: xmlString()

Definition at line 595 of file ezmultioption2.php.

eZMultiOption2::eZMultiOption2	(	$	name,
		$	id = `0`,
		$	multioptionIDCounter = `0`,
		$	optionCounter = `0`,
		$	groupID = `0`
	)

Initializes with empty multioption2 list.

Definition at line 21 of file ezmultioption2.php.

Referenced by decodeXML(), initFromXMLCompat(), and initGroupFromDom().

eZMultiOption2::findGroup	(	$	groupID,
		$	depth = `0`,
		$	groupStack = `array()`
	)

Definition at line 191 of file ezmultioption2.php.

eZMultiOption2::findMultiOption	(	$	multioptionID,
		$	depth = `0`
	)

Definition at line 227 of file ezmultioption2.php.

Referenced by addOptionForMultioptionID(), removeObjectFromOption(), and setObjectForOption().

eZMultiOption2::findOption	(	$	multioption,
		$	optionID
	)

Definition at line 259 of file ezmultioption2.php.

eZMultiOption2::getGroupIDCounter ( )

Definition at line 39 of file ezmultioption2.php.

Referenced by initCounters().

eZMultiOption2::getIDsFromMultioptions ( $ params )

Definition at line 427 of file ezmultioption2.php.

eZMultiOption2::getMultiOptionIDCounter ( )

Definition at line 48 of file ezmultioption2.php.

Referenced by initCounters().

eZMultiOption2::getOptionCounter ( )

Definition at line 57 of file ezmultioption2.php.

Referenced by initCounters().

eZMultiOption2::hasAttribute ( $ name )

Returns true if object have an attribute. The valid attributes are name and multioption_list.

Parameters:

$name contains the name of attribute

Definition at line 521 of file ezmultioption2.php.

eZMultiOption2::initCounters ( $ group )

Definition at line 573 of file ezmultioption2.php.

Referenced by addChildGroup(), addOptionForMultioptionID(), decodeXML(), initFromXMLCompat(), and initGroupFromDom().

eZMultiOption2::initCountersRecursive ( )

Definition at line 568 of file ezmultioption2.php.

eZMultiOption2::initFromXMLCompat	(	$	root,
		$	new = `false`
	)

Definition at line 652 of file ezmultioption2.php.

Referenced by decodeXML().

eZMultiOption2::initGroupFromDom	(	$	root,
		$	new = `false`
	)

Definition at line 672 of file ezmultioption2.php.

Referenced by decodeXML().

eZMultiOption2::removeChildGroup	(	$	groupID,
		$	depth = `0`
	)

Definition at line 352 of file ezmultioption2.php.

eZMultiOption2::removeMultiOptions ( $ array_remove )

Remove MultiOption from the array. After calling this function all the options associated with that multioption will be removed. This function also calles to changeMultiOption to reset the key value of multioption array.

Parameters:

$array_remove is the array of those multiOptions which is selected to remove.

See also:: removeOptions()

Definition at line 394 of file ezmultioption2.php.

eZMultiOption2::removeObjectFromOption	(	$	multioptionID,
		$	optionID
	)

Definition at line 172 of file ezmultioption2.php.

eZMultiOption2::removeOptions	(	$	arrayRemove,
		$	optionId
	)

Remove Options from the multioption. This function first remove selected options and then reset the key value if all options for that multioption.

Parameters:

$arrayRemove	is a list of all array elements which is selected to remove from the multioptions.
$optionId	is the key value if multioption from which it is required to remove the options.

See also:: removeMultiOptions()

Definition at line 412 of file ezmultioption2.php.

eZMultiOption2::resetCounters ( )

Definition at line 315 of file ezmultioption2.php.

eZMultiOption2::resetOptionCounter ( )

Finds the largest option_id among the options and sets it as $this->OptionCounter

Definition at line 323 of file ezmultioption2.php.

Referenced by resetCounters().

eZMultiOption2::runFunctionForAllGroups	(	$	func,
		$	params
	)

Definition at line 297 of file ezmultioption2.php.

Referenced by cleanupRules(), and initCountersRecursive().

eZMultiOption2::setGroupIDCounter ( $ groupIDCounter )

Definition at line 34 of file ezmultioption2.php.

eZMultiOption2::setMultiOptionIDCounter ( $ multioptionIDCounter )

Definition at line 43 of file ezmultioption2.php.

Referenced by initCounters().

eZMultiOption2::setObjectForOption	(	$	multioptionID,
		$	optionID,
		$	objectID
	)

Definition at line 159 of file ezmultioption2.php.

eZMultiOption2::setOptionCounter ( $ optionCounter )

Definition at line 52 of file ezmultioption2.php.

eZMultiOption2::xmlString ( )

Will return the XML string for this MultiOption set.

See also:: decodeXML()

Definition at line 749 of file ezmultioption2.php.

Member Data Documentation

eZMultiOption2::$ChildGroupList

Definition at line 868 of file ezmultioption2.php.

eZMultiOption2::$GroupID

Definition at line 860 of file ezmultioption2.php.

eZMultiOption2::$GroupIDCounter

Definition at line 865 of file ezmultioption2.php.

eZMultiOption2::$MultiOptionIDCounter

Contains the multioption counter value.

Definition at line 864 of file ezmultioption2.php.

eZMultiOption2::$MultioptionIDList = array()

Definition at line 869 of file ezmultioption2.php.

eZMultiOption2::$Name

Contains the Option name.

Definition at line 859 of file ezmultioption2.php.

eZMultiOption2::$OptionCounter

Contains the option counter value.

Definition at line 867 of file ezmultioption2.php.

eZMultiOption2::$OptionIDList = array()

Definition at line 870 of file ezmultioption2.php.

eZMultiOption2::$Options

Contains the Options.

Definition at line 862 of file ezmultioption2.php.

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

ezmultioption2.php

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation