API Documentation

Gdata/YouTube/VideoEntry.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Gdata  
subpackage
YouTube  
version
$Id: VideoEntry.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Gdata_YouTube_VideoEntry

Represents the YouTube video flavor of an Atom entry

Extends from
\Zend_Gdata_YouTube_MediaEntry
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Gdata  
subpackage
YouTube  

Constants

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

Properties

Propertyprotected\Zend_Gdata_Extensions_Comments  $_comments= 'null'

Specifies the comments associated with a video.

Default valuenullDetails
Type
\Zend_Gdata_Extensions_Comments
Propertyprotectedstring  $_entryClassName= 'Zend_Gdata_YouTube_VideoEntry'

Class name for each entry in this feed*

Default valueZend_Gdata_YouTube_VideoEntryDetails
Type
string
Propertyprotectedarray  $_feedLink= 'array'

Nested feed links

Default valuearrayDetails
Type
array
Propertyprotected\Zend_Gdata_YouTube_Extension_Location|null  $_location= 'null'

Location informtion for the video

Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_Locationnull
Propertyprotected\Zend_Gdata_YouTube_Extension_NoEmbed|null  $_noEmbed= 'null'

If null, the video can be embedded

Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_NoEmbednull
Propertyprotected\Zend_Gdata_YouTube_Extension_Private|null  $_private= 'null'

If not null, specifies that the video is private.

Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_Privatenull
Propertyprotected\Zend_Gdata_YouTube_Extension_Racy|null  $_racy= 'null'

If not null, specifies that the video has racy content.

Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_Racynull
Propertyprotected\Zend_Gdata_Extension_Rating  $_rating= 'null'

Specifies the video's rating.

Default valuenullDetails
Type
\Zend_Gdata_Extension_Rating
Propertyprotected\Zend_Gdata_YouTube_Extension_Recorded|null  $_recorded= 'null'

Recording date for the video

Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_Recordednull
Propertyprotected\Zend_Gdata_YouTube_Extension_Statistics  $_statistics= 'null'

Specifies the statistics relating to the video.

Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_Statistics
Propertyprotected\Zend_Gdata_Geo_Extension_GeoRssWhere  $_where= 'null'

Geo location for the video

Default valuenullDetails
Type
\Zend_Gdata_Geo_Extension_GeoRssWhere

Methods

methodpublic__construct( \DOMElement $element = null ) : void

Creates a Video entry, representing an individual video

Parameters
Name Type Description
$element \DOMElement

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

methodpublic__get( string $name ) : void

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()

TODO Remove ability to bypass getFoo() methods??

Parameters
Name Type Description
$name string The variable name sought
methodpublicaddVideoDeveloperTag( string $developerTag ) : \Zend_Gdata_YouTube_VideoEntry

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

Parameters
Name Type Description
$developerTag string DeveloperTag for the video
Returns
Type Description
\Zend_Gdata_YouTube_VideoEntry Provides a fluent interface
methodpublicdelete( ) : void

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()
Throws
Exception Description
\Zend_Gdata_App_Exception
methodpublicencode( ) : string|\Zend_Gdata_MediaMimeStream

Return the MIME multipart representation of this MediaEntry.

Inherited from: \Zend_Gdata_App_MediaEntry::encode()

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

Returns
Type Description
string\Zend_Gdata_MediaMimeStream The MIME multipart representation of this MediaEntry. If the entry consisted only of XML, a string is returned.
methodpublicensureMediaGroupIsNotNull( ) : void

Get the VideoEntry's Zend_Gdata_YouTube_Extension_MediaGroup object.

If the mediaGroup does not exist, then set it.

methodpublicflushNamespaceLookupCache( ) : void
static

Flush namespace lookup cache.

Inherited from: \Zend_Gdata_App_Base::flushNamespaceLookupCache()

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

Returns the Zend_Gdata_App_Extension_Link element which represents the URL for an alternate view of the data represented by this feed or entry. 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.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getAlternateLink()

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

Returns
Type Description
\Zend_Gdata_App_Extension_Link The link, or null if not found
methodpublicgetCategory( ) : array

Returns the array of categories that classify this feed/entry. Each category is represented in an atom feed by an atom:category element.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getCategory()
Returns
Type Description
array Array of Zend_Gdata_App_Extension_Category
methodpublicgetComments( ) : \Zend_Gdata_Extension_Comments

