Represents the YouTube video playlist flavor of an Atom entry

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

 Methods

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

__construct(\DOMElement $element = null
inherited_from \Zend_Gdata_YouTube_VideoEntry::__construct()

Parameters

$element

\DOMElement

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

__construct()

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

__get(string $name) 
Inherited

TODO Remove ability to bypass getFoo() methods??

Parameters

$name

string

The variable name sought

Magic __isset method

__isset(string $name) 
Inherited

Parameters

$name

string

Magic setter to allow acces like $entry->foo='bar' to call $entry->setFoo('bar') automatically.

__set(string $name, $val) 
Inherited

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

TODO Remove ability to bypass getFoo() methods??

Parameters

$name

string

$val

Magic toString method allows using this directly via echo Works best in PHP >= 4.2.0

__toString() : string
Inherited

Returns

stringThe text representation of this object

Magic __unset method

__unset(string $name) 
Inherited

Parameters

$name

string

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

addVideoDeveloperTag(string $developerTag) : \Zend_Gdata_YouTube_VideoEntry
Inherited

Parameters

$developerTag

string

DeveloperTag for the video

Returns

\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface

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.

delete() : void
Inherited

Exceptions

\Zend_Gdata_App_Exception

Alias for saveXML()

encode() : string
Inherited

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

Returns

stringEncoded string content

Get the VideoEntry's Zend_Gdata_YouTube_Extension_MediaGroup object.

ensureMediaGroupIsNotNull() : void
Inherited

If the mediaGroup does not exist, then set it.

Flush namespace lookup cache.

flushNamespaceLookupCache() 
InheritedStatic

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

getAuthor()

getAuthor() : \Zend_Gdata_App_Extension_Author
Inherited

Returns

\Zend_Gdata_App_Extension_Author

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

getCategory() : array
Inherited

Returns

arrayArray of Zend_Gdata_App_Extension_Category

Returns the comments relating to the video.

getComments() : \Zend_Gdata_Extension_Comments
Inherited

Returns

\Zend_Gdata_Extension_CommentsThe comments relating to the video

Gets the value of the atom:content element

getContent() : \Zend_Gdata_App_Extension_Content
Inherited

Returns

\Zend_Gdata_App_Extension_Content

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

getContributor() : array
Inherited

Returns

arrayAn array of Zend_Gdata_App_Extension_Contributor

Gets the value of the app:control element

getControl() : \Zend_Gdata_App_Extension_Control
Inherited

Returns

\Zend_Gdata_App_Extension_Control

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.

getDOM(\DOMDocument $doc = null, $majorVersion = 1, $minorVersion = null) : \DOMElement
inherited_from \Zend_Gdata_YouTube_VideoEntry::getDOM()

Parameters

$doc

\DOMDocument

The DOMDocument used to construct DOMElements

$majorVersion

$minorVersion

Returns

\DOMElementThe DOMElement representing this element and all child properties.

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.

getDOM(\DOMDocument $doc = null, $majorVersion = 1, $minorVersion = null) : \DOMElement
Inherited

Parameters

$doc

\DOMDocument

The DOMDocument used to construct DOMElements

$majorVersion

$minorVersion

Returns

\DOMElementThe DOMElement representing this element and all child properties.

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

getEtag() : string | null
Inherited

Returns

stringnull

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

getExtensionAttributes() : array
Inherited

Returns

arrayAll extension attributes

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

getExtensionElements() : array
Inherited

Returns

arrayAll elements not matched to data model classes during parsing

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

getFlashPlayerUrl() : string | null
Inherited

Returns

stringnullThe URL of the flash player SWF

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

getHttpClient() : \Zend_Http_Client_Abstract
Inherited
deprecated Deprecated as of Zend Framework 1.7. Use getService() instead.

Returns

\Zend_Http_Client_Abstract

getId()

getId() : \Zend_Gdata_App_Extension_Id
Inherited

Returns

\Zend_Gdata_App_Extension_Id

Gets the location where the video was recorded.

getLocation() : \Zend_Gdata_YouTube_Extension_Location | null
Inherited

Returns

\Zend_Gdata_YouTube_Extension_Locationnull

Get the major protocol version that is in use.

getMajorProtocolVersion() : \(int | \NULL)
Inherited
see

Returns

\(int\NULL)The major protocol version in use.

Returns the entry's mediaGroup object.

getMediaGroup() : \Zend_Gdata_Media_Extension_MediaGroup
Inherited

Returns

\Zend_Gdata_Media_Extension_MediaGroup

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

getMediaSource() : \Zend_Gdata_App_MediaSource
Inherited

Returns

\Zend_Gdata_App_MediaSourceThe attached MediaSource/file

Get the minor protocol version that is in use.

getMinorProtocolVersion() : \(int | \NULL)
Inherited
see

Returns

\(int\NULL)The major protocol version in use, or NULL if no minor version is specified.

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

getNoEmbed() : \Zend_Gdata_YouTube_Extension_NoEmbed | null
Inherited

Returns

\Zend_Gdata_YouTube_Extension_NoEmbednullWhether or not the video can be embedded

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

getPosition() : \Zend_Gdata_YouTube_Extension_Position

Returns

\Zend_Gdata_YouTube_Extension_PositionThe position

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

getPublished() : \Zend_Gdata_App_Extension_Published
Inherited

Returns

\Zend_Gdata_App_Extension_Published

Returns the racy flag object.

getRacy() : \Zend_Gdata_YouTube_Extension_Racy | null
Inherited

Exceptions

\Zend_Gdata_App_VersionException

Returns

\Zend_Gdata_YouTube_Extension_RacynullThe racy flag object

Returns the rating relating to the video.

getRating() : \Zend_Gdata_Extension_Rating
Inherited

Returns

\Zend_Gdata_Extension_RatingThe rating relating to the video

Gets the date that the video was recorded.

getRecorded() : \Zend_Gdata_YouTube_Extension_Recorded | null
Inherited

Returns

\Zend_Gdata_YouTube_Extension_Recordednull

getRights()

getRights() : \Zend_Gdata_AppExtension_Rights
Inherited

Returns

\Zend_Gdata_AppExtension_Rights

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

getService() : \Zend_Gdata_App | null
Inherited

Returns

\Zend_Gdata_AppnullThe current service instance, or null if not set.

Gets the value of the atom:source element

getSource() : \Zend_Gdata_App_Extension_Source
Inherited

Returns

\Zend_Gdata_App_Extension_Source

Returns the statistics relating to the video.

getStatistics() : \Zend_Gdata_YouTube_Extension_Statistics
Inherited

Returns

\Zend_Gdata_YouTube_Extension_StatisticsThe statistics relating to the video

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

getSummary() : \Zend_Gdata_App_Extension_Summary
Inherited

Returns

\Zend_Gdata_App_Extension_Summary

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

getText($trim = true) : string
Inherited

Parameters

$trim

Returns

stringChild text node

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

getTitle() : \Zend_Gdata_App_Extension_Title
Inherited

Returns

\Zend_Gdata_App_Extension_Title

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

getTitleValue() : string
Inherited

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

string

getUpdated()

getUpdated() : \Zend_Gdata_App_Extension_Updated
Inherited

Returns

\Zend_Gdata_App_Extension_Updated

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.

getVideoCategory() : string | null
Inherited

Returns

stringnullThe category of this video

Retrieve the URL for a video's comment feed.

getVideoCommentFeedUrl() : string | null
Inherited

Returns

stringnullThe URL if found, or null if not found.

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

getVideoDescription() : string | null
Inherited

Returns

stringnullThe description of the video

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.

getVideoDeveloperTags() : array | null
Inherited

If no tags are set, null is returned.

Returns

arraynullThe developer tags for this video or null if none were set.

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

getVideoDuration() : string | null
Inherited

Returns

stringnullThe duration of the video, in seconds.

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

getVideoGeoLocation() : array | null
Inherited

null is returned if the location is not available.

Returns

arraynullThe location specified for this video

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

getVideoId() : string
Inherited

Returns

stringThe video ID

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

getVideoRatingInfo() : array | null
Inherited

null is returned if the rating information is not available.

Returns

arraynullThe rating information for this video

Gets the date that the video was recorded.

getVideoRecorded() : string | null
Inherited

Returns

stringnullThe date that the video was recorded

Get the current publishing state of the video.

getVideoState() : \Zend_Gdata_YouTube_Extension_State | null
Inherited

Returns

\Zend_Gdata_YouTube_Extension_StatenullThe publishing state of this video

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.

getVideoTags() : array
Inherited

Returns

arrayAn array of the tags assigned to this video

Gets an array of the thumbnails representing the video.

getVideoThumbnails() : array
Inherited

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

arrayAn array of video thumbnails.

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

getVideoTitle() : string | null
Inherited

Returns

stringnullThe title of the video

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

getVideoViewCount() : string | null
Inherited

Returns

stringnullThe number of views for this video

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

getVideoWatchPageUrl() : string | null
Inherited

Returns

stringnullThe URL of the YouTube video watch page

Gets the georss:where element

getWhere() : \Zend_Gdata_Geo_Extension_GeoRssWhere
Inherited

Returns

\Zend_Gdata_Geo_Extension_GeoRssWhere

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

getXML() : string
Inherited

Returns

stringXML content

Checks whether the video is embeddable.

isVideoEmbeddable() : boolean
Inherited

Returns

booleanReturns true if the video is embeddable.

Checks whether the video is private.

isVideoPrivate() : boolean
Inherited

Returns

booleanReturn true if video is private

Get the full version of a namespace prefix

lookupNamespace(string $prefix, integer $majorVersion = 1, integer $minorVersion = null) : string
Inherited

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.

Parameters

$prefix

string

The namespace prefix to lookup.

$majorVersion

integer

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

$minorVersion

integer

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

Returns

string

Add an array of namespaces to the registered list.

registerAllNamespaces(array $namespaceArray) : void
Inherited

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

$namespaceArray

array

An array of namespaces.

Add a namespace and prefix to the registered list

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

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

$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).

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.

