Moodle  2.2.1
http://www.collinsharper.com
Zend_Gdata_YouTube_PlaylistListEntry Class Reference
Inheritance diagram for Zend_Gdata_YouTube_PlaylistListEntry:
Collaboration diagram for Zend_Gdata_YouTube_PlaylistListEntry:

Public Member Functions

 __construct ($element=null)
 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 setDescription ($description=null)
 getDescription ()
 getCountHint ()
 getPlaylistId ()
 setFeedLink ($feedLink=null)
 getFeedLink ($rel=null)
 getPlaylistVideoFeedUrl ()

Protected Member Functions

 takeChildFromDOM ($child)

Protected Attributes

 $_entryClassName = 'Zend_Gdata_YouTube_PlaylistListEntry'
 $_feedLink = array()
 $_description = null
 $_playlistId = null
 $_countHint = null

Detailed Description

Definition at line 63 of file PlaylistListEntry.php.


Constructor & Destructor Documentation

__construct ( element = null)

Creates a Playlist list entry, representing an individual playlist in a list of playlists, 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 104 of file PlaylistListEntry.php.

Here is the call graph for this function:


Member Function Documentation

Returns the countHint relating to the playlist.

The countHint is the number of videos on a playlist.

Exceptions:
Zend_Gdata_App_VersionException
Returns:
Zend_Gdata_YouTube_Extension_CountHint The count of videos on a playlist.

Definition at line 217 of file PlaylistListEntry.php.

Here is the call graph for this function:

Returns the description relating to the video.

Returns:
Zend_Gdata_YouTube_Extension_Description The description relating to the video

Definition at line 199 of file PlaylistListEntry.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$docThe DOMDocument used to construct DOMElements
Returns:
DOMElement The DOMElement representing this element and all child properties.

Reimplemented from Zend_Gdata_Entry.

Definition at line 120 of file PlaylistListEntry.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 272 of file PlaylistListEntry.php.

Here is the caller graph for this function:

Returns the Id relating to the playlist.

Exceptions:
Zend_Gdata_App_VersionException
Returns:
Zend_Gdata_YouTube_Extension_PlaylistId The id of this playlist.

Definition at line 235 of file PlaylistListEntry.php.

Here is the call graph for this function:

Returns the URL of the playlist video feed

Returns:
string The URL of the playlist video feed

Definition at line 291 of file PlaylistListEntry.php.

Here is the call graph for this function:

setDescription ( description = null)

Sets the description relating to the playlist.

Deprecated:
Deprecated as of version 2 of the YouTube API.
Parameters:
Zend_Gdata_YouTube_Extension_Description$descriptionThe description relating to the video
Returns:
Zend_Gdata_YouTube_PlaylistListEntry Provides a fluent interface

Definition at line 183 of file PlaylistListEntry.php.

Here is the call graph for this function:

setFeedLink ( feedLink = null)

Sets the array of embedded feeds related to the playlist

Parameters:
array$feedLinkThe array of embedded feeds relating to the video
Returns:
Zend_Gdata_YouTube_PlaylistListEntry Provides a fluent interface

Definition at line 253 of file PlaylistListEntry.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$childThe DOMNode to process

Reimplemented from Zend_Gdata_Entry.

Definition at line 146 of file PlaylistListEntry.php.

Here is the call graph for this function:


Field Documentation

$_countHint = null [protected]

Definition at line 95 of file PlaylistListEntry.php.

$_description = null [protected]

Definition at line 81 of file PlaylistListEntry.php.

$_entryClassName = 'Zend_Gdata_YouTube_PlaylistListEntry' [protected]

Reimplemented from Zend_Gdata_Entry.

Definition at line 66 of file PlaylistListEntry.php.

$_feedLink = array() [protected]

Definition at line 73 of file PlaylistListEntry.php.

$_playlistId = null [protected]

Definition at line 88 of file PlaylistListEntry.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations