Inheritance diagram for Zend_Gdata_YouTube_SubscriptionEntry:

Collaboration diagram for Zend_Gdata_YouTube_SubscriptionEntry:

Public Member Functions
	__construct ($element=null)
	getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
	setFeedLink ($feedLink=null)
	getFeedLink ($rel=null)
	getPlaylistId ()
	setPlaylistId ($id=null)
	getQueryString ()
	setQueryString ($queryString=null)
	getPlaylistTitle ()
	setPlaylistTitle ($title=null)
	getCountHint ()
	getMediaThumbnail ()
	getUsername ()
	setUsername ($username=null)
Protected Member Functions
	takeChildFromDOM ($child)
Protected Attributes
	$_entryClassName = 'Zend_Gdata_YouTube_SubscriptionEntry'
	$_feedLink = array()
	$_username = null
	$_playlistTitle = null
	$_playlistId = null
	$_mediaThumbnail = null
	$_countHint = null
	$_queryString = null

Detailed Description

Definition at line 78 of file SubscriptionEntry.php.

Constructor & Destructor Documentation

__construct ( $ element = null )

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

Parameters:

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

Reimplemented from Zend_Gdata_Entry.

Definition at line 145 of file SubscriptionEntry.php.

Here is the call graph for this function:

Member Function Documentation

getCountHint ( )

Get the counthint for a subscription.

Exceptions:

Zend_Gdata_App_VersionException

Returns:: Zend_Gdata_YouTube_Extension_CountHint

Definition at line 391 of file SubscriptionEntry.php.

Here is the call graph for this function:

getDOM	(	$	doc = `null`,
		$	majorVersion = `1`,
		$	minorVersion = `null`
	)

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:

DOMDocument $doc The DOMDocument used to construct DOMElements

Returns:: DOMElement The DOMElement representing this element and all child properties.

Reimplemented from Zend_Gdata_Entry.

Definition at line 161 of file SubscriptionEntry.php.

getFeedLink ( $ rel = null )

Get the feed link property for this entry.

See also:: setFeedLink

Parameters:

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

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

Definition at line 266 of file SubscriptionEntry.php.

getMediaThumbnail ( )

Get the thumbnail for a subscription.

Exceptions:

Zend_Gdata_App_VersionException

Returns:: Zend_Gdata_Media_Extension_MediaThumbnail

Definition at line 410 of file SubscriptionEntry.php.

Here is the call graph for this function:

getPlaylistId ( )

Get the playlist title for a 'playlist' subscription.

Exceptions:

Zend_Gdata_App_VersionException

Returns:: Zend_Gdata_YouTube_Extension_PlaylistId

Definition at line 286 of file SubscriptionEntry.php.

Here is the call graph for this function:

getPlaylistTitle ( )

Get the playlist title for a 'playlist' subscription.

Exceptions:

Zend_Gdata_App_VersionException

Returns:: Zend_Gdata_YouTube_Extension_PlaylistTitle

Definition at line 350 of file SubscriptionEntry.php.

Here is the call graph for this function:

getQueryString ( )

Get the queryString of the subscription

Returns:: Zend_Gdata_YouTube_Extension_QueryString

Definition at line 326 of file SubscriptionEntry.php.

getUsername ( )

Get the username for a channel subscription.

Returns:: Zend_Gdata_YouTube_Extension_Username

Definition at line 428 of file SubscriptionEntry.php.

setFeedLink ( $ feedLink = null )

Sets the array of embedded feeds related to the video

Parameters:

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

Returns:: Zend_Gdata_YouTube_SubscriptionEntry Provides a fluent interface

Definition at line 247 of file SubscriptionEntry.php.

setPlaylistId ( $ id = null )

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

Parameters:

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

Exceptions:

Zend_Gdata_App_VersionException

Returns:: Zend_Gdata_YouTube_SubscriptionEntry Provides a fluent interface

Definition at line 307 of file SubscriptionEntry.php.

Here is the call graph for this function:

setPlaylistTitle ( $ title = null )

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

Parameters:

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

Exceptions:

Zend_Gdata_App_VersionException

Returns:: Zend_Gdata_YouTube_SubscriptionEntry Provides a fluent interface

Definition at line 371 of file SubscriptionEntry.php.

Here is the call graph for this function:

setQueryString ( $ queryString = null )

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

Parameters:

Zend_Gdata_YouTube_Extension_QueryString $queryString The query string to subscribe to

Returns:: Zend_Gdata_YouTube_SubscriptionEntry Provides a fluent interface

Definition at line 338 of file SubscriptionEntry.php.

setUsername ( $ username = null )

Sets the username for a new channel subscription.

Parameters:

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

Returns:: Zend_Gdata_YouTube_SubscriptionEntry Provides a fluent interface

Definition at line 440 of file SubscriptionEntry.php.

takeChildFromDOM ( $ child ) [protected]

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

Parameters:

DOMNode $child The DOMNode to process

Reimplemented from Zend_Gdata_Entry.

Definition at line 196 of file SubscriptionEntry.php.

Here is the call graph for this function:

Field Documentation

$_countHint = null [protected]

Definition at line 129 of file SubscriptionEntry.php.

$_entryClassName = 'Zend_Gdata_YouTube_SubscriptionEntry' [protected]

Reimplemented from Zend_Gdata_Entry.

Definition at line 81 of file SubscriptionEntry.php.

$_feedLink = array() [protected]

Definition at line 88 of file SubscriptionEntry.php.

$_mediaThumbnail = null [protected]

Definition at line 122 of file SubscriptionEntry.php.

$_playlistId = null [protected]

Definition at line 113 of file SubscriptionEntry.php.

$_playlistTitle = null [protected]

Definition at line 104 of file SubscriptionEntry.php.

$_queryString = null [protected]

Definition at line 136 of file SubscriptionEntry.php.

$_username = null [protected]

Definition at line 95 of file SubscriptionEntry.php.

The documentation for this class was generated from the following file:

C:/xampp/htdocs/moodle/lib/zend/Zend/Gdata/YouTube/SubscriptionEntry.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation