Zend_Gdata_Spreadsheets_ListEntry Class Reference

Inheritance diagram for Zend_Gdata_Spreadsheets_ListEntry:

Collaboration diagram for Zend_Gdata_Spreadsheets_ListEntry:

Public Member Functions
	__construct ($element=null)
	getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
	getCustom ()
	getCustomByName ($name=null)
	setCustom ($custom)
	addCustom ($custom)
	removeCustom ($index)
	removeCustomByName ($name)
Protected Member Functions
	takeChildFromDOM ($child)
Protected Attributes
	$_entryClassName = 'Zend_Gdata_Spreadsheets_ListEntry'
	$_custom = array()
	$_customByName = array()

---

Detailed Description

Definition at line 43 of file ListEntry.php.

---

Constructor & Destructor Documentation

__construct

(

$

element = null

)

Constructs a new Zend_Gdata_Spreadsheets_ListEntry object.

Parameters:

DOMElement

$element

An existing XML element on which to base this new object.

Reimplemented from Zend_Gdata_Entry.

Definition at line 66 of file ListEntry.php.

Here is the call graph for this function:

---

Member Function Documentation

addCustom

(

$

custom

)

Add an individual custom row element to this list entry.

Parameters:

Zend_Gdata_Spreadsheets_Extension_Custom

$custom

The custom element to be added.

Returns:

Zend_Gdata_Spreadsheets_ListEntry Provides a fluent interface.

Definition at line 152 of file ListEntry.php.

Here is the caller graph for this function:

getCustom

(

)

Gets the row elements contained by this list entry.

Returns:

array The custom row elements in this list entry

Definition at line 101 of file ListEntry.php.

getCustomByName

(

$

name = null

)

Gets a single row element contained by this list entry using its name.

Parameters:

string

$name

The name of a custom element to return. If null or not defined, an array containing all custom elements indexed by name will be returned.

Returns:

mixed If a name is specified, the Zend_Gdata_Spreadsheets_Extension_Custom element requested, is returned or null if not found. Otherwise, an array of all Zend_Gdata_Spreadsheets_Extension_Custom elements is returned indexed by name.

Definition at line 117 of file ListEntry.php.

getDOM	(	$	doc = null,
		$	majorVersion = 1,
		$	minorVersion = null
	)

Retrieves a DOMElement which corresponds to this element and all child properties. This is used to build an entry back into a DOM and eventually XML text for sending to the server upon updates, or for application storage/persistence.

Parameters:

DOMDocument

$doc

The DOMDocument used to construct DOMElements

Returns:

DOMElement The DOMElement representing this element and all child properties.

Reimplemented from Zend_Gdata_Entry.

Definition at line 72 of file ListEntry.php.

removeCustom

(

$

index

)

Remove an individual row element from this list entry by index. This will cause the array to be re-indexed.

Parameters:

int

$index

The index of the custom element to be deleted.

Returns:

Zend_Gdata_Spreadsheets_ListEntry Provides a fluent interface.

Exceptions:

Zend_Gdata_App_InvalidArgumentException

Definition at line 166 of file ListEntry.php.

removeCustomByName

(

$

name

)

Remove an individual row element from this list entry by name.

Parameters:

string

$name

The name of the custom element to be deleted.

Returns:

Zend_Gdata_Spreadsheets_ListEntry Provides a fluent interface.

Exceptions:

Zend_Gdata_App_InvalidArgumentException

Definition at line 191 of file ListEntry.php.

setCustom

(

$

custom

)

Sets the row elements contained by this list entry. If any custom row elements were previously stored, they will be overwritten.

Parameters:

array

$custom

The custom row elements to be contained in this list entry.

Returns:

Zend_Gdata_Spreadsheets_ListEntry Provides a fluent interface.

Definition at line 137 of file ListEntry.php.

Here is the call graph for this function:

takeChildFromDOM

(

$

child

)

[protected]

Given a child DOMNode, tries to determine how to map the data into object instance members. If no mapping is defined, Extension_Element objects are created and stored in an array.

Parameters:

DOMNode

$child

The DOMNode needed to be handled

Reimplemented from Zend_Gdata_Entry.

Definition at line 83 of file ListEntry.php.

Here is the call graph for this function:

---

Field Documentation

$_custom = array() [protected]

Definition at line 53 of file ListEntry.php.

$_customByName = array() [protected]

Definition at line 60 of file ListEntry.php.

$_entryClassName = 'Zend_Gdata_Spreadsheets_ListEntry' [protected]

Reimplemented from Zend_Gdata_Entry.

Definition at line 46 of file ListEntry.php.

---

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

• C:/xampp/htdocs/moodle/lib/zend/Zend/Gdata/Spreadsheets/ListEntry.php