API Documentation

Zend/Gdata/YouTube/SubscriptionEntry.php

Show: inherited
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Gdata  
Subpackage
YouTube  
Version
$Id: SubscriptionEntry.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Gdata_YouTube_SubscriptionEntry

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotected\Zend_Gdata_YouTube_Extension_CountHint  $_countHint= 'null'

The countHint for this entry.

Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_CountHint
Propertyprotected  $_entryClassName= ''Zend_Gdata_YouTube_SubscriptionEntry''
Default value'Zend_Gdata_YouTube_SubscriptionEntry'Details
Type
Propertyprotectedarray  $_feedLink= 'array()'

Nested feed links

Default valuearray()Details
Type
array
Propertyprotected\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
Propertyprotected\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
Propertyprotected\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
Propertyprotected\Zend_Gdata_YouTube_Extension_QueryString  $_queryString= 'null'

The queryString for this entry.

Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_QueryString
Propertyprotected\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
Name Type Description
$element \DOMElement

(optional) DOMElement from which this object should be constructed.

methodpublicgetCountHint( ) : \Zend_Gdata_YouTube_Extension_CountHint

Get the counthint for a subscription.

Returns
Type Description
\Zend_Gdata_YouTube_Extension_CountHint
Throws
Exception Description
\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
Name Type Description
$doc \DOMDocument

The DOMDocument used to construct DOMElements

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

Get the feed link property for this entry.

Parameters
Name Type Description
$rel string

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

Returns
Type Description
mixed 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.
Details
See
\setFeedLink  
methodpublicgetMediaThumbnail( ) : \Zend_Gdata_Media_Extension_MediaThumbnail

Get the thumbnail for a subscription.

Returns
Type Description
\Zend_Gdata_Media_Extension_MediaThumbnail
Throws
Exception Description
\Zend_Gdata_App_VersionException
methodpublicgetPlaylistId( ) : \Zend_Gdata_YouTube_Extension_PlaylistId

Get the playlist title for a 'playlist' subscription.

Returns
Type Description
\Zend_Gdata_YouTube_Extension_PlaylistId
Throws
Exception Description
\Zend_Gdata_App_VersionException
methodpublicgetPlaylistTitle( ) : \Zend_Gdata_YouTube_Extension_PlaylistTitle

Get the playlist title for a 'playlist' subscription.

Returns
Type Description
\Zend_Gdata_YouTube_Extension_PlaylistTitle
Throws
Exception Description
\Zend_Gdata_App_VersionException
methodpublicgetQueryString( ) : \Zend_Gdata_YouTube_Extension_QueryString

Get the queryString of the subscription

methodpublicgetUsername( ) : \Zend_Gdata_YouTube_Extension_Username

Get the username for a channel subscription.

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

Sets the array of embedded feeds related to the video

Parameters
Name Type Description
$feedLink array

The array of embedded feeds relating to the video

Returns
Type Description
\Zend_Gdata_YouTube_SubscriptionEntry Provides 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
Name Type Description
$id \Zend_Gdata_YouTube_Extension_PlaylistId

The id of the playlist to which to subscribe to.

Returns
Type Description
\Zend_Gdata_YouTube_SubscriptionEntry Provides a fluent interface
Throws
Exception Description
\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
Name Type Description
$title \Zend_Gdata_YouTube_Extension_PlaylistTitle

The title of the playlist to which to subscribe to.

Returns
Type Description
\Zend_Gdata_YouTube_SubscriptionEntry Provides a fluent interface
Throws
Exception Description
\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
Name Type Description
$queryString \Zend_Gdata_YouTube_Extension_QueryString

The query string to subscribe to

Returns
Type Description
\Zend_Gdata_YouTube_SubscriptionEntry Provides a fluent interface
methodpublicsetUsername( \Zend_Gdata_YouTube_Extension_Username $username = null ) : \Zend_Gdata_YouTube_SubscriptionEntry

Sets the username for a new channel subscription.

Parameters
Name Type Description
$username \Zend_Gdata_YouTube_Extension_Username

The username of the channel to which to subscribe to.

Returns
Type Description
\Zend_Gdata_YouTube_SubscriptionEntry Provides 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
Name Type Description
$child \DOMNode

The DOMNode to process

Documentation was generated by DocBlox 0.15.1.