Returns the comments relating to the video.

Returns
Type Description
\Zend_Gdata_Extension_Comments The comments relating to the video
methodpublicgetContent( ) : \Zend_Gdata_App_Extension_Content

Gets the value of the atom:content element

Inherited from: \Zend_Gdata_App_Entry::getContent()
Returns
Type Description
\Zend_Gdata_App_Extension_Content
methodpublicgetContributor( ) : array

Returns the array of contributors to this feed/entry. Each contributor is represented in an atom feed by an atom:contributor XML element

Inherited from: \Zend_Gdata_App_FeedEntryParent::getContributor()
Returns
Type Description
array An array of Zend_Gdata_App_Extension_Contributor
methodpublicgetControl( ) : \Zend_Gdata_App_Extension_Control

Gets the value of the app:control element

Inherited from: \Zend_Gdata_App_Entry::getControl()
Returns
Type Description
\Zend_Gdata_App_Extension_Control
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.
methodpublicgetEditLink( ) : \Zend_Gdata_App_Extension_Link

Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to edit this resource. This link is in the atom feed/entry as an atom:link with a rel attribute value of 'edit'.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getEditLink()
Returns
Type Description
\Zend_Gdata_App_Extension_Link The link, or null if not found
methodpublicgetEtag( ) : string|null

Return the Etag for the current entry, or null if not set.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getEtag()
Returns
Type Description
stringnull
methodpublicgetExtensionAttributes( ) : array

Returns an array of all extension attributes not transformed into data model properties during parsing of the XML. Each element of the array is a hashed array of the format: array('namespaceUri' => string, 'name' => string, 'value' => string);

Inherited from: \Zend_Gdata_App_Base::getExtensionAttributes()
Returns
Type Description
array All extension attributes
methodpublicgetExtensionElements( ) : array

Returns an array of all elements not matched to data model classes during the parsing of the XML

Inherited from: \Zend_Gdata_App_Base::getExtensionElements()
Returns
Type Description
array All elements not matched to data model classes during parsing
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  
methodpublicgetFlashPlayerUrl( ) : string|null

Gets the URL of the flash player SWF. null is returned if the duration value is not available.

Returns
Type Description
stringnull The URL of the flash player SWF
methodpublicgetHttpClient( ) : \Zend_Http_Client_Abstract

Gets the HTTP client object. If none is set, a new Zend_Http_Client will be used.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getHttpClient()
Returns
Type Description
\Zend_Http_Client_Abstract
Details
deprecated
Deprecated as of Zend Framework 1.7. Use getService() instead.  
methodpublicgetLink( string $rel = null ) : mixed

Given a particular 'rel' value, this method returns a matching Zend_Gdata_App_Extension_Link element. 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'.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getLink()
Parameters
Name Type Description
$rel string The rel value of the link to be found. If null, the array of Zend_Gdata_App_Extension_link elements is returned
Returns
Type Description
mixed Either 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

Gets the location where the video was recorded.

Returns
Type Description
\Zend_Gdata_YouTube_Extension_Locationnull
methodpublicgetMajorProtocolVersion( ) : \(int|\NULL)

Get the major protocol version that is in use.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getMajorProtocolVersion()
Returns
Type Description
\(int\NULL) The major protocol version in use.
Details
see
\_majorProtocolVersion  
methodpublicgetMediaGroup( ) : \Zend_Gdata_Media_Extension_MediaGroup

Returns the entry's mediaGroup object.

Inherited from: \Zend_Gdata_Media_Entry::getMediaGroup()
Returns
Type Description
\Zend_Gdata_Media_Extension_MediaGroup
methodpublicgetMediaSource( ) : \Zend_Gdata_App_MediaSource

Return the MediaSource object representing the file attached to this MediaEntry.

Inherited from: \Zend_Gdata_App_MediaEntry::getMediaSource()
Returns
Type Description
\Zend_Gdata_App_MediaSource The attached MediaSource/file
methodpublicgetMinorProtocolVersion( ) : \(int|\NULL)

