Gdata/YouTube/PlaylistVideoEntry.php

Show: PublicProtectedPrivateinherited
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: PlaylistVideoEntry.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Gdata_YouTube_PlaylistVideoEntry

Package: Zend\Gdata\YouTube
Represents the YouTube video playlist flavor of an Atom entry
Parent(s)
\Zend_Gdata_YouTube_VideoEntry < \Zend_Gdata_YouTube_MediaEntry < \Zend_Gdata_Media_Entry < \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  

Constants

>VConstant  YOUTUBE_DEVELOPER_TAGS_SCHEMA = 'http://gdata.youtube.com/schemas/2007/developertags.cat'
>VConstant  YOUTUBE_CATEGORY_SCHEMA = 'http://gdata.youtube.com/schemas/2007/categories.cat'

Properties

>VPropertyprotected\Zend_Gdata_Extensions_Comments $_comments = null
inherited
Specifies the comments associated with a video.
Inherited from: \Zend_Gdata_YouTube_VideoEntry::$$_comments
Default valuenullDetails
Type
\Zend_Gdata_Extensions_Comments
Inherited_from
\Zend_Gdata_YouTube_VideoEntry::$$_comments  
>VPropertyprotectedstring $_entryClassName = 'Zend_Gdata_YouTube_PlaylistVideoEntry'
Class name for each entry in this feed*
Default value'Zend_Gdata_YouTube_PlaylistVideoEntry'Details
Type
string
>VPropertyprotectedarray $_feedLink = array()
inherited
Nested feed links
Inherited from: \Zend_Gdata_YouTube_VideoEntry::$$_feedLink
Default valuearray()Details
Type
array
Inherited_from
\Zend_Gdata_YouTube_VideoEntry::$$_feedLink  
>VPropertyprotected\Zend_Gdata_YouTube_Extension_Location|null $_location = null
inherited
Location informtion for the video
Inherited from: \Zend_Gdata_YouTube_VideoEntry::$$_location
>VPropertyprotected\Zend_Gdata_YouTube_Extension_MediaGroup $_mediaGroup = null
>VPropertyprotectedarray $_namespaces = array('atom' => array(1 => array(0 => 'http://www.w3.org/2005/Atom')), 'app' => array(1 => array(0 => 'http://purl.org/atom/app#'), 2 => array(0 => 'http://www.w3.org/2007/app')))

The first dimension represents the namespace prefix, the second dimension represents the minimum major protocol version, and the third dimension is the minimum minor protocol version. Null keys are NOT allowed.

When looking up a namespace for a given prefix, the greatest version number (both major and minor) which is less than the effective version should be used.

Default valuearray('atom' => array(1 => array(0 => 'http://www.w3.org/2005/Atom')), 'app' => array(1 => array(0 => 'http://purl.org/atom/app#'), 2 => array(0 => 'http://www.w3.org/2007/app')))Details
Type
array
Inherited_from
\Zend_Gdata_App_Base::$$_namespaces  
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_namespaces  
Inherited_from
\Zend_Gdata_App_Entry::$$_namespaces  
Inherited_from
\Zend_Gdata_App_MediaEntry::$$_namespaces  
Inherited_from
\Zend_Gdata_Entry::$$_namespaces  
Inherited_from
\Zend_Gdata_Media_Entry::$$_namespaces  
Inherited_from
\Zend_Gdata_YouTube_MediaEntry::$$_namespaces  
Inherited_from
\Zend_Gdata_YouTube_VideoEntry::$$_namespaces  
See
\lookupNamespace()  
See
\registerNamespace()  
See
\registerAllNamespaces()  
>VPropertyprotected\Zend_Gdata_YouTube_Extension_NoEmbed|null $_noEmbed = null
inherited
If null, the video can be embedded
Inherited from: \Zend_Gdata_YouTube_VideoEntry::$$_noEmbed
Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_NoEmbed | null
Inherited_from
\Zend_Gdata_YouTube_VideoEntry::$$_noEmbed  
>VPropertyprotected\Zend_Gdata_YouTube_Extension_Position $_position = null
Position of the entry in the feed, as specified by the user
Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_Position
>VPropertyprotected\Zend_Gdata_YouTube_Extension_Private|null $_private = null
inherited
If not null, specifies that the video is private.
Inherited from: \Zend_Gdata_YouTube_VideoEntry::$$_private
Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_Private | null
Inherited_from
\Zend_Gdata_YouTube_VideoEntry::$$_private  
>VPropertyprotected\Zend_Gdata_YouTube_Extension_Racy|null $_racy = null
inherited
If not null, specifies that the video has racy content.
Inherited from: \Zend_Gdata_YouTube_VideoEntry::$$_racy
Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_Racy | null
Inherited_from
\Zend_Gdata_YouTube_VideoEntry::$$_racy  
>VPropertyprotected\Zend_Gdata_Extension_Rating $_rating = null
inherited
Specifies the video's rating.
Inherited from: \Zend_Gdata_YouTube_VideoEntry::$$_rating
Default valuenullDetails
Type
\Zend_Gdata_Extension_Rating
Inherited_from
\Zend_Gdata_YouTube_VideoEntry::$$_rating  
>VPropertyprotected\Zend_Gdata_YouTube_Extension_Recorded|null $_recorded = null
inherited
Recording date for the video
Inherited from: \Zend_Gdata_YouTube_VideoEntry::$$_recorded
>VPropertyprotected\Zend_Gdata_YouTube_Extension_Statistics $_statistics = null
inherited
Specifies the statistics relating to the video.
Inherited from: \Zend_Gdata_YouTube_VideoEntry::$$_statistics
>VPropertyprotected\Zend_Gdata_Geo_Extension_GeoRssWhere $_where = null
inherited
Geo location for the video
Inherited from: \Zend_Gdata_YouTube_VideoEntry::$$_where

Methods

methodpublic__construct(\DOMElement $element = null) : void

Creates a Playlist video entry, representing an individual video in a list of videos contained within a specific playlist

Parameters
NameTypeDescription
$element\DOMElement

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

methodpublic__get(string $name) : void
inherited

Magic getter to allow access like $entry->foo to call $entry->getFoo() Alternatively, if no getFoo() is defined, but a $_foo protected variable is defined, this is returned.

Inherited from: \Zend_Gdata_App_Base::__get()\Zend_Gdata_App_FeedEntryParent::__get()\Zend_Gdata_App_Entry::__get()\Zend_Gdata_App_MediaEntry::__get()\Zend_Gdata_Entry::__get()\Zend_Gdata_Media_Entry::__get()\Zend_Gdata_YouTube_MediaEntry::__get()\Zend_Gdata_YouTube_VideoEntry::__get()

TODO Remove ability to bypass getFoo() methods??

Parameters
NameTypeDescription
$namestring

The variable name sought

methodpublic__set(string $name,  $val) : void

Alternatively, if no setFoo() is defined, but a $_foo protected variable is defined, this is returned.

TODO Remove ability to bypass getFoo() methods??

Parameters
NameTypeDescription
$namestring
$val
methodpublicaddVideoDeveloperTag(string $developerTag) : \Zend_Gdata_YouTube_VideoEntry
inherited

Adds a developer tag to array of tags for the video.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::addVideoDeveloperTag()
Parameters
NameTypeDescription
$developerTagstring

DeveloperTag for the video

Returns
TypeDescription
\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface
methodpublicdelete() : void
inherited

Deletes this entry to the server using the referenced Zend_Http_Client to do a HTTP DELETE to the edit link stored in this entry's link collection.

Inherited from: \Zend_Gdata_App_Entry::delete()\Zend_Gdata_App_MediaEntry::delete()\Zend_Gdata_Entry::delete()\Zend_Gdata_Media_Entry::delete()\Zend_Gdata_YouTube_MediaEntry::delete()\Zend_Gdata_YouTube_VideoEntry::delete()
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
methodpublicencode() : string | \Zend_Gdata_MediaMimeStream

Can be overridden by children to provide more complex representations of entries.

Returns
TypeDescription
string | \Zend_Gdata_MediaMimeStreamThe MIME multipart representation of this MediaEntry. If the entry consisted only of XML, a string is returned.
methodpublicensureMediaGroupIsNotNull() : void
inherited

Get the VideoEntry's Zend_Gdata_YouTube_Extension_MediaGroup object.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::ensureMediaGroupIsNotNull()

If the mediaGroup does not exist, then set it.

methodpublicflushNamespaceLookupCache() : void

Empties the namespace lookup cache. Call this function if you have added data to the namespace lookup table that contradicts values that may have been cached during a previous call to lookupNamespace().

methodpublicgetAlternateLink() : \Zend_Gdata_App_Extension_Link

This alternate view is commonly a user-facing webpage, blog post, etc. The MIME type for the data at the URL is available from the returned Zend_Gdata_App_Extension_Link element. This link is in the atom feed/entry as an atom:link with a rel attribute value of 'self'.

Returns
TypeDescription
\Zend_Gdata_App_Extension_LinkThe link, or null if not found
methodpublicgetCategory() : array

Each category is represented in an atom feed by an atom:category element.

Returns
TypeDescription
arrayArray of Zend_Gdata_App_Extension_Category
methodpublicgetComments() : \Zend_Gdata_Extension_Comments
inherited

Returns the comments relating to the video.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getComments()
Returns
TypeDescription
\Zend_Gdata_Extension_CommentsThe comments relating to the video
methodpublicgetContributor() : array

Each contributor is represented in an atom feed by an atom:contributor XML element

Returns
TypeDescription
arrayAn array of Zend_Gdata_App_Extension_Contributor
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
NameTypeDescription
$doc\DOMDocument

The DOMDocument used to construct DOMElements

$majorVersion
$minorVersion
Returns
TypeDescription
\DOMElementThe DOMElement representing this element and all child properties.
methodpublicgetEditLink() : \Zend_Gdata_App_Extension_Link

This link is in the atom feed/entry as an atom:link with a rel attribute value of 'edit'.

Returns
TypeDescription
\Zend_Gdata_App_Extension_LinkThe link, or null if not found
methodpublicgetExtensionAttributes() : array

Each element of the array is a hashed array of the format: array('namespaceUri' => string, 'name' => string, 'value' => string);

Returns
TypeDescription
arrayAll extension attributes
methodpublicgetFeedLink(string $rel = null) : mixed
inherited

Get the feed link property for this entry.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getFeedLink()
Parameters
NameTypeDescription
$relstring

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

Returns
TypeDescription
mixedIf $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  
methodpublicgetFlashPlayerUrl() : string | null
inherited

Gets the URL of the flash player SWF.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getFlashPlayerUrl()

null is returned if the duration value is not available.

Returns
TypeDescription
string | nullThe URL of the flash player SWF
methodpublicgetLink(string $rel = null) : mixed

If the 'rel' value is not provided, the full array of Zend_Gdata_App_Extension_Link elements is returned. In an atom feed, each link is represented by an atom:link element. The 'rel' value passed to this function is the atom:link/@rel attribute. Example rel values include 'self', 'edit', and 'alternate'.

Parameters
NameTypeDescription
$relstring

The rel value of the link to be found. If null, the array of Zend_Gdata_App_Extension_link elements is returned

Returns
TypeDescription
mixedEither a single Zend_Gdata_App_Extension_link element, an array of the same or null is returned depending on the rel value supplied as the argument to this function
methodpublicgetLocation() : \Zend_Gdata_YouTube_Extension_Location | null
inherited

Gets the location where the video was recorded.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getLocation()
Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_Location | null
methodpublicgetMinorProtocolVersion() : \(int | \NULL)
Returns
TypeDescription
\(int | \NULL)The major protocol version in use, or NULL if no minor version is specified.
Details
See
\_minorProtocolVersion  
methodpublicgetNextLink() : \Zend_Gdata_App_Extension_Link

This link is in the atom feed as an atom:link with a rel attribute value of 'next'.

Returns
TypeDescription
\Zend_Gdata_App_Extension_LinkThe link, or null if not found
methodpublicgetNoEmbed() : \Zend_Gdata_YouTube_Extension_NoEmbed | null
inherited

If the return value is an instance of Zend_Gdata_YouTube_Extension_NoEmbed, this video cannot be embedded.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getNoEmbed()
Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_NoEmbed | nullWhether or not the video can be embedded
methodpublicgetPosition() : \Zend_Gdata_YouTube_Extension_Position

Returns the position of the entry in the feed, as specified by the user

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_PositionThe position
methodpublicgetPreviousLink() : \Zend_Gdata_App_Extension_Link

This link is in the atom feed as an atom:link with a rel attribute value of 'previous'.

Returns
TypeDescription
\Zend_Gdata_App_Extension_LinkThe link, or null if not found
methodpublicgetRacy() : \Zend_Gdata_YouTube_Extension_Racy | null
inherited

Returns the racy flag object.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getRacy()
Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_Racy | nullThe racy flag object
Throws
ExceptionDescription
\Zend_Gdata_App_VersionException
methodpublicgetRating() : \Zend_Gdata_Extension_Rating
inherited

Returns the rating relating to the video.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getRating()
Returns
TypeDescription
\Zend_Gdata_Extension_RatingThe rating relating to the video
methodpublicgetRecorded() : \Zend_Gdata_YouTube_Extension_Recorded | null
inherited

Gets the date that the video was recorded.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getRecorded()
Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_Recorded | null
methodpublicgetSelfLink() : \Zend_Gdata_App_Extension_Link
inherited

Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to retrieve the entry or feed represented by this object This link is in the atom feed/entry as an atom:link with a rel attribute value of 'self'.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getSelfLink()\Zend_Gdata_App_Entry::getSelfLink()\Zend_Gdata_App_MediaEntry::getSelfLink()\Zend_Gdata_Entry::getSelfLink()\Zend_Gdata_Media_Entry::getSelfLink()\Zend_Gdata_YouTube_MediaEntry::getSelfLink()\Zend_Gdata_YouTube_VideoEntry::getSelfLink()
Returns
TypeDescription
\Zend_Gdata_App_Extension_LinkThe link, or null if not found
methodpublicgetService() : \Zend_Gdata_App | null

This will be used to perform network requests, such as when calling save() and delete().

Returns
TypeDescription
\Zend_Gdata_App | nullThe current service instance, or null if not set.
methodpublicgetStatistics() : \Zend_Gdata_YouTube_Extension_Statistics
inherited

Returns the statistics relating to the video.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getStatistics()
Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_StatisticsThe statistics relating to the video
methodpublicgetText( $trim = true) : string
Parameters
NameTypeDescription
$trim
Returns
TypeDescription
stringChild text node
methodpublicgetTitle() : \Zend_Gdata_App_Extension_Title

The title is an extremely short textual representation of this resource and is found as an atom:title element in a feed or entry

Returns
TypeDescription
\Zend_Gdata_App_Extension_Title
methodpublicgetTitleValue() : string

The title is an extremely short textual representation of this resource and is found as an atom:title element in a feed or entry

Returns
TypeDescription
string
methodpublicgetVideoCategory() : string | null
inherited

Gets the category of this video, if available.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getVideoCategory()

The category is returned as a string. Valid categories are found at: http://gdata.youtube.com/schemas/2007/categories.cat If the category is not set, null is returned.

Returns
TypeDescription
string | nullThe category of this video
methodpublicgetVideoCommentFeedUrl() : string | null
inherited

Retrieve the URL for a video's comment feed.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getVideoCommentFeedUrl()
Returns
TypeDescription
string | nullThe URL if found, or null if not found.
methodpublicgetVideoComplaintsLink() : \Zend_Gdata_App_Extension_Link
inherited

Returns the link element relating to video complaints.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getVideoComplaintsLink()
Returns
TypeDescription
\Zend_Gdata_App_Extension_Link
methodpublicgetVideoDescription() : string | null
inherited

Gets the description of the video as a string.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getVideoDescription()

null is returned if the video description is not available.

Returns
TypeDescription
string | nullThe description of the video
methodpublicgetVideoDeveloperTags() : array | null
inherited

Gets the developer tags for the video, if available and if client is authenticated with a valid developerKey.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getVideoDeveloperTags()

The tags are returned as an array. If no tags are set, null is returned.

Returns
TypeDescription
array | nullThe developer tags for this video or null if none were set.
methodpublicgetVideoDuration() : string | null
inherited

Gets the duration of the video, in seconds.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getVideoDuration()

null is returned if the duration value is not available.

Returns
TypeDescription
string | nullThe duration of the video, in seconds.
methodpublicgetVideoGeoLocation() : array | null
inherited

Gets the location specified for this video, if available.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getVideoGeoLocation()

The location is returned as an array containing the keys 'longitude' and 'latitude'. null is returned if the location is not available.

Returns
TypeDescription
array | nullThe location specified for this video
methodpublicgetVideoId() : string
inherited

Gets the YouTube video ID based upon the atom:id value

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getVideoId()
Returns
TypeDescription
stringThe video ID
methodpublicgetVideoRatingInfo() : array | null
inherited

Gets the rating information for this video, if available.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getVideoRatingInfo()

The rating is returned as an array containing the keys 'average' and 'numRaters'. null is returned if the rating information is not available.

Returns
TypeDescription
array | nullThe rating information for this video
methodpublicgetVideoRatingsLink() : \Zend_Gdata_App_Extension_Link
inherited

Returns the link element relating to video ratings.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getVideoRatingsLink()
Returns
TypeDescription
\Zend_Gdata_App_Extension_Link
methodpublicgetVideoRecorded() : string | null
inherited

