Gdata/YouTube/SubscriptionEntry.php

Show: PublicProtectedPrivateinherited
Table of Contents
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.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Gdata  
Subpackage
YouTube  
Version
$Id$  

\Zend_Gdata_YouTube_SubscriptionEntry
jump to top

Package: Zend_Gdata\YouTube
Represents the YouTube video subscription flavor of an Atom entry
Parent(s)
\Zend_Gdata_Entry < \Zend_Gdata_App_MediaEntry < \Zend_Gdata_App_Entry < \Zend_Gdata_App_FeedEntryParent < \Zend_Gdata_App_Base
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotected\Zend_Gdata_YouTube_Extension_CountHint $_countHint = null
The countHint for this entry.
Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_CountHint
>VPropertyprotected$_entryClassName = 'Zend_Gdata_YouTube_SubscriptionEntry'
Default value'Zend_Gdata_YouTube_SubscriptionEntry'Details
Type
n/a
>VPropertyprotectedarray $_feedLink = array()
Nested feed links
Default valuearray()Details
Type
array
>VPropertyprotected\Zend_Gdata_Media_Extension_MediaThumbnail $_mediaThumbnail = null
The media:thumbnail element for this entry.
This element is only used on subscriptions to playlists.
Default valuenullDetails
Type
\Zend_Gdata_Media_Extension_MediaThumbnail
>VPropertyprotected\Zend_Gdata_YouTube_Extension_PlaylistId $_playlistId = null
The playlist id for this entry.
This element is only used on subscriptions to playlists.
Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_PlaylistId
>VPropertyprotected\Zend_Gdata_YouTube_Extension_PlaylistTitle $_playlistTitle = null
The playlist title for this entry.
This element is only used on subscriptions to playlists.
Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_PlaylistTitle
>VPropertyprotected\Zend_Gdata_YouTube_Extension_QueryString $_queryString = null
The queryString for this entry.
Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_QueryString
>VPropertyprotected\Zend_Gdata_YouTube_Extension_Username $_username = null
The username of this entry.
Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_Username

Methods

methodpublic__construct(\DOMElement $element = null) : void

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

Parameters
NameTypeDescription
$element\DOMElement

(optional) DOMElement from which this

     object should be constructed.
methodpublicgetCountHint() : \Zend_Gdata_YouTube_Extension_CountHint

Get the counthint for a subscription.

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_CountHint
Throws
ExceptionDescription
\Zend_Gdata_App_VersionException
methodpublicgetDOM(\DOMDocument $doc = null,  $majorVersion = 1,  $minorVersion = null) : \DOMElement

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
NameTypeDescription
$doc\DOMDocument

The DOMDocument used to construct DOMElements

$majorVersion
$minorVersion
Returns
TypeDescription
\DOMElementThe DOMElement representing this element and all child properties.
methodpublicgetFeedLink(string $rel = null) : mixed

Get the feed link property for this entry.

Parameters
NameTypeDescription
$relstring

(optional) The rel value of the link to be found.

     If null, the array of links is returned.
Returns
TypeDescription
mixedIf $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.
Details
See
 
methodpublicgetMediaThumbnail() : \Zend_Gdata_Media_Extension_MediaThumbnail

Get the thumbnail for a subscription.

Returns
TypeDescription
\Zend_Gdata_Media_Extension_MediaThumbnail
Throws
ExceptionDescription
\Zend_Gdata_App_VersionException
methodpublicgetPlaylistId() : \Zend_Gdata_YouTube_Extension_PlaylistId

Get the playlist title for a 'playlist' subscription.

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_PlaylistId
Throws
ExceptionDescription
\Zend_Gdata_App_VersionException
methodpublicgetPlaylistTitle() : \Zend_Gdata_YouTube_Extension_PlaylistTitle

Get the playlist title for a 'playlist' subscription.

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_PlaylistTitle
Throws
ExceptionDescription
\Zend_Gdata_App_VersionException
methodpublicgetQueryString() : \Zend_Gdata_YouTube_Extension_QueryString

Get the queryString of the subscription

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_QueryString
methodpublicgetUsername() : \Zend_Gdata_YouTube_Extension_Username

Get the username for a channel subscription.

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_Username
methodpublicsetFeedLink(array $feedLink = null) : \Zend_Gdata_YouTube_SubscriptionEntry

Sets the array of embedded feeds related to the video

Parameters
NameTypeDescription
$feedLinkarray

The array of embedded feeds relating to the video

Returns
TypeDescription
\Zend_Gdata_YouTube_SubscriptionEntryProvides a fluent interface
methodpublicsetPlaylistId(\Zend_Gdata_YouTube_Extension_PlaylistId $id = null) : \Zend_Gdata_YouTube_SubscriptionEntry

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

Parameters
NameTypeDescription
$id\Zend_Gdata_YouTube_Extension_PlaylistId

The id of the playlist to which to subscribe to.

Returns
TypeDescription
\Zend_Gdata_YouTube_SubscriptionEntryProvides a fluent interface
Throws
ExceptionDescription
\Zend_Gdata_App_VersionException
methodpublicsetPlaylistTitle(\Zend_Gdata_YouTube_Extension_PlaylistTitle $title = null) : \Zend_Gdata_YouTube_SubscriptionEntry

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

Parameters
NameTypeDescription
$title\Zend_Gdata_YouTube_Extension_PlaylistTitle

The title of the playlist to which to subscribe to.

Returns
TypeDescription
\Zend_Gdata_YouTube_SubscriptionEntryProvides a fluent interface
Throws
ExceptionDescription
\Zend_Gdata_App_VersionException
methodpublicsetQueryString(\Zend_Gdata_YouTube_Extension_QueryString $queryString = null) : \Zend_Gdata_YouTube_SubscriptionEntry

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

Parameters
NameTypeDescription
$queryString\Zend_Gdata_YouTube_Extension_QueryString

The query string to subscribe to

Returns
TypeDescription
\Zend_Gdata_YouTube_SubscriptionEntryProvides a fluent interface
methodpublicsetUsername(\Zend_Gdata_YouTube_Extension_Username $username = null) : \Zend_Gdata_YouTube_SubscriptionEntry

Sets the username for a new channel subscription.

Parameters
NameTypeDescription
$username\Zend_Gdata_YouTube_Extension_Username

The username of the channel to which to subscribe to.

Returns
TypeDescription
\Zend_Gdata_YouTube_SubscriptionEntryProvides a fluent interface
methodprotectedtakeChildFromDOM(\DOMNode $child) : void

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

Parameters
NameTypeDescription
$child\DOMNode

The DOMNode to process

Documentation was generated by phpDocumentor 2.2.0 .