Get the minor protocol version that is in use.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getMinorProtocolVersion()
Returns
Type Description
\(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

Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to retrieve the next chunk of results when paging through a feed. This link is in the atom feed as an atom:link with a rel attribute value of 'next'.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getNextLink()
Returns
Type Description
\Zend_Gdata_App_Extension_Link The link, or null if not found
methodpublicgetNoEmbed( ) : \Zend_Gdata_YouTube_Extension_NoEmbed|null

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

Returns
Type Description
\Zend_Gdata_YouTube_Extension_NoEmbednull Whether or not the video can be embedded
methodpublicgetPreviousLink( ) : \Zend_Gdata_App_Extension_Link

Returns the Zend_Gdata_App_Extension_Link element which represents the URL used to retrieve the previous chunk of results when paging through a feed. This link is in the atom feed as an atom:link with a rel attribute value of 'previous'.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getPreviousLink()
Returns
Type Description
\Zend_Gdata_App_Extension_Link The link, or null if not found
methodpublicgetPublished( ) : \Zend_Gdata_App_Extension_Published

Sets the value of the atom:published element This represents the publishing date for an entry

Inherited from: \Zend_Gdata_App_Entry::getPublished()
Returns
Type Description
\Zend_Gdata_App_Extension_Published
methodpublicgetRacy( ) : \Zend_Gdata_YouTube_Extension_Racy|null

Returns the racy flag object.

Returns
Type Description
\Zend_Gdata_YouTube_Extension_Racynull The racy flag object
Throws
Exception Description
\Zend_Gdata_App_VersionException
methodpublicgetRating( ) : \Zend_Gdata_Extension_Rating

Returns the rating relating to the video.

Returns
Type Description
\Zend_Gdata_Extension_Rating The rating relating to the video
methodpublicgetRecorded( ) : \Zend_Gdata_YouTube_Extension_Recorded|null

Gets the date that the video was recorded.

Returns
Type Description
\Zend_Gdata_YouTube_Extension_Recordednull
methodpublicgetRights( ) : \Zend_Gdata_AppExtension_Rights
Returns
Type Description
\Zend_Gdata_AppExtension_Rights
methodpublicgetSelfLink( ) : \Zend_Gdata_App_Extension_Link

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()
Returns
Type Description
\Zend_Gdata_App_Extension_Link The link, or null if not found
methodpublicgetService( ) : \Zend_Gdata_App|null

Get the active service instance for this object. This will be used to perform network requests, such as when calling save() and delete().

Inherited from: \Zend_Gdata_App_FeedEntryParent::getService()
Returns
Type Description
\Zend_Gdata_Appnull The current service instance, or null if not set.
methodpublicgetSource( ) : \Zend_Gdata_App_Extension_Source

Gets the value of the atom:source element

Inherited from: \Zend_Gdata_App_Entry::getSource()
Returns
Type Description
\Zend_Gdata_App_Extension_Source
methodpublicgetStatistics( ) : \Zend_Gdata_YouTube_Extension_Statistics

Returns the statistics relating to the video.

Returns
Type Description
\Zend_Gdata_YouTube_Extension_Statistics The statistics relating to the video
methodpublicgetSummary( ) : \Zend_Gdata_App_Extension_Summary

Gets the value of the atom:summary element This represents a textual summary of this entry's content

Inherited from: \Zend_Gdata_App_Entry::getSummary()
Returns
Type Description
\Zend_Gdata_App_Extension_Summary
methodpublicgetText(  $trim = true ) : string

Returns the child text node of this element This represents any raw text contained within the XML element

Inherited from: \Zend_Gdata_App_Base::getText()
Parameters
Name Type Description
$trim
Returns
Type Description
string Child text node
methodpublicgetTitle( ) : \Zend_Gdata_App_Extension_Title

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

Inherited from: \Zend_Gdata_App_FeedEntryParent::getTitle()
Returns
Type Description
\Zend_Gdata_App_Extension_Title
methodpublicgetTitleValue( ) : string

Returns a string representation of the title of this feed or entry.

Inherited from: \Zend_Gdata_App_FeedEntryParent::getTitleValue()

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
Type Description
string
methodpublicgetVideoCategory( ) : string|null

Gets the category of this video, if available. 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
Type Description
stringnull The category of this video
methodpublicgetVideoCommentFeedUrl( ) : string|null

Retrieve the URL for a video's comment feed.

Returns
Type Description
stringnull The URL if found, or null if not found.
methodpublicgetVideoComplaintsLink( ) : \Zend_Gdata_App_Extension_Link

Returns the link element relating to video complaints.

Returns
Type Description
\Zend_Gdata_App_Extension_Link
methodpublicgetVideoDescription( ) : string|null

Gets the description of the video as a string. null is returned if the video description is not available.

Returns
Type Description
stringnull The description of the video
methodpublicgetVideoDeveloperTags( ) : array|null

Gets the developer tags for the video, if available and if client is authenticated with a valid developerKey. The tags are returned as an array.

If no tags are set, null is returned.

Returns
Type Description
arraynull The developer tags for this video or null if none were set.
methodpublicgetVideoDuration( ) : string|null

Gets the duration of the video, in seconds. null is returned if the duration value is not available.

Returns
Type Description
stringnull The duration of the video, in seconds.
methodpublicgetVideoGeoLocation( ) : array|null

Gets the location specified for this video, if available. The location is returned as an array containing the keys 'longitude' and 'latitude'.

null is returned if the location is not available.

Returns
Type Description
arraynull The location specified for this video
methodpublicgetVideoId( ) : string

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

Returns
Type Description
string The video ID
methodpublicgetVideoRatingInfo( ) : array|null

Gets the rating information for this video, if available. The rating is returned as an array containing the keys 'average' and 'numRaters'.

null is returned if the rating information is not available.

Returns
Type Description
arraynull The rating information for this video
methodpublicgetVideoRatingsLink( ) : \Zend_Gdata_App_Extension_Link

Returns the link element relating to video ratings.

Returns
Type Description
\Zend_Gdata_App_Extension_Link
methodpublicgetVideoRecorded( ) : string|null

Gets the date that the video was recorded.

Returns
Type Description
stringnull The date that the video was recorded
methodpublicgetVideoResponsesLink( ) : \Zend_Gdata_App_Extension_Link

Returns the link element relating to video responses.

Returns
Type Description
\Zend_Gdata_App_Extension_Link
methodpublicgetVideoState( ) : \Zend_Gdata_YouTube_Extension_State|null

Get the current publishing state of the video.

Returns
Type Description
\Zend_Gdata_YouTube_Extension_Statenull The publishing state of this video
methodpublicgetVideoTags( ) : array

Gets an array of the tags assigned to this video. For convient usage inside a foreach loop, an empty array is returned when there are no tags assigned.

Returns
Type Description
array An array of the tags assigned to this video
methodpublicgetVideoThumbnails( ) : array

Gets an array of the thumbnails representing the video.

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
Type Description
array An array of video thumbnails.
methodpublicgetVideoTitle( ) : string|null

Gets the title of the video as a string. null is returned if the video title is not available.

Returns
Type Description
stringnull The title of the video
methodpublicgetVideoViewCount( ) : string|null

Gets the number of views for this video. null is returned if the number of views is not available.

Returns
Type Description
stringnull The number of views for this video
methodpublicgetVideoWatchPageUrl( ) : string|null

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

Returns
Type Description
stringnull The URL of the YouTube video watch page
methodpublicgetWhere( ) : \Zend_Gdata_Geo_Extension_GeoRssWhere

Gets the georss:where element

Returns
Type Description
\Zend_Gdata_Geo_Extension_GeoRssWhere
methodpublicgetXML( ) : string

Alias for saveXML() returns XML content for this element and all children

Inherited from: \Zend_Gdata_App_Base::getXML()
Returns
Type Description
string XML content
methodpublicisVideoEmbeddable( ) : bool

Checks whether the video is embeddable.

Returns
Type Description
bool Returns true if the video is embeddable.
methodpublicisVideoPrivate( ) : bool

Checks whether the video is private.

Returns
Type Description
bool Return true if video is private
methodpubliclookupNamespace( string $prefix, integer $majorVersion = null, integer $minorVersion = null ) : string

Get the full version of a namespace prefix

Inherited from: \Zend_Gdata_App_FeedEntryParent::lookupNamespace()

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
Name Type Description
$prefix string The namespace prefix to lookup.
$majorVersion integer

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

$minorVersion integer

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

Returns
Type Description
string
methodpublicregisterAllNamespaces( array $namespaceArray ) : void

Add an array of namespaces to the registered list.

Inherited from: \Zend_Gdata_App_Base::registerAllNamespaces()

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
Name Type Description
$namespaceArray array An array of namespaces.
methodpublicregisterNamespace( string $prefix, string $namespaceUri, integer $majorVersion = 1, integer $minorVersion = 0 ) : void

Add a namespace and prefix to the registered list

Inherited from: \Zend_Gdata_App_Base::registerNamespace()

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
Name Type Description
$prefix string The namespace prefix
$namespaceUri string The full namespace URI
$majorVersion integer

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

$minorVersion integer

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

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

Reload the current entry. 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.

Inherited from: \Zend_Gdata_App_Entry::reload()
Parameters
Name Type Description
$uri string|null

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

$className string|null

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

$extraHeaders array

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

Returns
Type Description
mixed A new instance of the current entry with updated data, or null if the server reports that no changes have been made.
Throws
Exception Description
\Zend_Gdata_App_Exception
methodpublicsave( string|null $uri = null, string|null $className = null, array $extraHeaders = array ) : \Zend_Gdata_App_Entry

Uploads changes in this entry to the server using Zend_Gdata_App

Inherited from: \Zend_Gdata_App_Entry::save()
Parameters
Name Type Description
$uri string|null

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

$className string|null

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

$extraHeaders array

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

Returns
Type Description
\Zend_Gdata_App_Entry The updated entry.
Throws
Exception Description
\Zend_Gdata_App_Exception
methodpublicsaveXML( ) : string

Converts this element and all children into XML text using getDOM()

Inherited from: \Zend_Gdata_App_Base::saveXML()
Returns
Type Description
string XML content
methodpublicsetAuthor( array $value ) : \Zend_Gdata_App_FeedEntryParent

Sets the list of the authors of this feed/entry. In an atom feed, each author is represented by an atom:author element

Inherited from: \Zend_Gdata_App_FeedEntryParent::setAuthor()
Parameters
Name Type Description
$value array
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetCategory( array $value ) : \Zend_Gdata_App_FeedEntryParent

Sets the array of categories that classify this feed/entry. Each category is represented in an atom feed by an atom:category element.

Inherited from: \Zend_Gdata_App_FeedEntryParent::setCategory()
Parameters
Name Type Description
$value array Array of Zend_Gdata_App_Extension_Category
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetComments( \Zend_Gdata_Extension_Comments $comments = null ) : \Zend_Gdata_YouTube_VideoEntry

Sets the comments relating to the video.

Parameters
Name Type Description
$comments \Zend_Gdata_Extension_Comments The comments relating to the video
Returns
Type Description
\Zend_Gdata_YouTube_VideoEntry Provides a fluent interface
methodpublicsetContent( \Zend_Gdata_App_Extension_Content $value ) : \Zend_Gdata_App_Entry

Sets the value of the atom:content element

Inherited from: \Zend_Gdata_App_Entry::setContent()
Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Content
Returns
Type Description
\Zend_Gdata_App_Entry Provides a fluent interface
methodpublicsetContributor( array $value ) : \Zend_Gdata_App_FeedEntryParent

Sets the array of contributors to this feed/entry. Each contributor is represented in an atom feed by an atom:contributor XML element

Inherited from: \Zend_Gdata_App_FeedEntryParent::setContributor()
Parameters
Name Type Description
$value array
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetControl( \Zend_Gdata_App_Extension_Control $value ) : \Zend_Gdata_App_Entry

Sets the value of the app:control element

Inherited from: \Zend_Gdata_App_Entry::setControl()
Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Control
Returns
Type Description
\Zend_Gdata_App_Entry Provides a fluent interface
methodpublicsetEtag( string|null $value ) : \Zend_Gdata_App_Entry

Set the Etag for the current entry to $value. Setting $value to null unsets the Etag.

Inherited from: \Zend_Gdata_App_FeedEntryParent::setEtag()
Parameters
Name Type Description
$value string|null
Returns
Type Description
\Zend_Gdata_App_Entry Provides a fluent interface
methodpublicsetExtensionAttributes( array $value ) : \Zend_Gdata_App_Base

Sets an array of all extension attributes not transformed into data model properties during parsing of the XML. 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

Inherited from: \Zend_Gdata_App_Base::setExtensionAttributes()
Parameters
Name Type Description
$value array All extension attributes
Returns
Type Description
\Zend_Gdata_App_Base Returns an object of the same type as 'this' to provide a fluent interface.
methodpublicsetExtensionElements( array $value ) : \Zend_Gdata_App_Base

Sets an array of all elements not matched to data model classes during the parsing of the XML. This method can be used to add arbitrary child XML elements to any data model class.

Inherited from: \Zend_Gdata_App_Base::setExtensionElements()
Parameters
Name Type Description
$value array All extension elements
Returns
Type Description
\Zend_Gdata_App_Base Returns an object of the same type as 'this' to provide a fluent interface.
methodpublicsetFeedLink( array $feedLink = null ) : \Zend_Gdata_YouTube_VideoEntry

Sets the array of embedded feeds related to the video

Parameters
Name Type Description
$feedLink array The array of embedded feeds relating to the video
Returns
Type Description
\Zend_Gdata_YouTube_VideoEntry Provides a fluent interface
methodpublicsetHttpClient( \Zend_Http_Client $httpClient ) : \Zend_Gdata_App_FeedEntryParent

Set the HTTP client instance

Inherited from: \Zend_Gdata_App_FeedEntryParent::setHttpClient()

Sets the HTTP client object to use for retrieving the feed.

Parameters
Name Type Description
$httpClient \Zend_Http_Client
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
Details
deprecated
Deprecated as of Zend Framework 1.7. Use setService() instead.  
methodpublicsetId( \Zend_Gdata_App_Extension_Id $value ) : \Zend_Gdata_App_FeedEntryParent
Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Id
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetLink( array $value ) : \Zend_Gdata_App_FeedEntryParent
Parameters
Name Type Description
$value array The array of Zend_Gdata_App_Extension_Link elements
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetLocation( \Zend_Gdata_YouTube_Extension_Location $location = null ) : \Zend_Gdata_YouTube_VideoEntry

Sets the location information.

Parameters
Name Type Description
$location \Zend_Gdata_YouTube_Extension_Location Where the video was recorded
Returns
Type Description
\Zend_Gdata_YouTube_VideoEntry Provides a fluent interface
methodpublicsetMajorProtocolVersion( \(int|\NULL) $value ) : void

Set the major protocol version that should be used. Values < 1 (excluding NULL) will cause a Zend_Gdata_App_InvalidArgumentException to be thrown.

Inherited from: \Zend_Gdata_App_FeedEntryParent::setMajorProtocolVersion()
Parameters
Name Type Description
$value \(int|\NULL) The major protocol version to use.
Throws
Exception Description
\Zend_Gdata_App_InvalidArgumentException
Details
see
\_majorProtocolVersion  
methodpublicsetMediaGroup( \Zend_Gdata_Media_Extension_MediaGroup $mediaGroup ) : \Zend_Gdata_Media_Entry

Sets the entry's mediaGroup object.

Inherited from: \Zend_Gdata_Media_Entry::setMediaGroup()
Parameters
Name Type Description
$mediaGroup \Zend_Gdata_Media_Extension_MediaGroup
Returns
Type Description
\Zend_Gdata_Media_Entry Provides a fluent interface
methodpublicsetMediaSource( \Zend_Gdata_App_MediaSource $value ) : \Zend_Gdata_App_MediaEntry

Set the MediaSource object (file) for this MediaEntry

Inherited from: \Zend_Gdata_App_MediaEntry::setMediaSource()
Parameters
Name Type Description
$value \Zend_Gdata_App_MediaSource

The attached MediaSource/file

Returns
Type Description
\Zend_Gdata_App_MediaEntry Provides a fluent interface
methodpublicsetMinorProtocolVersion( \(int|\NULL) $value ) : void

Set the minor protocol version that should be used. 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.

Inherited from: \Zend_Gdata_App_FeedEntryParent::setMinorProtocolVersion()
Parameters
Name Type Description
$value \(int|\NULL) The minor protocol version to use.
Throws
Exception Description
\Zend_Gdata_App_InvalidArgumentException
Details
see
\_minorProtocolVersion  
methodpublicsetNoEmbed( \Zend_Gdata_YouTube_Extension_NoEmbed $noEmbed = null ) : \Zend_Gdata_YouTube_VideoEntry

If an instance of Zend_Gdata_YouTube_Extension_NoEmbed is passed in, the video cannot be embedded. Otherwise, if null is passsed in, the video is able to be embedded.

Parameters
Name Type Description
$noEmbed \Zend_Gdata_YouTube_Extension_NoEmbed Whether or not the video can be embedded.
Returns
Type Description
\Zend_Gdata_YouTube_VideoEntry Provides a fluent interface
methodpublicsetPublished( \Zend_Gdata_App_Extension_Published $value ) : \Zend_Gdata_App_Entry

Sets the value of the atom:published element This represents the publishing date for an entry

Inherited from: \Zend_Gdata_App_Entry::setPublished()
Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Published
Returns
Type Description
\Zend_Gdata_App_Entry Provides a fluent interface
methodpublicsetRacy( \Zend_Gdata_YouTube_Extension_Racy $racy = null ) : \Zend_Gdata_YouTube_VideoEntry

Specifies that the video has racy content.

Parameters
Name Type Description
$racy \Zend_Gdata_YouTube_Extension_Racy The racy flag object
Returns
Type Description
\Zend_Gdata_YouTube_VideoEntry Provides a fluent interface
Throws
Exception Description
\Zend_Gdata_App_VersionException
methodpublicsetRating( \Zend_Gdata_Extension_Rating $rating = null ) : \Zend_Gdata_YouTube_VideoEntry

Sets the rating relating to the video.

Parameters
Name Type Description
$rating \Zend_Gdata_Extension_Rating The rating relating to the video
Returns
Type Description
\Zend_Gdata_YouTube_VideoEntry Provides a fluent interface
methodpublicsetRecorded( \Zend_Gdata_YouTube_Extension_Recorded $recorded = null ) : \Zend_Gdata_YouTube_VideoEntry

Sets when the video was recorded.

Parameters
Name Type Description
$recorded \Zend_Gdata_YouTube_Extension_Recorded When the video was recorded
Returns
Type Description
\Zend_Gdata_YouTube_VideoEntry Provides a fluent interface
methodpublicsetRights( \Zend_Gdata_App_Extension_Rights $value ) : \Zend_Gdata_App_FeedEntryParent
Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Rights
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetService( \Zend_Gdata_App $instance ) : \Zend_Gdata_App_FeedEntryParent

Set the active service instance for this object. This will be used to perform network requests, such as when calling save() and delete().

Inherited from: \Zend_Gdata_App_FeedEntryParent::setService()
Parameters
Name Type Description
$instance \Zend_Gdata_App The new service instance.
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface.
methodpublicsetSource( \Zend_Gdata_App_Extension_Source $value ) : \Zend_Gdata_App_Entry

Sets the value of the atom:source element

Inherited from: \Zend_Gdata_App_Entry::setSource()
Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Source
Returns
Type Description
\Zend_Gdata_App_Entry Provides a fluent interface
methodpublicsetStatistics( \Zend_Gdata_YouTube_Extension_Statistics $statistics = null ) : \Zend_Gdata_YouTube_VideoEntry

Sets the statistics relating to the video.

Parameters
Name Type Description
$statistics \Zend_Gdata_YouTube_Extension_Statistics The statistics relating to the video
Returns
Type Description
\Zend_Gdata_YouTube_VideoEntry Provides a fluent interface
methodpublicsetSummary( \Zend_Gdata_App_Extension_Summary $value ) : \Zend_Gdata_App_Entry

Sets the value of the atom:summary element This represents a textual summary of this entry's content

Inherited from: \Zend_Gdata_App_Entry::setSummary()
Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Summary
Returns
Type Description
\Zend_Gdata_App_Entry Provides a fluent interface
methodpublicsetText( string $value ) : \Zend_Gdata_App_Base

Sets the child text node of this element This represents any raw text contained within the XML element

Inherited from: \Zend_Gdata_App_Base::setText()
Parameters
Name Type Description
$value string Child text node
Returns
Type Description
\Zend_Gdata_App_Base Returns an object of the same type as 'this' to provide a fluent interface.
methodpublicsetTitle( \Zend_Gdata_App_Extension_Title $value ) : \Zend_Gdata_App_FeedEntryParent

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

Inherited from: \Zend_Gdata_App_FeedEntryParent::setTitle()
Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Title
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetUpdated( \Zend_Gdata_App_Extension_Updated $value ) : \Zend_Gdata_App_FeedEntryParent
Parameters
Name Type Description
$value \Zend_Gdata_App_Extension_Updated
Returns
Type Description
\Zend_Gdata_App_FeedEntryParent Provides a fluent interface
methodpublicsetVideoCategory( string $category ) : \Zend_Gdata_YouTube_VideoEntry

Sets the category of the video as a string.

Parameters
Name Type Description
$category string Categories for the video
Returns
Type Description
\Zend_Gdata_YouTube_VideoEntry Provides a fluent interface
methodpublicsetVideoDescription( string $description ) : \Zend_Gdata_YouTube_VideoEntry

Sets the description of the video as a string.

Parameters
Name Type Description
$description string Description for the video
Returns
Type Description
\Zend_Gdata_YouTube_VideoEntry Provides a fluent interface
methodpublicsetVideoDeveloperTags( array $developerTags ) : \Zend_Gdata_YouTube_VideoEntry

Set multiple developer tags for the video as strings.

Parameters
Name Type Description
$developerTags array Array of developerTag for the video
Returns
Type Description
\Zend_Gdata_YouTube_VideoEntry Provides a fluent interface
methodpublicsetVideoPrivate( ) : \Zend_Gdata_YouTube_VideoEntry

Sets video to private.

Returns
Type Description
\Zend_Gdata_YouTube_VideoEntry Provides a fluent interface
methodpublicsetVideoPublic( ) : \Zend_Gdata_YouTube_VideoEntry

Sets a private video to be public.

Returns
Type Description
\Zend_Gdata_YouTube_VideoEntry Provides a fluent interface
methodpublicsetVideoRating( integer $ratingValue ) : \Zend_Gdata_YouTube_VideoEntry

Helper function to conveniently set a video's rating.

Parameters
Name Type Description
$ratingValue integer A number representing the rating. Must be between 1 and 5 inclusive.
Returns
Type Description
\Zend_Gdata_YouTube_VideoEntry Provides a fluent interface.
Throws
Exception Description
\Zend_Gdata_Exception
methodpublicsetVideoRecorded( string $recorded ) : void

Sets the date that the video was recorded.

Parameters
Name Type Description
$recorded string

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

methodpublicsetVideoTags( mixed $tags ) : \Zend_Gdata_YouTube_VideoEntry

Sets the keyword tags for a video.

Parameters
Name Type Description
$tags mixed

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

Returns
Type Description
\Zend_Gdata_YouTube_VideoEntry Provides a fluent interface
methodpublicsetVideoTitle( string $title ) : \Zend_Gdata_YouTube_VideoEntry

Sets the title of the video as a string.

Parameters
Name Type Description
$title string Title for the video
Returns
Type Description
\Zend_Gdata_YouTube_VideoEntry Provides a fluent interface
methodpublicsetWhere( \Zend_Gdata_Geo_Extension_GeoRssWhere $value ) : \Zend_Gdata_YouTube_VideoEntry

Sets the georss:where element

Parameters
Name Type Description
$value \Zend_Gdata_Geo_Extension_GeoRssWhere The georss:where class value
Returns
Type Description
\Zend_Gdata_YouTube_VideoEntry Provides a fluent interface
methodprotectedtakeAttributeFromDOM( \DOMNode $attribute ) : void

Given a DOMNode representing an attribute, tries to map the data into instance members. If no mapping is defined, the name and value are stored in an array.

Inherited from: \Zend_Gdata_Entry::takeAttributeFromDOM()
Parameters
Name Type Description
$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.

Parameters
Name Type Description
$child \DOMNode The DOMNode to process
methodpublictransferFromDOM( \DOMNode $node ) : void

Transfers each child and attribute into member variables.

Inherited from: \Zend_Gdata_App_Base::transferFromDOM()

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

Parameters
Name Type Description
$node \DOMNode

The DOMNode that represents this object's data

methodpublictransferFromXML( string $xml ) : void

Parses the provided XML text and generates data model classes for each know element by turning the XML text into a DOM tree and calling transferFromDOM($element). The first data model element with the same name as $this->_rootElement is used and the child elements are recursively parsed.

Inherited from: \Zend_Gdata_App_Base::transferFromXML()
Parameters
Name Type Description
$xml string The XML text to parse
Documentation was generated by DocBlox 0.13.3.