reload($uri = null, $className = null, array $extraHeaders = array()) : mixed
Inherited

Parameters

$uri

$className

$extraHeaders

array

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

Exceptions

\Zend_Gdata_App_Exception

Returns

mixedA new instance of the current entry with updated data, or null if the server reports that no changes have been made.

Uploads changes in this entry to the server using Zend_Gdata_App

save(string|null $uri = null, string|null $className = null, array $extraHeaders = array()) : \Zend_Gdata_App_Entry
Inherited

Parameters

$uri

stringnull

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

$className

stringnull

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.

Exceptions

\Zend_Gdata_App_Exception

Returns

\Zend_Gdata_App_EntryThe updated entry.

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

saveXML() : string
Inherited

Returns

stringXML content

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

setAuthor(array $value) : \Zend_Gdata_App_FeedEntryParent
Inherited

Parameters

$value

array

Returns

\Zend_Gdata_App_FeedEntryParentProvides a fluent interface

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

setCategory(array $value) : \Zend_Gdata_App_FeedEntryParent
Inherited

Parameters

$value

array

Array of Zend_Gdata_App_Extension_Category

Returns

\Zend_Gdata_App_FeedEntryParentProvides a fluent interface

Sets the comments relating to the video.

setComments(\Zend_Gdata_Extension_Comments $comments = null) : \Zend_Gdata_YouTube_VideoEntry
Inherited