Gets the date that the video was recorded.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getVideoRecorded()
Returns
TypeDescription
string | nullThe date that the video was recorded
methodpublicgetVideoResponsesLink() : \Zend_Gdata_App_Extension_Link
inherited

Returns the link element relating to video responses.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getVideoResponsesLink()
Returns
TypeDescription
\Zend_Gdata_App_Extension_Link
methodpublicgetVideoState() : \Zend_Gdata_YouTube_Extension_State | null
inherited

Get the current publishing state of the video.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getVideoState()
Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_State | nullThe publishing state of this video
methodpublicgetVideoTags() : array
inherited

Gets an array of the tags assigned to this video.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getVideoTags()

For convient usage inside a foreach loop, an empty array is returned when there are no tags assigned.

Returns
TypeDescription
arrayAn array of the tags assigned to this video
methodpublicgetVideoThumbnails() : array
inherited

Gets an array of the thumbnails representing the video.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getVideoThumbnails()

Each thumbnail is an element of the array, and is an array of the thumbnail properties - time, height, width, and url. For convient usage inside a foreach loop, an empty array is returned if there are no thumbnails.

Returns
TypeDescription
arrayAn array of video thumbnails.
methodpublicgetVideoTitle() : string | null
inherited

Gets the title of the video as a string.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getVideoTitle()

null is returned if the video title is not available.

Returns
TypeDescription
string | nullThe title of the video
methodpublicgetVideoViewCount() : string | null
inherited

Gets the number of views for this video.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getVideoViewCount()

null is returned if the number of views is not available.

Returns
TypeDescription
string | nullThe number of views for this video
methodpublicgetVideoWatchPageUrl() : string | null
inherited

Gets the URL of the YouTube video watch page.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getVideoWatchPageUrl()

null is returned if the video watch page URL is not available.

Returns
TypeDescription
string | nullThe URL of the YouTube video watch page
methodpublicgetWhere() : \Zend_Gdata_Geo_Extension_GeoRssWhere
inherited

Gets the georss:where element

Inherited from: \Zend_Gdata_YouTube_VideoEntry::getWhere()
methodpublicisVideoEmbeddable() : bool
inherited

Checks whether the video is embeddable.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::isVideoEmbeddable()
Returns
TypeDescription
boolReturns true if the video is embeddable.
methodpublicisVideoPrivate() : bool
inherited

Checks whether the video is private.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::isVideoPrivate()
Returns
TypeDescription
boolReturn true if video is private
methodpubliclookupNamespace(string $prefix, integer $majorVersion = null, integer $minorVersion = null) : string

Looks up a prefix (atom:, etc.) in the list of registered namespaces and returns the full namespace URI if available. Returns the prefix, unmodified, if it's not registered.

The current entry or feed's version will be used when performing the namespace lookup unless overridden using $majorVersion and $minorVersion. If the entry/fee has a null version, then the latest protocol version will be used by default.

Parameters
NameTypeDescription
$prefixstring

The namespace prefix to lookup.

$majorVersioninteger

The major protocol version in effect. Defaults to null (auto-select).

$minorVersioninteger

The minor protocol version in effect. Defaults to null (auto-select).

Returns
TypeDescription
string
methodpublicregisterAllNamespaces(array $namespaceArray) : void

Takes an array in the format of: namespace prefix, namespace URI, major protocol version, minor protocol version and adds them with calls to ->registerNamespace()

Parameters
NameTypeDescription
$namespaceArrayarray

An array of namespaces.

methodpublicregisterNamespace(string $prefix, string $namespaceUri, integer $majorVersion = 1, integer $minorVersion = 0) : void

Takes a prefix and a full namespace URI and adds them to the list of registered namespaces for use by $this->lookupNamespace().

WARNING: Currently, registering a namespace will NOT invalidate any memoized data stored in $_namespaceLookupCache. Under normal use, this behavior is acceptable. If you are adding contradictory data to the namespace lookup table, you must call flushNamespaceLookupCache().

Parameters
NameTypeDescription
$prefixstring

The namespace prefix

$namespaceUristring

The full namespace URI

$majorVersioninteger

The major protocol version in effect. Defaults to '1'.

$minorVersioninteger

The minor protocol version in effect. Defaults to null (use latest).

methodpublicreload(string | null $uri = null, string | null $className = null, array $extraHeaders = array()) : mixed

Returns a new copy of the entry as returned by the server, or null if no changes exist. This does not modify the current entry instance.

Parameters
NameTypeDescription
$uristring | null

