From 06f945f27840b53e57795dadbc38e76f7e11ab1c Mon Sep 17 00:00:00 2001 From: Horus3 Date: Mon, 24 Feb 2014 16:42:14 +0100 Subject: init --- .../api/core/files/Gdata.YouTube.VideoEntry.html | 857 +++++++++++++++++++++ 1 file changed, 857 insertions(+) create mode 100644 zend/documentation/api/core/files/Gdata.YouTube.VideoEntry.html (limited to 'zend/documentation/api/core/files/Gdata.YouTube.VideoEntry.html') diff --git a/zend/documentation/api/core/files/Gdata.YouTube.VideoEntry.html b/zend/documentation/api/core/files/Gdata.YouTube.VideoEntry.html new file mode 100644 index 0000000..1f24b2e --- /dev/null +++ b/zend/documentation/api/core/files/Gdata.YouTube.VideoEntry.html @@ -0,0 +1,857 @@ + +Zend Gdata API Documentation

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

\Zend_Gdata_YouTube_VideoEntry

Package: Zend\Gdata\YouTube
Represents the YouTube video flavor of an Atom entry
Parent(s)
\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
Children
\Zend_Gdata_YouTube_PlaylistVideoEntry
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
Specifies the comments associated with a video.
Default valuenullDetails
Type
\Zend_Gdata_Extensions_Comments
>VPropertyprotectedstring $_entryClassName = 'Zend_Gdata_YouTube_VideoEntry'
Class name for each entry in this feed*
Default value'Zend_Gdata_YouTube_VideoEntry'Details
Type
string
>VPropertyprotectedstring|null $_etag = NULL

Used for optimistic +concurrency in protoco v2 or greater.

Default valueNULLDetails
Type
string | null
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_etag +   +
Inherited_from
\Zend_Gdata_App_Entry::$$_etag +   +
Inherited_from
\Zend_Gdata_App_MediaEntry::$$_etag +   +
Inherited_from
\Zend_Gdata_Entry::$$_etag +   +
Inherited_from
\Zend_Gdata_Media_Entry::$$_etag +   +
Inherited_from
\Zend_Gdata_YouTube_MediaEntry::$$_etag +   +
>VPropertyprotectedarray $_feedLink = array()
Nested feed links
Default valuearray()Details
Type
array
>VPropertyprotected\Zend_Gdata_YouTube_Extension_Location|null $_location = null
Location informtion for the video
Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_Location | null
>VPropertyprotected$_majorProtocolVersion = 1

At present, recognized values are either 1 or 2. However, any integer +value >= 1 is considered valid.

Default value1Details
Type
n/a
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_majorProtocolVersion +   +
Inherited_from
\Zend_Gdata_App_Entry::$$_majorProtocolVersion +   +
Inherited_from
\Zend_Gdata_App_MediaEntry::$$_majorProtocolVersion +   +
Inherited_from
\Zend_Gdata_Entry::$$_majorProtocolVersion +   +
Inherited_from
\Zend_Gdata_Media_Entry::$$_majorProtocolVersion +   +
Inherited_from
\Zend_Gdata_YouTube_MediaEntry::$$_majorProtocolVersion +   +
See
\setMajorProtocolVersion() +   +
See
\getMajorProtocolVersion() +   +
>VPropertyprotected\Zend_Gdata_YouTube_Extension_MediaGroup $_mediaGroup = null
inherited
media:group element
Inherited from: + \Zend_Gdata_YouTube_MediaEntry::$$_mediaGroup
>VPropertyprotected$_minorProtocolVersion = null

Can be set +to either an integer >= 0, or NULL if no minor version should be sent +to the server.

Default valuenullDetails
Type
n/a
Inherited_from
\Zend_Gdata_App_FeedEntryParent::$$_minorProtocolVersion +   +
Inherited_from
\Zend_Gdata_App_Entry::$$_minorProtocolVersion +   +
Inherited_from
\Zend_Gdata_App_MediaEntry::$$_minorProtocolVersion +   +
Inherited_from
\Zend_Gdata_Entry::$$_minorProtocolVersion +   +
Inherited_from
\Zend_Gdata_Media_Entry::$$_minorProtocolVersion +   +
Inherited_from
\Zend_Gdata_YouTube_MediaEntry::$$_minorProtocolVersion +   +
See
\setMinorProtocolVersion() +   +
See
\getMinorProtocolVersion() +   +
>VPropertyprotectedarray $_namespaceLookupCache = array()
staticinherited

Memoized results from calls to lookupNamespace() to avoid expensive calls to getGreatestBoundedValue(). The key is in the form 'prefix-majorVersion-minorVersion', and the value is the output from getGreatestBoundedValue().

+
Inherited from: + \Zend_Gdata_App_Base::$$_namespaceLookupCache\Zend_Gdata_App_FeedEntryParent::$$_namespaceLookupCache\Zend_Gdata_App_Entry::$$_namespaceLookupCache\Zend_Gdata_App_MediaEntry::$$_namespaceLookupCache\Zend_Gdata_Entry::$$_namespaceLookupCache\Zend_Gdata_Media_Entry::$$_namespaceLookupCache\Zend_Gdata_YouTube_MediaEntry::$$_namespaceLookupCache
>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 +   +
See
\lookupNamespace() +   +
See
\registerNamespace() +   +
See
\registerAllNamespaces() +   +
>VPropertyprotected\Zend_Gdata_YouTube_Extension_NoEmbed|null $_noEmbed = null
If null, the video can be embedded
Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_NoEmbed | null
>VPropertyprotected\Zend_Gdata_YouTube_Extension_Private|null $_private = null
If not null, specifies that the video is private.
Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_Private | null
>VPropertyprotected\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_Racy | null
>VPropertyprotected\Zend_Gdata_Extension_Rating $_rating = null
Specifies the video's rating.
Default valuenullDetails
Type
\Zend_Gdata_Extension_Rating
>VPropertyprotected\Zend_Gdata_YouTube_Extension_Recorded|null $_recorded = null
Recording date for the video
Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_Recorded | null
>VPropertyprotected\Zend_Gdata_YouTube_Extension_Statistics $_statistics = null
Specifies the statistics relating to the video.
Default valuenullDetails
Type
\Zend_Gdata_YouTube_Extension_Statistics
>VPropertyprotected\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
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()

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
methodpublic__toString() : string
Returns
TypeDescription
stringThe text representation of this object
methodpublicaddVideoDeveloperTag(string $developerTag) : \Zend_Gdata_YouTube_VideoEntry

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

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

Get the VideoEntry's Zend_Gdata_YouTube_Extension_MediaGroup object.

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

Returns the comments relating to the video.

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
methodpublicgetEtag() : string | null
Returns
TypeDescription
string | null
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
methodpublicgetExtensionElements() : array
Returns
TypeDescription
arrayAll elements not matched to data model classes during parsing
methodpublicgetFeedLink(string $rel = null) : mixed

Get the feed link property for this entry.

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

Gets the URL of the flash player SWF.

null is returned if the +duration value is not available.

Returns
TypeDescription
string | nullThe URL of the flash player SWF
methodpublicgetHttpClient() : \Zend_Http_Client_Abstract

If none is set, a new Zend_Http_Client +will be used.

Returns
TypeDescription
\Zend_Http_Client_Abstract
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

Gets the location where the video was recorded.

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_Location | null
methodpublicgetMajorProtocolVersion() : \(int | \NULL)
Returns
TypeDescription
\(int | \NULL)The major protocol version in use.
Details
See
\_majorProtocolVersion +   +
methodpublicgetMediaSource() : \Zend_Gdata_App_MediaSource
Returns
TypeDescription
\Zend_Gdata_App_MediaSourceThe attached MediaSource/file
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
inherited

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.

Inherited from: + \Zend_Gdata_App_FeedEntryParent::getNextLink()\Zend_Gdata_App_Entry::getNextLink()\Zend_Gdata_App_MediaEntry::getNextLink()\Zend_Gdata_Entry::getNextLink()\Zend_Gdata_Media_Entry::getNextLink()\Zend_Gdata_YouTube_MediaEntry::getNextLink()

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

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

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_NoEmbed | nullWhether or not the video can be embedded
methodpublicgetPreviousLink() : \Zend_Gdata_App_Extension_Link
inherited

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.

Inherited from: + \Zend_Gdata_App_FeedEntryParent::getPreviousLink()\Zend_Gdata_App_Entry::getPreviousLink()\Zend_Gdata_App_MediaEntry::getPreviousLink()\Zend_Gdata_Entry::getPreviousLink()\Zend_Gdata_Media_Entry::getPreviousLink()\Zend_Gdata_YouTube_MediaEntry::getPreviousLink()

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

Returns the racy flag object.

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_Racy | nullThe racy flag object
Throws
ExceptionDescription
\Zend_Gdata_App_VersionException
methodpublicgetRating() : \Zend_Gdata_Extension_Rating

Returns the rating relating to the video.

Returns
TypeDescription
\Zend_Gdata_Extension_RatingThe rating relating to the video
methodpublicgetRecorded() : \Zend_Gdata_YouTube_Extension_Recorded | null

Gets the date that the video was recorded.

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

Returns the statistics relating to the video.

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

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
TypeDescription
string | nullThe category of this video
methodpublicgetVideoCommentFeedUrl() : string | null

Retrieve the URL for a video's comment feed.