Parameters

$comments

\Zend_Gdata_Extension_Comments

The comments relating to the video

Returns

\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface

Sets the value of the atom:content element

setContent(\Zend_Gdata_App_Extension_Content $value) : \Zend_Gdata_App_Entry
Inherited

Parameters

$value

\Zend_Gdata_App_Extension_Content

Returns

\Zend_Gdata_App_EntryProvides a fluent interface

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

setContributor(array $value) : \Zend_Gdata_App_FeedEntryParent
Inherited

Parameters

$value

array

Returns

\Zend_Gdata_App_FeedEntryParentProvides a fluent interface

Sets the value of the app:control element

setControl(\Zend_Gdata_App_Extension_Control $value) : \Zend_Gdata_App_Entry
Inherited

Parameters

$value

\Zend_Gdata_App_Extension_Control

Returns

\Zend_Gdata_App_EntryProvides a fluent interface

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

setEtag(string|null $value) : \Zend_Gdata_App_Entry
Inherited

Parameters

$value

stringnull

Returns

\Zend_Gdata_App_EntryProvides a fluent interface

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

setExtensionAttributes(array $value) : \Zend_Gdata_App_Base
Inherited

Parameters

$value

array

All extension attributes

Returns

\Zend_Gdata_App_BaseReturns an object of the same type as 'this' to provide a fluent interface.

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.

setExtensionElements(array $value) : \Zend_Gdata_App_Base
Inherited

Parameters

$value

array

All extension elements

Returns

\Zend_Gdata_App_BaseReturns an object of the same type as 'this' to provide a fluent interface.

Set the HTTP client instance

