## Zend_Gdata_YouTube_SubscriptionEntry

Description

Represents the YouTube video subscription 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/SubscriptionEntry.php (line 78)

    Zend_Gdata_App_Base
       |
       --Zend_Gdata_App_FeedEntryParent
          |
          --Zend_Gdata_App_Entry
             |
             --Zend_Gdata_App_MediaEntry
                |
                --Zend_Gdata_Entry
                   |
                   --Zend_Gdata_YouTube_SubscriptionEntry

Variable Summary
Zend_Gdata_YouTube_Extension_CountHint $_countHint
mixed $_entryClassName
array $_feedLink
Zend_Gdata_Media_Extension_MediaThumbnail $_mediaThumbnail
Zend_Gdata_YouTube_Extension_PlaylistId $_playlistId
Zend_Gdata_YouTube_Extension_PlaylistTitle $_playlistTitle
Zend_Gdata_YouTube_Extension_QueryString $_queryString
Zend_Gdata_YouTube_Extension_Username $_username
Method Summary
Zend_Gdata_YouTube_SubscriptionEntry __construct ([DOMElement $element = null])
Zend_Gdata_YouTube_Extension_CountHint getCountHint ()
DOMElement getDOM ([DOMDocument $doc = null], [ $majorVersion = 1], [ $minorVersion = null])
mixed getFeedLink ([string $rel = null])
Zend_Gdata_Media_Extension_MediaThumbnail getMediaThumbnail ()
Zend_Gdata_YouTube_Extension_PlaylistId getPlaylistId ()
Zend_Gdata_YouTube_Extension_PlaylistTitle getPlaylistTitle ()
Zend_Gdata_YouTube_Extension_QueryString getQueryString ()
Zend_Gdata_YouTube_Extension_Username getUsername ()
Zend_Gdata_YouTube_SubscriptionEntry setFeedLink ([array $feedLink = null])
Zend_Gdata_YouTube_SubscriptionEntry setPlaylistId ([Zend_Gdata_YouTube_Extension_PlaylistId $id = null])
Zend_Gdata_YouTube_SubscriptionEntry setPlaylistTitle ([Zend_Gdata_YouTube_Extension_PlaylistTitle $title = null])
Zend_Gdata_YouTube_SubscriptionEntry setQueryString ([Zend_Gdata_YouTube_Extension_QueryString $queryString = null])
Zend_Gdata_YouTube_SubscriptionEntry setUsername ([Zend_Gdata_YouTube_Extension_Username $username = null])
void takeChildFromDOM (DOMNode $child)
Variables
Zend_Gdata_YouTube_Extension_CountHint $_countHint = null (line 129)

The countHint for this entry.

- access: protected

mixed $_entryClassName = 'Zend_Gdata_YouTube_SubscriptionEntry' (line 81)

- access: protected

Redefinition of:

Zend_Gdata_Entry::$_entryClassName

array $_feedLink = array() (line 88)

Nested feed links

- access: protected

Zend_Gdata_Media_Extension_MediaThumbnail $_mediaThumbnail = null (line 122)

The media:thumbnail element for this entry.

This element is only used on subscriptions to playlists.

- access: protected

Zend_Gdata_YouTube_Extension_PlaylistId $_playlistId = null (line 113)

The playlist id for this entry.

This element is only used on subscriptions to playlists.

- access: protected

Zend_Gdata_YouTube_Extension_PlaylistTitle $_playlistTitle = null (line 104)

The playlist title for this entry.

This element is only used on subscriptions to playlists.

- access: protected

Zend_Gdata_YouTube_Extension_QueryString $_queryString = null (line 136)

The queryString for this entry.

- access: protected

Zend_Gdata_YouTube_Extension_Username $_username = null (line 95)

The username of this entry.

- 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 145)

Creates a subscription entry, representing an individual subscription in a list of subscriptions, usually associated with an individual user.

- access: public

Zend_Gdata_YouTube_SubscriptionEntry __construct ([DOMElement $element = null])

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

Redefinition of:

Zend_Gdata_Entry::__construct()

getCountHint (line 391)

Get the counthint for a subscription.

- throws: Zend_Gdata_App_VersionException
- access: public

Zend_Gdata_YouTube_Extension_CountHint getCountHint ()
getDOM (line 161)

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 266)

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

getMediaThumbnail (line 410)

Get the thumbnail for a subscription.

- throws: Zend_Gdata_App_VersionException
- access: public

Zend_Gdata_Media_Extension_MediaThumbnail getMediaThumbnail ()
getPlaylistId (line 286)

Get the playlist title for a 'playlist' subscription.

- throws: Zend_Gdata_App_VersionException
- access: public

Zend_Gdata_YouTube_Extension_PlaylistId getPlaylistId ()
getPlaylistTitle (line 350)

Get the playlist title for a 'playlist' subscription.

- throws: Zend_Gdata_App_VersionException
- access: public

Zend_Gdata_YouTube_Extension_PlaylistTitle getPlaylistTitle ()
getQueryString (line 326)

Get the queryString of the subscription

- access: public

Zend_Gdata_YouTube_Extension_QueryString getQueryString ()
getUsername (line 428)

Get the username for a channel subscription.

- access: public

Zend_Gdata_YouTube_Extension_Username getUsername ()
setFeedLink (line 247)

Sets the array of embedded feeds related to the video

- return: Provides a fluent interface
- access: public

Zend_Gdata_YouTube_SubscriptionEntry setFeedLink ([array $feedLink = null])

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

setPlaylistId (line 307)

Sets the yt:playlistId element for a new playlist subscription.

- return: Provides a fluent interface
- throws: Zend_Gdata_App_VersionException
- access: public

Zend_Gdata_YouTube_SubscriptionEntry setPlaylistId ([Zend_Gdata_YouTube_Extension_PlaylistId $id = null])

- Zend_Gdata_YouTube_Extension_PlaylistId $id: The id of the playlist to which to subscribe to.

setPlaylistTitle (line 371)

Sets the yt:playlistTitle element for a new playlist subscription.

- return: Provides a fluent interface
- throws: Zend_Gdata_App_VersionException
- access: public

Zend_Gdata_YouTube_SubscriptionEntry setPlaylistTitle ([Zend_Gdata_YouTube_Extension_PlaylistTitle $title = null])

- Zend_Gdata_YouTube_Extension_PlaylistTitle $title: The title of the playlist to which to subscribe to.

setQueryString (line 338)

Sets the yt:queryString element for a new keyword subscription.

- return: Provides a fluent interface
- access: public

Zend_Gdata_YouTube_SubscriptionEntry setQueryString ([Zend_Gdata_YouTube_Extension_QueryString $queryString = null])

- Zend_Gdata_YouTube_Extension_QueryString $queryString: The query string to subscribe to

setUsername (line 440)

Sets the username for a new channel subscription.

- return: Provides a fluent interface
- access: public

Zend_Gdata_YouTube_SubscriptionEntry setUsername ([Zend_Gdata_YouTube_Extension_Username $username = null])

- Zend_Gdata_YouTube_Extension_Username $username: The username of the channel to which to subscribe to.

takeChildFromDOM (line 196)

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