## Zend_Gdata_Spreadsheets_ListEntry

Description

Concrete class for working with List entries.

- copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license: New BSD License

Located in /Gdata/Spreadsheets/ListEntry.php (line 43)

    Zend_Gdata_App_Base
       |
       --Zend_Gdata_App_FeedEntryParent
          |
          --Zend_Gdata_App_Entry
             |
             --Zend_Gdata_App_MediaEntry
                |
                --Zend_Gdata_Entry
                   |
                   --Zend_Gdata_Spreadsheets_ListEntry

Variable Summary
array $_custom
array $_customByName
mixed $_entryClassName
Method Summary
Zend_Gdata_Spreadsheets_ListEntry __construct ([DOMElement $element = null])
Zend_Gdata_Spreadsheets_ListEntry addCustom (Zend_Gdata_Spreadsheets_Extension_Custom $custom)
array getCustom ()
mixed getCustomByName ([string $name = null])
void getDOM ([ $doc = null], [ $majorVersion = 1], [ $minorVersion = null])
Zend_Gdata_Spreadsheets_ListEntry removeCustom (int $index)
Zend_Gdata_Spreadsheets_ListEntry removeCustomByName (string $name)
Zend_Gdata_Spreadsheets_ListEntry setCustom (array $custom)
void takeChildFromDOM ( $child)
Variables
array $_custom = array() (line 53)

List of custom row elements (Zend_Gdata_Spreadsheets_Extension_Custom), indexed by order added to this entry.

- access: protected

array $_customByName = array() (line 60)

List of custom row elements (Zend_Gdata_Spreadsheets_Extension_Custom), indexed by element name.

- access: protected

mixed $_entryClassName = 'Zend_Gdata_Spreadsheets_ListEntry' (line 46)

- access: protected

Redefinition of:

Zend_Gdata_Entry::$_entryClassName

#### Inherited Variables

Inherited from Zend_Gdata_App_MediaEntry

> Zend_Gdata_App_MediaEntry::$_mediaSource

Inherited from Zend_Gdata_App_Entry

> Zend_Gdata_App_Entry::$_content
> Zend_Gdata_App_Entry::$_control
> Zend_Gdata_App_Entry::$_edited
> Zend_Gdata_App_Entry::$_published
> Zend_Gdata_App_Entry::$_rootElement
> Zend_Gdata_App_Entry::$_source
> Zend_Gdata_App_Entry::$_summary

Inherited from Zend_Gdata_App_FeedEntryParent

> Zend_Gdata_App_FeedEntryParent::$_author
> Zend_Gdata_App_FeedEntryParent::$_category
> Zend_Gdata_App_FeedEntryParent::$_contributor
> Zend_Gdata_App_FeedEntryParent::$_etag
> Zend_Gdata_App_FeedEntryParent::$_id
> Zend_Gdata_App_FeedEntryParent::$_link
> Zend_Gdata_App_FeedEntryParent::$_majorProtocolVersion
> Zend_Gdata_App_FeedEntryParent::$_minorProtocolVersion
> Zend_Gdata_App_FeedEntryParent::$_rights
> Zend_Gdata_App_FeedEntryParent::$_service
> Zend_Gdata_App_FeedEntryParent::$_title
> Zend_Gdata_App_FeedEntryParent::$_updated

Inherited from Zend_Gdata_App_Base

> Zend_Gdata_App_Base::$_extensionAttributes
> Zend_Gdata_App_Base::$_extensionElements
> Zend_Gdata_App_Base::$_namespaceLookupCache
> Zend_Gdata_App_Base::$_namespaces
> Zend_Gdata_App_Base::$_rootNamespace
> Zend_Gdata_App_Base::$_rootNamespaceURI
> Zend_Gdata_App_Base::$_text

Methods
Constructor __construct (line 66)

Constructs a new Zend_Gdata_Spreadsheets_ListEntry object.