setHttpClient(\Zend_Http_Client $httpClient) : \Zend_Gdata_App_FeedEntryParent
Inherited

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

deprecated Deprecated as of Zend Framework 1.7. Use setService() instead.

Parameters

$httpClient

\Zend_Http_Client

Returns

\Zend_Gdata_App_FeedEntryParentProvides a fluent interface

setId()

setId(\Zend_Gdata_App_Extension_Id $value) : \Zend_Gdata_App_FeedEntryParent
Inherited

Parameters

$value

\Zend_Gdata_App_Extension_Id

Returns

\Zend_Gdata_App_FeedEntryParentProvides a fluent interface

Sets the location information.

setLocation(\Zend_Gdata_YouTube_Extension_Location $location = null) : \Zend_Gdata_YouTube_VideoEntry
Inherited

Parameters

$location

\Zend_Gdata_YouTube_Extension_Location

Where the video was recorded

Returns

\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface

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

setMajorProtocolVersion(\(int|\NULL) $value) 
Inherited
see

Parameters

$value

\(int\NULL)

The major protocol version to use.

Exceptions

\Zend_Gdata_App_InvalidArgumentException

Sets the entry's mediaGroup object.

setMediaGroup(\Zend_Gdata_Media_Extension_MediaGroup $mediaGroup) : \Zend_Gdata_Media_Entry
Inherited

Parameters

$mediaGroup

\Zend_Gdata_Media_Extension_MediaGroup

Returns

\Zend_Gdata_Media_EntryProvides a fluent interface

Set the MediaSource object (file) for this MediaEntry

setMediaSource(\Zend_Gdata_App_MediaSource $value) : \Zend_Gdata_App_MediaEntry
Inherited

Parameters

$value

\Zend_Gdata_App_MediaSource

The attached MediaSource/file

Returns

\Zend_Gdata_App_MediaEntryProvides a fluent interface

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.

setMinorProtocolVersion(\(int|\NULL) $value) 
Inherited
see

Parameters

$value

\(int\NULL)

The minor protocol version to use.

Exceptions

\Zend_Gdata_App_InvalidArgumentException

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.

setNoEmbed(\Zend_Gdata_YouTube_Extension_NoEmbed $noEmbed = null) : \Zend_Gdata_YouTube_VideoEntry
Inherited

Parameters

$noEmbed

\Zend_Gdata_YouTube_Extension_NoEmbed

Whether or not the video can be embedded.

Returns

\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface

Sets the array of embedded feeds related to the video

setPosition(\Zend_Gdata_YouTube_Extension_Position $position = null) : \Zend_Gdata_YouTube_PlaylistVideoEntry

Parameters

$position

\Zend_Gdata_YouTube_Extension_Position

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

Returns

\Zend_Gdata_YouTube_PlaylistVideoEntryProvides a fluent interface

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

setPublished(\Zend_Gdata_App_Extension_Published $value) : \Zend_Gdata_App_Entry
Inherited

Parameters

$value

\Zend_Gdata_App_Extension_Published

Returns

\Zend_Gdata_App_EntryProvides a fluent interface

Specifies that the video has racy content.

setRacy(\Zend_Gdata_YouTube_Extension_Racy $racy = null) : \Zend_Gdata_YouTube_VideoEntry
Inherited

Parameters

$racy

\Zend_Gdata_YouTube_Extension_Racy

The racy flag object

Exceptions

\Zend_Gdata_App_VersionException

Returns

\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface

Sets the rating relating to the video.

setRating(\Zend_Gdata_Extension_Rating $rating = null) : \Zend_Gdata_YouTube_VideoEntry
Inherited

Parameters

$rating

\Zend_Gdata_Extension_Rating

The rating relating to the video

Returns

\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface

Sets when the video was recorded.

setRecorded(\Zend_Gdata_YouTube_Extension_Recorded $recorded = null) : \Zend_Gdata_YouTube_VideoEntry
Inherited

Parameters

$recorded

\Zend_Gdata_YouTube_Extension_Recorded

When the video was recorded

Returns

\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface

setRights()

setRights(\Zend_Gdata_App_Extension_Rights $value) : \Zend_Gdata_App_FeedEntryParent
Inherited

Parameters

$value

\Zend_Gdata_App_Extension_Rights

Returns

\Zend_Gdata_App_FeedEntryParentProvides a fluent interface

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