The URI to send requests to, or null if $data contains the URI.

$classNamestring | null

The name of the class that should we deserializing the server response. If null, then 'Zend_Gdata_App_Entry' will be used.

$extraHeadersarray

Extra headers to add to the request, as an array of string-based key/value pairs.

Returns
TypeDescription
mixedA new instance of the current entry with updated data, or null if the server reports that no changes have been made.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
methodpublicsave(string | null $uri = null, string | null $className = null, array $extraHeaders = array()) : \Zend_Gdata_App_Entry
Parameters
NameTypeDescription
$uristring | null

The URI to send requests to, or null if $data contains the URI.

$classNamestring | null

The name of the class that should we deserializing the server response. If null, then 'Zend_Gdata_App_Entry' will be used.

$extraHeadersarray

Extra headers to add to the request, as an array of string-based key/value pairs.

Returns
TypeDescription
\Zend_Gdata_App_EntryThe updated entry.
Throws
ExceptionDescription
\Zend_Gdata_App_Exception
methodpublicsetAuthor(array $value) : \Zend_Gdata_App_FeedEntryParent

In an atom feed, each author is represented by an atom:author element

Parameters
NameTypeDescription
$valuearray
Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides a fluent interface
methodpublicsetCategory(array $value) : \Zend_Gdata_App_FeedEntryParent

Each category is represented in an atom feed by an atom:category element.

Parameters
NameTypeDescription
$valuearray

Array of Zend_Gdata_App_Extension_Category

Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides a fluent interface
methodpublicsetComments(\Zend_Gdata_Extension_Comments $comments = null) : \Zend_Gdata_YouTube_VideoEntry
inherited

Sets the comments relating to the video.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::setComments()
Parameters
NameTypeDescription
$comments\Zend_Gdata_Extension_Comments

The comments relating to the video

Returns
TypeDescription
\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface
methodpublicsetContributor(array $value) : \Zend_Gdata_App_FeedEntryParent

Each contributor is represented in an atom feed by an atom:contributor XML element

Parameters
NameTypeDescription
$valuearray
Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides a fluent interface
methodpublicsetEtag(string | null $value) : \Zend_Gdata_App_Entry

Setting $value to null unsets the Etag.

Parameters
NameTypeDescription
$valuestring | null
Returns
TypeDescription
\Zend_Gdata_App_EntryProvides a fluent interface
methodpublicsetExtensionAttributes(array $value) : \Zend_Gdata_App_Base

Each element of the array is a hashed array of the format: array('namespaceUri' => string, 'name' => string, 'value' => string); This can be used to add arbitrary attributes to any data model element

Parameters
NameTypeDescription
$valuearray

All extension attributes

Returns
TypeDescription
\Zend_Gdata_App_BaseReturns an object of the same type as 'this' to provide a fluent interface.
methodpublicsetExtensionElements(array $value) : \Zend_Gdata_App_Base

This method can be used to add arbitrary child XML elements to any data model class.

Parameters
NameTypeDescription
$valuearray

All extension elements

Returns
TypeDescription
\Zend_Gdata_App_BaseReturns an object of the same type as 'this' to provide a fluent interface.
methodpublicsetFeedLink(array $feedLink = null) : \Zend_Gdata_YouTube_VideoEntry
inherited

Sets the array of embedded feeds related to the video

Inherited from: \Zend_Gdata_YouTube_VideoEntry::setFeedLink()
Parameters
NameTypeDescription
$feedLinkarray

The array of embedded feeds relating to the video

Returns
TypeDescription
\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface
methodpublicsetLocation(\Zend_Gdata_YouTube_Extension_Location $location = null) : \Zend_Gdata_YouTube_VideoEntry
inherited

Sets the location information.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::setLocation()
Parameters
NameTypeDescription
$location\Zend_Gdata_YouTube_Extension_Location

Where the video was recorded

Returns
TypeDescription
\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface
methodpublicsetMajorProtocolVersion(\(int | \NULL) $value) : void

Values < 1 (excluding NULL) will cause a Zend_Gdata_App_InvalidArgumentException to be thrown.

Parameters
NameTypeDescription
$value\(int | \NULL)

The major protocol version to use.