- access: public

Zend_Gdata_Spreadsheets_ListEntry __construct ([DOMElement $element = null])

- DOMElement $element: An existing XML element on which to base this new object.

Redefinition of:

Zend_Gdata_Entry::__construct()

addCustom (line 152)

Add an individual custom row element to this list entry.

- return: Provides a fluent interface.
- access: public

Zend_Gdata_Spreadsheets_ListEntry addCustom (Zend_Gdata_Spreadsheets_Extension_Custom $custom)

- Zend_Gdata_Spreadsheets_Extension_Custom $custom: The custom element to be added.

getCustom (line 101)

Gets the row elements contained by this list entry.

- return: The custom row elements in this list entry
- access: public

array getCustom ()
getCustomByName (line 117)

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

- return: 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.
- access: public

mixed getCustomByName ([string $name = null])

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

getDOM (line 72)

- access: public

void getDOM ([ $doc = null], [ $majorVersion = 1], [ $minorVersion = null])

- $doc
- $majorVersion
- $minorVersion

Redefinition of:

Zend_Gdata_Entry::getDOM()

removeCustom (line 166)

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

- return: Provides a fluent interface.
- throws: Zend_Gdata_App_InvalidArgumentException
- access: public

Zend_Gdata_Spreadsheets_ListEntry removeCustom (int $index)

- int $index: The index of the custom element to be deleted.

removeCustomByName (line 191)

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

- return: Provides a fluent interface.
- throws: Zend_Gdata_App_InvalidArgumentException
- access: public

Zend_Gdata_Spreadsheets_ListEntry removeCustomByName (string $name)

- string $name: The name of the custom element to be deleted.

setCustom (line 137)

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

- return: Provides a fluent interface.
- access: public

Zend_Gdata_Spreadsheets_ListEntry setCustom (array $custom)

- array $custom: The custom row elements to be contained in this list entry.

takeChildFromDOM (line 83)

- access: protected

void takeChildFromDOM ( $child)

- $child

Redefinition of:

Zend_Gdata_Entry::takeChildFromDOM()

#### Inherited Methods

Inherited From Zend_Gdata_Entry

> Zend_Gdata_Entry::__construct()
> Zend_Gdata_Entry::getDOM()
> Zend_Gdata_Entry::takeAttributeFromDOM()
> Zend_Gdata_Entry::takeChildFromDOM()

Inherited From Zend_Gdata_App_MediaEntry

> Zend_Gdata_App_MediaEntry::__construct()
> Zend_Gdata_App_MediaEntry::encode()
> Zend_Gdata_App_MediaEntry::getMediaSource()
> Zend_Gdata_App_MediaEntry::setMediaSource()

Inherited From Zend_Gdata_App_Entry

> Zend_Gdata_App_Entry::delete()
> Zend_Gdata_App_Entry::getContent()
> Zend_Gdata_App_Entry::getControl()
> Zend_Gdata_App_Entry::getDOM()
> Zend_Gdata_App_Entry::getPublished()
> Zend_Gdata_App_Entry::getSource()
> Zend_Gdata_App_Entry::getSummary()
> Zend_Gdata_App_Entry::reload()
> Zend_Gdata_App_Entry::save()
> Zend_Gdata_App_Entry::setContent()
> Zend_Gdata_App_Entry::setControl()
> Zend_Gdata_App_Entry::setPublished()
> Zend_Gdata_App_Entry::setSource()
> Zend_Gdata_App_Entry::setSummary()
> Zend_Gdata_App_Entry::takeChildFromDOM()

Inherited From Zend_Gdata_App_FeedEntryParent

> Zend_Gdata_App_FeedEntryParent::__construct()
> Zend_Gdata_App_FeedEntryParent::getAlternateLink()
> Zend_Gdata_App_FeedEntryParent::getAuthor()
> Zend_Gdata_App_FeedEntryParent::getCategory()
> Zend_Gdata_App_FeedEntryParent::getContributor()
> Zend_Gdata_App_FeedEntryParent::getDOM()
> Zend_Gdata_App_FeedEntryParent::getEditLink()
> Zend_Gdata_App_FeedEntryParent::getEtag()
> Zend_Gdata_App_FeedEntryParent::getHttpClient()
> Zend_Gdata_App_FeedEntryParent::getId()
> Zend_Gdata_App_FeedEntryParent::getLicenseLink()
> Zend_Gdata_App_FeedEntryParent::getLink()
> Zend_Gdata_App_FeedEntryParent::getMajorProtocolVersion()
> Zend_Gdata_App_FeedEntryParent::getMinorProtocolVersion()
> Zend_Gdata_App_FeedEntryParent::getNextLink()
> Zend_Gdata_App_FeedEntryParent::getPreviousLink()
> Zend_Gdata_App_FeedEntryParent::getRights()
> Zend_Gdata_App_FeedEntryParent::getSelfLink()
> Zend_Gdata_App_FeedEntryParent::getService()
> Zend_Gdata_App_FeedEntryParent::getTitle()
> Zend_Gdata_App_FeedEntryParent::getTitleValue()
> Zend_Gdata_App_FeedEntryParent::getUpdated()
> Zend_Gdata_App_FeedEntryParent::lookupNamespace()
> Zend_Gdata_App_FeedEntryParent::setAuthor()
> Zend_Gdata_App_FeedEntryParent::setCategory()
> Zend_Gdata_App_FeedEntryParent::setContributor()
> Zend_Gdata_App_FeedEntryParent::setEtag()
> Zend_Gdata_App_FeedEntryParent::setHttpClient()
> Zend_Gdata_App_FeedEntryParent::setId()
> Zend_Gdata_App_FeedEntryParent::setLink()
> Zend_Gdata_App_FeedEntryParent::setMajorProtocolVersion()
> Zend_Gdata_App_FeedEntryParent::setMinorProtocolVersion()
> Zend_Gdata_App_FeedEntryParent::setRights()
> Zend_Gdata_App_FeedEntryParent::setService()
> Zend_Gdata_App_FeedEntryParent::setTitle()
> Zend_Gdata_App_FeedEntryParent::setUpdated()
> Zend_Gdata_App_FeedEntryParent::takeChildFromDOM()

Inherited From Zend_Gdata_App_Base

> Zend_Gdata_App_Base::__construct()
> Zend_Gdata_App_Base::encode()
> Zend_Gdata_App_Base::flushNamespaceLookupCache()
> Zend_Gdata_App_Base::getDOM()
> Zend_Gdata_App_Base::getExtensionAttributes()
> Zend_Gdata_App_Base::getExtensionElements()
> Zend_Gdata_App_Base::getText()
> Zend_Gdata_App_Base::getXML()
> Zend_Gdata_App_Base::lookupNamespace()
> Zend_Gdata_App_Base::registerAllNamespaces()
> Zend_Gdata_App_Base::registerNamespace()
> Zend_Gdata_App_Base::saveXML()
> Zend_Gdata_App_Base::setExtensionAttributes()
> Zend_Gdata_App_Base::setExtensionElements()
> Zend_Gdata_App_Base::setText()
> Zend_Gdata_App_Base::takeAttributeFromDOM()
> Zend_Gdata_App_Base::takeChildFromDOM()
> Zend_Gdata_App_Base::transferFromDOM()
> Zend_Gdata_App_Base::transferFromXML()
> Zend_Gdata_App_Base::__get()
> Zend_Gdata_App_Base::__isset()
> Zend_Gdata_App_Base::__set()
> Zend_Gdata_App_Base::__toString()
> Zend_Gdata_App_Base::__unset()

Documentation generated on Tue, 26 Oct 2010 20:08:53 +0400 by phpDocumentor 1.4.2