API Documentation

Zend/Gdata/YouTube/PlaylistListEntry.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: PlaylistListEntry.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Gdata_YouTube_PlaylistListEntry

Package: Zend\Gdata\YouTube

Represents the YouTube video playlist 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'

CountHint for this playlist.

Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_CountHint
Propertyprotected\Zend_Gdata_YouTube_Extension_Description  $_description= 'null'

Description of this playlist

Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_Description
Deprecated
Deprecated as of version 2 of the YouTube API.  
Propertyprotected  $_entryClassName= ''Zend_Gdata_YouTube_PlaylistListEntry''
Default value'Zend_Gdata_YouTube_PlaylistListEntry'Details
Type
Propertyprotectedarray  $_feedLink= 'array()'

Nested feed links

Default valuearray()Details
Type
array
Propertyprotected\Zend_Gdata_YouTube_Extension_PlaylistId  $_playlistId= 'null'

Id of this playlist

Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_PlaylistId

Methods

methodpublic__construct( \DOMElement $element = null ) : void

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

Returns the countHint relating to the playlist.

The countHint is the number of videos on a playlist.

Returns
Type Description
\Zend_Gdata_YouTube_Extension_CountHint The count of videos on a playlist.
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.
methodpublicgetDescription( ) : \Zend_Gdata_YouTube_Extension_Description

Returns the description relating to the video.

Returns
Type Description
\Zend_Gdata_YouTube_Extension_Description The description relating to the video
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  
methodpublicgetPlaylistId( ) : \Zend_Gdata_YouTube_Extension_PlaylistId

Returns the Id relating to the playlist.

Returns
Type Description
\Zend_Gdata_YouTube_Extension_PlaylistId The id of this playlist.
Throws
Exception Description
\Zend_Gdata_App_VersionException
methodpublicgetPlaylistVideoFeedUrl( ) : string

Returns the URL of the playlist video feed

Returns
Type Description
string The URL of the playlist video feed
methodpublicsetDescription( \Zend_Gdata_YouTube_Extension_Description $description = null ) : \Zend_Gdata_YouTube_PlaylistListEntry

Sets the description relating to the playlist.

Parameters
Name Type Description
$description \Zend_Gdata_YouTube_Extension_Description

The description relating to the video

Returns
Type Description
\Zend_Gdata_YouTube_PlaylistListEntry Provides a fluent interface
Details
Deprecated
Deprecated as of version 2 of the YouTube API.  
methodpublicsetFeedLink( array $feedLink = null ) : \Zend_Gdata_YouTube_PlaylistListEntry

Sets the array of embedded feeds related to the playlist

Parameters
Name Type Description
$feedLink array

The array of embedded feeds relating to the video

Returns
Type Description
\Zend_Gdata_YouTube_PlaylistListEntry 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.