Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Concrete class for working with List entries.

array
$_custom= 'array()'
List of custom row elements (Zend_Gdata_Spreadsheets_Extension_Custom), indexed by order added to this entry.
array()
Details
array
$_customByName= 'array()'
List of custom row elements (Zend_Gdata_Spreadsheets_Extension_Custom), indexed by element name.
array()
Details
__construct(
\DOMElement $element
=
null
)
:
void
Constructs a new Zend_Gdata_Spreadsheets_ListEntry object.
Name | Type | Description |
---|---|---|
$element | \DOMElement | An existing XML element on which to base this new object. |

addCustom(
\Zend_Gdata_Spreadsheets_Extension_Custom $custom
)
:
\Zend_Gdata_Spreadsheets_ListEntry
Add an individual custom row element to this list entry.
Name | Type | Description |
---|---|---|
$custom | \Zend_Gdata_Spreadsheets_Extension_Custom | The custom element to be added. |
Type | Description |
---|---|
\Zend_Gdata_Spreadsheets_ListEntry | Provides a fluent interface. |

getCustom(
)
:
array
Gets the row elements contained by this list entry.
Type | Description |
---|---|
array | The custom row elements in this list entry |

getCustomByName(
string $name
=
null
)
:
mixed
Gets a single row element contained by this list entry using its name.
Name | Type | Description |
---|---|---|
$name | string | 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. |
Type | Description |
---|---|
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. |

getDOM(
$doc
=
null, $majorVersion
=
1, $minorVersion
=
null
)
:
void
Name | Type | Description |
---|---|---|
$doc | ||
$majorVersion | ||
$minorVersion |

removeCustom(
int $index
)
:
\Zend_Gdata_Spreadsheets_ListEntry
Remove an individual row element from this list entry by index. This will cause the array to be re-indexed.
Name | Type | Description |
---|---|---|
$index | int | The index of the custom element to be deleted. |
Type | Description |
---|---|
\Zend_Gdata_Spreadsheets_ListEntry | Provides a fluent interface. |
Exception | Description |
---|---|
\Zend_Gdata_App_InvalidArgumentException |

removeCustomByName(
string $name
)
:
\Zend_Gdata_Spreadsheets_ListEntry
Remove an individual row element from this list entry by name.
Name | Type | Description |
---|---|---|
$name | string | The name of the custom element to be deleted. |
Type | Description |
---|---|
\Zend_Gdata_Spreadsheets_ListEntry | Provides a fluent interface. |
Exception | Description |
---|---|
\Zend_Gdata_App_InvalidArgumentException |

setCustom(
array $custom
)
:
\Zend_Gdata_Spreadsheets_ListEntry
Sets the row elements contained by this list entry. If any custom row elements were previously stored, they will be overwritten.
Name | Type | Description |
---|---|---|
$custom | array | The custom row elements to be contained in this list entry. |
Type | Description |
---|---|
\Zend_Gdata_Spreadsheets_ListEntry | Provides a fluent interface. |