setService(\Zend_Gdata_App $instance) : \Zend_Gdata_App_FeedEntryParent
Inherited

Parameters

$instance

\Zend_Gdata_App

The new service instance.

Returns

\Zend_Gdata_App_FeedEntryParentProvides a fluent interface.

Sets the value of the atom:source element

setSource(\Zend_Gdata_App_Extension_Source $value) : \Zend_Gdata_App_Entry
Inherited

Parameters

$value

\Zend_Gdata_App_Extension_Source

Returns

\Zend_Gdata_App_EntryProvides a fluent interface

Sets the statistics relating to the video.

setStatistics(\Zend_Gdata_YouTube_Extension_Statistics $statistics = null) : \Zend_Gdata_YouTube_VideoEntry
Inherited

Parameters

$statistics

\Zend_Gdata_YouTube_Extension_Statistics

The statistics relating to the video

Returns

\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface

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

setSummary(\Zend_Gdata_App_Extension_Summary $value) : \Zend_Gdata_App_Entry
Inherited

Parameters

$value

\Zend_Gdata_App_Extension_Summary

Returns

\Zend_Gdata_App_EntryProvides a fluent interface

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

setText(string $value) : \Zend_Gdata_App_Base
Inherited

Parameters

$value

string

Child text node

Returns

\Zend_Gdata_App_BaseReturns an object of the same type as 'this' to provide a fluent interface.

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

setTitle(\Zend_Gdata_App_Extension_Title $value) : \Zend_Gdata_App_FeedEntryParent
Inherited

Parameters

$value

\Zend_Gdata_App_Extension_Title

Returns

\Zend_Gdata_App_FeedEntryParentProvides a fluent interface

setUpdated()

setUpdated(\Zend_Gdata_App_Extension_Updated $value) : \Zend_Gdata_App_FeedEntryParent
Inherited

Parameters

$value

\Zend_Gdata_App_Extension_Updated

Returns

\Zend_Gdata_App_FeedEntryParentProvides a fluent interface

Sets the category of the video as a string.

setVideoCategory(string $category) : \Zend_Gdata_YouTube_VideoEntry
Inherited

Parameters

$category

string

Categories for the video

Returns

\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface

Sets the description of the video as a string.

setVideoDescription(string $description) : \Zend_Gdata_YouTube_VideoEntry
Inherited

Parameters

$description

string

Description for the video

Returns

\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface

Set multiple developer tags for the video as strings.

setVideoDeveloperTags(array $developerTags) : \Zend_Gdata_YouTube_VideoEntry
Inherited

Parameters

$developerTags

array

Array of developerTag for the video

Returns

\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface

Sets video to private.

setVideoPrivate() : \Zend_Gdata_YouTube_VideoEntry
Inherited

Returns

\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface

Sets a private video to be public.

setVideoPublic() : \Zend_Gdata_YouTube_VideoEntry
Inherited

Returns

\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface

Helper function to conveniently set a video's rating.

setVideoRating(integer $ratingValue) : \Zend_Gdata_YouTube_VideoEntry
Inherited

Parameters

$ratingValue

integer

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

Exceptions

\Zend_Gdata_Exception

Returns

\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface.

Sets the date that the video was recorded.

setVideoRecorded(string $recorded) 
Inherited

Parameters

$recorded

string

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

Sets the keyword tags for a video.

setVideoTags(mixed $tags) : \Zend_Gdata_YouTube_VideoEntry
Inherited

Parameters

$tags

mixed

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

Returns

\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface

Sets the title of the video as a string.

setVideoTitle(string $title) : \Zend_Gdata_YouTube_VideoEntry
Inherited

Parameters

$title

string

Title for the video

Returns

\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface

Sets the georss:where element

setWhere(\Zend_Gdata_Geo_Extension_GeoRssWhere $value) : \Zend_Gdata_YouTube_VideoEntry
Inherited

Parameters

$value

\Zend_Gdata_Geo_Extension_GeoRssWhere

The georss:where class value

Returns

\Zend_Gdata_YouTube_VideoEntryProvides a fluent interface

Transfers each child and attribute into member variables.

transferFromDOM(\DOMNode $node) 
Inherited

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

Parameters

$node

\DOMNode

The DOMNode that represents this object's data

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.

transferFromXML(string $xml) 
Inherited

Parameters

$xml

string

The XML text to parse

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.

takeAttributeFromDOM(\DOMNode $attribute) 
Inherited

Parameters

$attribute

\DOMNode

The DOMNode attribute needed to be handled

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

takeChildFromDOM(\DOMNode $child) 
inherited_from \Zend_Gdata_YouTube_VideoEntry::takeChildFromDOM()

Parameters

$child

\DOMNode

The DOMNode to process

Given a child DOMNode, tries to determine how to map the data into object instance members. If no mapping is defined, Extension_Element objects are created and stored in an array.

takeChildFromDOM(\DOMNode $child) 
Inherited

Parameters

$child

\DOMNode

The DOMNode needed to be handled

 Properties

 

$_author

$_author 

Default

array()
 

$_category

$_category 

Default

array()
 

Specifies the comments associated with a video.

$_comments : \Zend_Gdata_Extensions_Comments

Default

null
 

atom:content element

$_content : \Zend_Gdata_App_Extension_Content

Default

null
 

$_contributor

$_contributor 

Default

array()
 

app:control element

$_control : \Zend_Gdata_App_Extension_Control

Default

null
 

app:edited element

$_edited : \Zend_Gdata_App_Extension_Edited

Default

null
 

$_entryClassName

$_entryClassName 

Default

'Zend_Gdata_YouTube_PlaylistVideoEntry'
inherited_from \Zend_Gdata_YouTube_VideoEntry::_entryClassName
 

Class name for each entry in this feed*

$_entryClassName : string

Default

'Zend_Gdata_App_Entry'
 

The HTTP ETag associated with this entry. Used for optimistic concurrency in protoco v2 or greater.

$_etag : string | null

Default

NULL
 

Leftover attributes which were not handled

$_extensionAttributes : array

Default

array()
 

Leftover elements which were not handled

$_extensionElements : array

Default

array()
   

$_id

$_id 

Default

null
   

Location informtion for the video

$_location : \Zend_Gdata_YouTube_Extension_Location | null

Default

null
 

Indicates the major protocol version that should be used.

$_majorProtocolVersion 

Default

1

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

see
see
 

media:group element

$_mediaGroup : \Zend_Gdata_Media_Extension_MediaGroup

Default

null
 

The attached MediaSource/file

$_mediaSource : \Zend_Gdata_App_MediaSource

Default

null
 

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

$_minorProtocolVersion 

Default

null
see
see
 

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

$_namespaceLookupCache : array

Default

array()
Static
 

List of namespaces, as a three-dimensional array. 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.

$_namespaces : array

Default

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

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.

see
see
see
 

If null, the video can be embedded

$_noEmbed : \Zend_Gdata_YouTube_Extension_NoEmbed | null

Default

null
 

Position of the entry in the feed, as specified by the user

$_position : \Zend_Gdata_YouTube_Extension_Position

Default

null
 

If not null, specifies that the video is private.

$_private : \Zend_Gdata_YouTube_Extension_Private | null

Default

null
 

atom:published element

$_published : \Zend_Gdata_App_Extension_Published

Default

null
 

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

$_racy : \Zend_Gdata_YouTube_Extension_Racy | null

Default

null
 

Specifies the video's rating.

$_rating : \Zend_Gdata_Extension_Rating

Default

null
 

Recording date for the video

$_recorded : \Zend_Gdata_YouTube_Extension_Recorded | null

Default

null
 

$_rights

$_rights 

Default

null
 

The XML element name, including prefix if desired

$_rootElement : string

Default

null
 

The XML namespace prefix

$_rootNamespace : string

Default

'atom'
 

The XML namespace URI - takes precedence over lookup up the corresponding URI for $_rootNamespace

$_rootNamespaceURI : string

Default

null
 

Service instance used to make network requests.

$_service 

Default

null
 

atom:source element

$_source : \Zend_Gdata_App_Extension_Source

Default

null
 

Specifies the statistics relating to the video.

$_statistics : \Zend_Gdata_YouTube_Extension_Statistics

Default

null
 

atom:summary element

$_summary : \Zend_Gdata_App_Extension_Summary

Default

null
 

XML child text node content

$_text : string

Default

null
 

$_title

$_title 

Default

null
 

$_updated

$_updated 

Default

null
 

Geo location for the video

$_where : \Zend_Gdata_Geo_Extension_GeoRssWhere

Default

null

 Constants

 

YOUTUBE_CATEGORY_SCHEMA

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

YOUTUBE_DEVELOPER_TAGS_SCHEMA

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