Returns
TypeDescription
string | nullThe URL if found, or null if not found.
methodpublicgetVideoComplaintsLink() : \Zend_Gdata_App_Extension_Link

Returns the link element relating to video complaints.

Returns
TypeDescription
\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
TypeDescription
string | nullThe 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
TypeDescription
array | nullThe 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
TypeDescription
string | nullThe 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
TypeDescription
array | nullThe location specified for this video
methodpublicgetVideoId() : string

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

Returns
TypeDescription
stringThe 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
TypeDescription
array | nullThe rating information for this video
methodpublicgetVideoRatingsLink() : \Zend_Gdata_App_Extension_Link

Returns the link element relating to video ratings.

Returns
TypeDescription
\Zend_Gdata_App_Extension_Link
methodpublicgetVideoRecorded() : string | null

Gets the date that the video was recorded.

Returns
TypeDescription
string | nullThe date that the video was recorded
methodpublicgetVideoResponsesLink() : \Zend_Gdata_App_Extension_Link

Returns the link element relating to video responses.

Returns
TypeDescription
\Zend_Gdata_App_Extension_Link
methodpublicgetVideoState() : \Zend_Gdata_YouTube_Extension_State | null

Get the current publishing state of the video.

Returns
TypeDescription
\Zend_Gdata_YouTube_Extension_State | nullThe 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
TypeDescription
arrayAn 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
TypeDescription
arrayAn 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
TypeDescription
string | nullThe 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
TypeDescription
string | nullThe 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
TypeDescription
string | nullThe URL of the YouTube video watch page
methodpublicgetWhere() : \Zend_Gdata_Geo_Extension_GeoRssWhere

Gets the georss:where element

methodpublicisVideoEmbeddable() : bool

Checks whether the video is embeddable.

Returns
TypeDescription
boolReturns true if the video is embeddable.
methodpublicisVideoPrivate() : bool

Checks whether the video is private.

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

Sets the comments relating to the video.

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

Sets the array of embedded feeds related to the video

Parameters
NameTypeDescription
$feedLinkarray

The array of embedded feeds relating to the video

Returns
TypeDescription
\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface
methodpublicsetHttpClient(\Zend_Http_Client $httpClient) : \Zend_Gdata_App_FeedEntryParent

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

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

The array of Zend_Gdata_App_Extension_Link elements

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

Sets the location information.

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
inherited

Sets the entry's mediaGroup object.

Inherited from: + \Zend_Gdata_Media_Entry::setMediaGroup()\Zend_Gdata_YouTube_MediaEntry::setMediaGroup()
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

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
NameTypeDescription
$noEmbed\Zend_Gdata_YouTube_Extension_NoEmbed

Whether or not the + video can be embedded.

Returns
TypeDescription
\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface
methodpublicsetPublished(\Zend_Gdata_App_Extension_Published $value) : \Zend_Gdata_App_Entry
Parameters
NameTypeDescription
$value\Zend_Gdata_App_Extension_Published
Returns
TypeDescription
\Zend_Gdata_App_EntryProvides a fluent interface
methodpublicsetRacy(\Zend_Gdata_YouTube_Extension_Racy $racy = null) : \Zend_Gdata_YouTube_VideoEntry

Specifies that the video has racy content.

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

Sets the rating relating to the video.

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

Sets when the video was recorded.

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

Sets the statistics relating to the video.

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
inherited

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()\Zend_Gdata_App_MediaEntry::setSummary()\Zend_Gdata_Entry::setSummary()\Zend_Gdata_Media_Entry::setSummary()\Zend_Gdata_YouTube_MediaEntry::setSummary()
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

Sets the category of the video as a string.

Parameters
NameTypeDescription
$categorystring

Categories for the video

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

Sets the description of the video as a string.

Parameters
NameTypeDescription
$descriptionstring

Description for the video

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

Set multiple developer tags for the video as strings.

Parameters
NameTypeDescription
$developerTagsarray

Array of developerTag for the video

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

Sets video to private.

Returns
TypeDescription
\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface
methodpublicsetVideoPublic() : \Zend_Gdata_YouTube_VideoEntry

Sets a private video to be public.

Returns
TypeDescription
\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface
methodpublicsetVideoRating(integer $ratingValue) : \Zend_Gdata_YouTube_VideoEntry

Helper function to conveniently set a video's rating.

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

Sets the date that the video was recorded.

Parameters
NameTypeDescription
$recordedstring

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

Sets the title of the video as a string.

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

Sets the georss:where element

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
inherited

Given a DOMNode representing an attribute, tries to map the data into +instance members.

Inherited from: + \Zend_Gdata_Entry::takeAttributeFromDOM()\Zend_Gdata_Media_Entry::takeAttributeFromDOM()\Zend_Gdata_YouTube_MediaEntry::takeAttributeFromDOM()

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. + -- cgit v1.2.3