API Documentation

Gdata/YouTube/PlaylistListEntry.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
YouTube
version
$Id: PlaylistListEntry.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Gdata_YouTube_PlaylistListEntry

Description

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.

Zend_Gdata_YouTube_PlaylistListEntry

Extends from
Zend_Gdata_Entry
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Gdata
subpackage
YouTube
Properties
$_entryClassName
$_feedLink
$_description
$_playlistId
$_countHint
Methods
__construct
getDOM
takeChildFromDOM
setDescription
getDescription
getCountHint
getPlaylistId
setFeedLink
getFeedLink
getPlaylistVideoFeedUrl

Description

Represents the YouTube video playlist flavor of an Atom entry

Properties

$_countHint

Zend_Gdata_YouTube_Extension_CountHint $_countHint = 'null'

CountHint for this playlist.

Details

$_countHint
Zend_Gdata_YouTube_Extension_CountHint
visibility
protected
default
null
final
false
static
false

$_description

Zend_Gdata_YouTube_Extension_Description $_description = 'null'

Description of this playlist

Details

$_description
Zend_Gdata_YouTube_Extension_Description
visibility
protected
default
null
final
false
static
false
deprecated
Deprecated as of version 2 of the YouTube API.

$_entryClassName

 $_entryClassName = 'Zend_Gdata_YouTube_PlaylistListEntry'

Details

visibility
protected
default
Zend_Gdata_YouTube_PlaylistListEntry
final
false
static
false

$_feedLink

array $_feedLink = 'array'

Nested feed links

Details

$_feedLink
array
visibility
protected
default
array
final
false
static
false

$_playlistId

Zend_Gdata_YouTube_Extension_PlaylistId $_playlistId = 'null'

Id of this playlist

Details

$_playlistId
Zend_Gdata_YouTube_Extension_PlaylistId
visibility
protected
default
null
final
false
static
false

Methods

__construct

__construct( DOMElement $element = null ) :

Creates a Playlist list entry, representing an individual playlist in a list of playlists, usually associated with an individual user.

Arguments
$element
DOMElement
(optional) DOMElement from which this object should be constructed.
Details
visibility
public
final
false
static
false

getCountHint

getCountHint( ) : Zend_Gdata_YouTube_Extension_CountHint

Returns the countHint relating to the playlist.

The countHint is the number of videos on a playlist.

Output
Zend_Gdata_YouTube_Extension_CountHint
The count of videos on a playlist.
Details
visibility
public
final
false
static
false
throws

getDOM

getDOM( 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.

Arguments
$doc
DOMDocument
The DOMDocument used to construct DOMElements
$majorVersion
$minorVersion
Output
DOMElement
The DOMElement representing this element and all child properties.
Details
visibility
public
final
false
static
false

getDescription

getDescription( ) : Zend_Gdata_YouTube_Extension_Description

Returns the description relating to the video.

Output
Zend_Gdata_YouTube_Extension_Description
The description relating to the video
Details
visibility
public
final
false
static
false

getFeedLink

getFeedLink( string $rel = null ) : mixed

Get the feed link property for this entry.

Arguments
$rel
string
(optional) The rel value of the link to be found. If null, the array of links is returned.
Output
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
visibility
public
final
false
static
false
see
setFeedLink

getPlaylistId

getPlaylistId( ) : Zend_Gdata_YouTube_Extension_PlaylistId

Returns the Id relating to the playlist.

Output
Zend_Gdata_YouTube_Extension_PlaylistId
The id of this playlist.
Details
visibility
public
final
false
static
false
throws

getPlaylistVideoFeedUrl

getPlaylistVideoFeedUrl( ) : string

Returns the URL of the playlist video feed

Output
string
The URL of the playlist video feed
Details
visibility
public
final
false
static
false

setDescription

setDescription( Zend_Gdata_YouTube_Extension_Description $description = null ) : Zend_Gdata_YouTube_PlaylistListEntry

Sets the description relating to the playlist.

Arguments
$description
Zend_Gdata_YouTube_Extension_Description
The description relating to the video
Output
Zend_Gdata_YouTube_PlaylistListEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false
deprecated
Deprecated as of version 2 of the YouTube API.

setFeedLink

setFeedLink( array $feedLink = null ) : Zend_Gdata_YouTube_PlaylistListEntry

Sets the array of embedded feeds related to the playlist

Arguments
$feedLink
array
The array of embedded feeds relating to the video
Output
Zend_Gdata_YouTube_PlaylistListEntry
Provides a fluent interface
Details
visibility
public
final
false
static
false

takeChildFromDOM

takeChildFromDOM( DOMNode $child ) :

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

Arguments
$child
DOMNode
The DOMNode to process
Details
visibility
protected
final
false
static
false
Documentation was generated by DocBlox.