## Zend_Gdata_YouTube_PlaylistListEntry

Description

Represents the YouTube video playlist flavor of an Atom entry

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

Located in /Gdata/YouTube/PlaylistListEntry.php (line 63)

    Zend_Gdata_App_Base
       |
       --Zend_Gdata_App_FeedEntryParent
          |
          --Zend_Gdata_App_Entry
             |
             --Zend_Gdata_App_MediaEntry
                |
                --Zend_Gdata_Entry
                   |
                   --Zend_Gdata_YouTube_PlaylistListEntry

Variable Summary
Zend_Gdata_YouTube_Extension_CountHint $_countHint
Zend_Gdata_YouTube_Extension_Description $_description
mixed $_entryClassName
array $_feedLink
Zend_Gdata_YouTube_Extension_PlaylistId $_playlistId
Method Summary
Zend_Gdata_YouTube_PlaylistListEntry __construct ([DOMElement $element = null])
Zend_Gdata_YouTube_Extension_CountHint getCountHint ()
Zend_Gdata_YouTube_Extension_Description getDescription ()
DOMElement getDOM ([DOMDocument $doc = null], [ $majorVersion = 1], [ $minorVersion = null])
mixed getFeedLink ([string $rel = null])
Zend_Gdata_YouTube_Extension_PlaylistId getPlaylistId ()
string getPlaylistVideoFeedUrl ()
Zend_Gdata_YouTube_PlaylistListEntry setDescription ([Zend_Gdata_YouTube_Extension_Description $description = null])
Zend_Gdata_YouTube_PlaylistListEntry setFeedLink ([array $feedLink = null])
void takeChildFromDOM (DOMNode $child)
Variables
Zend_Gdata_YouTube_Extension_CountHint $_countHint = null (line 95)

CountHint for this playlist.

- access: protected

Zend_Gdata_YouTube_Extension_Description $_description = null (line 81)

Description of this playlist

- deprecated: Deprecated as of version 2 of the YouTube API.
- access: protected

mixed $_entryClassName = 'Zend_Gdata_YouTube_PlaylistListEntry' (line 66)

- access: protected

Redefinition of:

Zend_Gdata_Entry::$_entryClassName

array $_feedLink = array() (line 73)

Nested feed links

- access: protected

Zend_Gdata_YouTube_Extension_PlaylistId $_playlistId = null (line 88)

Id of this playlist

- access: protected

#### 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 104)

Creates a Playlist list entry, representing an individual playlist in a list of playlists, usually associated with an individual user.

- access: public

Zend_Gdata_YouTube_PlaylistListEntry __construct ([DOMElement $element = null])

- DOMElement $element: (optional) DOMElement from which this object should be constructed.

Redefinition of:

Zend_Gdata_Entry::__construct()

getCountHint (line 217)

Returns the countHint relating to the playlist.

The countHint is the number of videos on a playlist.

- return: The count of videos on a playlist.
- throws: Zend_Gdata_App_VersionException
- access: public

Zend_Gdata_YouTube_Extension_CountHint getCountHint ()
getDescription (line 199)

Returns the description relating to the video.

- return: The description relating to the video
- access: public

Zend_Gdata_YouTube_Extension_Description getDescription ()
getDOM (line 120)

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.

- return: The DOMElement representing this element and all child properties.
- access: public

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

- DOMDocument $doc: The DOMDocument used to construct DOMElements
- $majorVersion
- $minorVersion

Redefinition of:

Zend_Gdata_Entry::getDOM()

getFeedLink (line 272)

Get the feed link property for this entry.

- return: If $rel is specified, a Zend_Gdata_Extension_FeedLink object corresponding to the requested rel value is returned if found, or null if the requested value is not found. If $rel is null or not specified, an array of all available feed links for this entry is returned, or null if no feed links are set.
- see: Zend_Gdata_YouTube_PlaylistListEntry::setFeedLink()
- access: public

mixed getFeedLink ([string $rel = null])

- string $rel: (optional) The rel value of the link to be found. If null, the array of links is returned.

getPlaylistId (line 235)

Returns the Id relating to the playlist.

- return: The id of this playlist.
- throws: Zend_Gdata_App_VersionException
- access: public

Zend_Gdata_YouTube_Extension_PlaylistId getPlaylistId ()
getPlaylistVideoFeedUrl (line 291)

Returns the URL of the playlist video feed

- return: The URL of the playlist video feed
- access: public

string getPlaylistVideoFeedUrl ()
setDescription (line 183)

Sets the description relating to the playlist.

- return: Provides a fluent interface
- deprecated: Deprecated as of version 2 of the YouTube API.
- access: public

Zend_Gdata_YouTube_PlaylistListEntry setDescription ([Zend_Gdata_YouTube_Extension_Description $description = null])

- Zend_Gdata_YouTube_Extension_Description $description: The description relating to the video

setFeedLink (line 253)

Sets the array of embedded feeds related to the playlist

- return: Provides a fluent interface
- access: public

Zend_Gdata_YouTube_PlaylistListEntry setFeedLink ([array $feedLink = null])

- array $feedLink: The array of embedded feeds relating to the video

takeChildFromDOM (line 146)

Creates individual Entry objects of the appropriate type and stores them in the $_entry array based upon DOM data.

- access: protected

void takeChildFromDOM (DOMNode $child)

- DOMNode $child: The DOMNode to process

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:09:05 +0400 by phpDocumentor 1.4.2