Throws
ExceptionDescription
\Zend_Gdata_App_InvalidArgumentException
Details
See
\_majorProtocolVersion  
methodpublicsetMediaGroup(\Zend_Gdata_Media_Extension_MediaGroup $mediaGroup) : \Zend_Gdata_Media_Entry
Parameters
NameTypeDescription
$mediaGroup\Zend_Gdata_Media_Extension_MediaGroup
Returns
TypeDescription
\Zend_Gdata_Media_EntryProvides a fluent interface
methodpublicsetMediaSource(\Zend_Gdata_App_MediaSource $value) : \Zend_Gdata_App_MediaEntry
Parameters
NameTypeDescription
$value\Zend_Gdata_App_MediaSource

The attached MediaSource/file

Returns
TypeDescription
\Zend_Gdata_App_MediaEntryProvides a fluent interface
methodpublicsetMinorProtocolVersion(\(int | \NULL) $value) : void

If set to NULL, no minor protocol version will be sent to the server. Values < 0 will cause a Zend_Gdata_App_InvalidArgumentException to be thrown.

Parameters
NameTypeDescription
$value\(int | \NULL)

The minor protocol version to use.

Throws
ExceptionDescription
\Zend_Gdata_App_InvalidArgumentException
Details
See
\_minorProtocolVersion  
methodpublicsetNoEmbed(\Zend_Gdata_YouTube_Extension_NoEmbed $noEmbed = null) : \Zend_Gdata_YouTube_VideoEntry
inherited

If an instance of Zend_Gdata_YouTube_Extension_NoEmbed is passed in, the video cannot be embedded.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::setNoEmbed()

Otherwise, if null is passsed in, the video is able to be embedded.

Parameters
NameTypeDescription
$noEmbed\Zend_Gdata_YouTube_Extension_NoEmbed

Whether or not the video can be embedded.

Returns
TypeDescription
\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface
methodpublicsetPosition(\Zend_Gdata_YouTube_Extension_Position $position = null) : \Zend_Gdata_YouTube_PlaylistVideoEntry

Sets the array of embedded feeds related to the video

Parameters
NameTypeDescription
$position\Zend_Gdata_YouTube_Extension_Position

The position of the entry in the feed, as specified by the user.

Returns
TypeDescription
\Zend_Gdata_YouTube_PlaylistVideoEntryProvides a fluent interface
methodpublicsetRacy(\Zend_Gdata_YouTube_Extension_Racy $racy = null) : \Zend_Gdata_YouTube_VideoEntry
inherited

Specifies that the video has racy content.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::setRacy()
Parameters
NameTypeDescription
$racy\Zend_Gdata_YouTube_Extension_Racy

The racy flag object

Returns
TypeDescription
\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface
Throws
ExceptionDescription
\Zend_Gdata_App_VersionException
methodpublicsetRating(\Zend_Gdata_Extension_Rating $rating = null) : \Zend_Gdata_YouTube_VideoEntry
inherited

Sets the rating relating to the video.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::setRating()
Parameters
NameTypeDescription
$rating\Zend_Gdata_Extension_Rating

The rating relating to the video

Returns
TypeDescription
\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface
methodpublicsetRecorded(\Zend_Gdata_YouTube_Extension_Recorded $recorded = null) : \Zend_Gdata_YouTube_VideoEntry
inherited

Sets when the video was recorded.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::setRecorded()
Parameters
NameTypeDescription
$recorded\Zend_Gdata_YouTube_Extension_Recorded

When the video was recorded

Returns
TypeDescription
\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface
methodpublicsetService(\Zend_Gdata_App $instance) : \Zend_Gdata_App_FeedEntryParent

This will be used to perform network requests, such as when calling save() and delete().

Parameters
NameTypeDescription
$instance\Zend_Gdata_App

The new service instance.

Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides a fluent interface.
methodpublicsetStatistics(\Zend_Gdata_YouTube_Extension_Statistics $statistics = null) : \Zend_Gdata_YouTube_VideoEntry
inherited

Sets the statistics relating to the video.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::setStatistics()
Parameters
NameTypeDescription
$statistics\Zend_Gdata_YouTube_Extension_Statistics

The statistics relating to the video

Returns
TypeDescription
\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface
methodpublicsetSummary(\Zend_Gdata_App_Extension_Summary $value) : \Zend_Gdata_App_Entry
Parameters
NameTypeDescription
$value\Zend_Gdata_App_Extension_Summary
Returns
TypeDescription
\Zend_Gdata_App_EntryProvides a fluent interface
methodpublicsetText(string $value) : \Zend_Gdata_App_Base
Parameters
NameTypeDescription
$valuestring

Child text node

Returns
TypeDescription
\Zend_Gdata_App_BaseReturns an object of the same type as 'this' to provide a fluent interface.
methodpublicsetTitle(\Zend_Gdata_App_Extension_Title $value) : \Zend_Gdata_App_FeedEntryParent

The title is an extremely short textual representation of this resource and is found as an atom:title element in a feed or entry

Parameters
NameTypeDescription
$value\Zend_Gdata_App_Extension_Title
Returns
TypeDescription
\Zend_Gdata_App_FeedEntryParentProvides a fluent interface
methodpublicsetVideoCategory(string $category) : \Zend_Gdata_YouTube_VideoEntry
inherited

Sets the category of the video as a string.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::setVideoCategory()
Parameters
NameTypeDescription
$categorystring

Categories for the video

Returns
TypeDescription
\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface
methodpublicsetVideoDescription(string $description) : \Zend_Gdata_YouTube_VideoEntry
inherited

Sets the description of the video as a string.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::setVideoDescription()
Parameters
NameTypeDescription
$descriptionstring

Description for the video

Returns
TypeDescription
\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface
methodpublicsetVideoDeveloperTags(array $developerTags) : \Zend_Gdata_YouTube_VideoEntry
inherited

Set multiple developer tags for the video as strings.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::setVideoDeveloperTags()
Parameters
NameTypeDescription
$developerTagsarray

Array of developerTag for the video

Returns
TypeDescription
\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface
methodpublicsetVideoPrivate() : \Zend_Gdata_YouTube_VideoEntry
inherited

Sets video to private.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::setVideoPrivate()
Returns
TypeDescription
\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface
methodpublicsetVideoPublic() : \Zend_Gdata_YouTube_VideoEntry
inherited

Sets a private video to be public.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::setVideoPublic()
Returns
TypeDescription
\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface
methodpublicsetVideoRating(integer $ratingValue) : \Zend_Gdata_YouTube_VideoEntry
inherited

Helper function to conveniently set a video's rating.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::setVideoRating()
Parameters
NameTypeDescription
$ratingValueinteger

A number representing the rating. Must be between 1 and 5 inclusive.

Returns
TypeDescription
\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface.
Throws
ExceptionDescription
\Zend_Gdata_Exception
methodpublicsetVideoRecorded(string $recorded) : void
inherited

Sets the date that the video was recorded.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::setVideoRecorded()
Parameters
NameTypeDescription
$recordedstring

The date that the video was recorded, in the format of '2001-06-19'

methodpublicsetVideoTags(mixed $tags) : \Zend_Gdata_YouTube_VideoEntry
inherited

Sets the keyword tags for a video.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::setVideoTags()
Parameters
NameTypeDescription
$tagsmixed

Either a comma-separated string or an array of tags for the video

Returns
TypeDescription
\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface
methodpublicsetVideoTitle(string $title) : \Zend_Gdata_YouTube_VideoEntry
inherited

Sets the title of the video as a string.

Inherited from: \Zend_Gdata_YouTube_VideoEntry::setVideoTitle()
Parameters
NameTypeDescription
$titlestring

Title for the video

Returns
TypeDescription
\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface
methodpublicsetWhere(\Zend_Gdata_Geo_Extension_GeoRssWhere $value) : \Zend_Gdata_YouTube_VideoEntry
inherited

Sets the georss:where element

Inherited from: \Zend_Gdata_YouTube_VideoEntry::setWhere()
Parameters
NameTypeDescription
$value\Zend_Gdata_Geo_Extension_GeoRssWhere

The georss:where class value

Returns
TypeDescription
\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface
methodprotectedtakeAttributeFromDOM(\DOMNode $attribute) : void

If no mapping is defined, the name and value are stored in an array.

Parameters
NameTypeDescription
$attribute\DOMNode

The DOMNode attribute needed to be handled

methodprotectedtakeChildFromDOM(\DOMNode $child) : void

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

If no mapping is defined, Extension_Element objects are created and stored in an array.

Parameters
NameTypeDescription
$child\DOMNode

The DOMNode to process

methodpublictransferFromDOM(\DOMNode $node) : void

This is called when XML is received over the wire and the data model needs to be built to represent this XML.

Parameters
NameTypeDescription
$node\DOMNode

The DOMNode that represents this object's data

methodpublictransferFromXML(string $xml) : void

The first data model element with the same name as $this->_rootElement is used and the child elements are recursively parsed.

Parameters
NameTypeDescription
$xmlstring

The XML text to parse

Documentation was generated by phpDocumentor 2.0.0a12.