Inheritance diagram for Zend_Gdata_YouTube_VideoEntry:

Collaboration diagram for Zend_Gdata_YouTube_VideoEntry:

Public Member Functions
	__construct ($element=null)
	getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
	setRecorded ($recorded=null)
	getRecorded ()
	setLocation ($location=null)
	getLocation ()
	setNoEmbed ($noEmbed=null)
	getNoEmbed ()
	isVideoEmbeddable ()
	setStatistics ($statistics=null)
	getStatistics ()
	setRacy ($racy=null)
	getRacy ()
	setRating ($rating=null)
	getRating ()
	setComments ($comments=null)
	getComments ()
	setFeedLink ($feedLink=null)
	getFeedLink ($rel=null)
	getVideoResponsesLink ()
	getVideoRatingsLink ()
	getVideoComplaintsLink ()
	getVideoId ()
	getVideoRecorded ()
	setVideoRecorded ($recorded)
	getWhere ()
	setWhere ($value)
	getVideoTitle ()
	setVideoTitle ($title)
	setVideoDescription ($description)
	getVideoDescription ()
	getVideoWatchPageUrl ()
	getVideoThumbnails ()
	getFlashPlayerUrl ()
	getVideoDuration ()
	isVideoPrivate ()
	setVideoPrivate ()
	setVideoPublic ()
	getVideoTags ()
	setVideoTags ($tags)
	getVideoViewCount ()
	getVideoGeoLocation ()
	getVideoRatingInfo ()
	getVideoCategory ()
	setVideoCategory ($category)
	getVideoDeveloperTags ()
	addVideoDeveloperTag ($developerTag)
	setVideoDeveloperTags ($developerTags)
	getVideoState ()
	ensureMediaGroupIsNotNull ()
	setVideoRating ($ratingValue)
	getVideoCommentFeedUrl ()
Data Fields
const	YOUTUBE_DEVELOPER_TAGS_SCHEMA = 'http://gdata.youtube.com/schemas/2007/developertags.cat'
const	YOUTUBE_CATEGORY_SCHEMA = 'http://gdata.youtube.com/schemas/2007/categories.cat'
Protected Member Functions
	takeChildFromDOM ($child)
Protected Attributes
	$_entryClassName = 'Zend_Gdata_YouTube_VideoEntry'
	$_noEmbed = null
	$_statistics = null
	$_racy = null
	$_private = null
	$_rating = null
	$_comments = null
	$_feedLink = array()
	$_where = null
	$_recorded = null
	$_location = null

Detailed Description

Definition at line 98 of file VideoEntry.php.

Constructor & Destructor Documentation

__construct ( $ element = null )

Creates a Video entry, representing an individual video

Parameters:

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

Reimplemented from Zend_Gdata_Media_Entry.

Reimplemented in Zend_Gdata_YouTube_PlaylistVideoEntry.

Definition at line 181 of file VideoEntry.php.

Here is the call graph for this function:

Member Function Documentation

addVideoDeveloperTag ( $ developerTag )

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

Parameters:

string $developerTag DeveloperTag for the video

Returns:: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

Definition at line 994 of file VideoEntry.php.

Here is the call graph for this function:

Here is the caller graph for this function:

ensureMediaGroupIsNotNull ( )

Get the VideoEntry's Zend_Gdata_YouTube_Extension_MediaGroup object. If the mediaGroup does not exist, then set it.

Returns:: void

Definition at line 1047 of file VideoEntry.php.

Here is the caller graph for this function:

getComments ( )

Returns the comments relating to the video.

Returns:: Zend_Gdata_Extension_Comments The comments relating to the video

Definition at line 496 of file VideoEntry.php.

Here is the caller graph for this function:

getDOM	(	$	doc = `null`,
		$	majorVersion = `1`,
		$	minorVersion = `null`
	)

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:

DOMDocument $doc The DOMDocument used to construct DOMElements

Returns:: DOMElement The DOMElement representing this element and all child properties.

Reimplemented from Zend_Gdata_Media_Entry.

Reimplemented in Zend_Gdata_YouTube_PlaylistVideoEntry.

Definition at line 197 of file VideoEntry.php.

getFeedLink ( $ rel = null )

Get the feed link property for this entry.

See also:: setFeedLink

Parameters:

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

Returns:: 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.

Definition at line 526 of file VideoEntry.php.

getFlashPlayerUrl ( )

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

Returns:: string|null The URL of the flash player SWF

Definition at line 758 of file VideoEntry.php.

Here is the call graph for this function:

getLocation ( )

Gets the location where the video was recorded.

Returns:: Zend_Gdata_YouTube_Extension_Location|null

Definition at line 353 of file VideoEntry.php.

getNoEmbed ( )

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

Returns:: Zend_Gdata_YouTube_Extension_NoEmbed|null Whether or not the video can be embedded

Definition at line 379 of file VideoEntry.php.

Here is the caller graph for this function:

getRacy ( )

Returns the racy flag object.

Exceptions:

Zend_Gdata_App_VersionException

Returns:: Zend_Gdata_YouTube_Extension_Racy|null The racy flag object

Definition at line 446 of file VideoEntry.php.

Here is the call graph for this function:

getRating ( )

Returns the rating relating to the video.

Returns:: Zend_Gdata_Extension_Rating The rating relating to the video

Definition at line 474 of file VideoEntry.php.

Here is the caller graph for this function:

getRecorded ( )

Gets the date that the video was recorded.

Returns:: Zend_Gdata_YouTube_Extension_Recorded|null

Definition at line 330 of file VideoEntry.php.

Here is the caller graph for this function:

getStatistics ( )

Returns the statistics relating to the video.

Returns:: Zend_Gdata_YouTube_Extension_Statistics The statistics relating to the video

Definition at line 415 of file VideoEntry.php.

Here is the caller graph for this function:

getVideoCategory ( )

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:: string|null The category of this video

Definition at line 934 of file VideoEntry.php.

Here is the call graph for this function:

getVideoCommentFeedUrl ( )

Retrieve the URL for a video's comment feed.

Returns:: string|null The URL if found, or null if not found.

Definition at line 1082 of file VideoEntry.php.

Here is the call graph for this function:

getVideoComplaintsLink ( )

Returns the link element relating to video complaints.

Returns:: Zend_Gdata_App_Extension_Link

Definition at line 565 of file VideoEntry.php.

Here is the call graph for this function:

getVideoDescription ( )

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

Returns:: string|null The description of the video

Definition at line 694 of file VideoEntry.php.

Here is the call graph for this function:

getVideoDeveloperTags ( )

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:: array|null The developer tags for this video or null if none were set.

Definition at line 969 of file VideoEntry.php.

Here is the call graph for this function:

getVideoDuration ( )

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

Returns:: string|null The duration of the video, in seconds.

Definition at line 775 of file VideoEntry.php.

Here is the call graph for this function:

getVideoGeoLocation ( )

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:: array|null The location specified for this video

Definition at line 886 of file VideoEntry.php.

Here is the call graph for this function:

getVideoId ( )

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

Returns:: string The video ID

Definition at line 575 of file VideoEntry.php.

Here is the call graph for this function:

getVideoRatingInfo ( )

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:: array|null The rating information for this video

Definition at line 914 of file VideoEntry.php.

Here is the call graph for this function:

getVideoRatingsLink ( )

Returns the link element relating to video ratings.

Returns:: Zend_Gdata_App_Extension_Link

Definition at line 555 of file VideoEntry.php.

Here is the call graph for this function:

getVideoRecorded ( )

Gets the date that the video was recorded.

Returns:: string|null The date that the video was recorded

Definition at line 598 of file VideoEntry.php.

Here is the call graph for this function:

getVideoResponsesLink ( )

Returns the link element relating to video responses.

Returns:: Zend_Gdata_App_Extension_Link

Definition at line 545 of file VideoEntry.php.

Here is the call graph for this function:

getVideoState ( )

Get the current publishing state of the video.

Returns:: Zend_Gdata_YouTube_Extension_State|null The publishing state of this video

Definition at line 1029 of file VideoEntry.php.

Here is the call graph for this function:

getVideoTags ( )

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:: array An array of the tags assigned to this video

Definition at line 831 of file VideoEntry.php.

Here is the call graph for this function:

getVideoThumbnails ( )

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:: array An array of video thumbnails.

Definition at line 731 of file VideoEntry.php.

Here is the call graph for this function:

getVideoTitle ( )

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

Returns:: string|null The title of the video

Definition at line 649 of file VideoEntry.php.

Here is the call graph for this function:

getVideoViewCount ( )

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

Returns:: string|null The number of views for this video

Definition at line 870 of file VideoEntry.php.

Here is the call graph for this function:

getVideoWatchPageUrl ( )

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

Returns:: string|null The URL of the YouTube video watch page

Definition at line 710 of file VideoEntry.php.

Here is the call graph for this function:

getWhere ( )

Gets the georss:where element

Returns:: Zend_Gdata_Geo_Extension_GeoRssWhere

Definition at line 626 of file VideoEntry.php.

Here is the caller graph for this function:

isVideoEmbeddable ( )

Checks whether the video is embeddable.

Returns:: bool Returns true if the video is embeddable.

Definition at line 389 of file VideoEntry.php.

Here is the call graph for this function:

isVideoPrivate ( )

Checks whether the video is private.

Returns:: bool Return true if video is private

Definition at line 790 of file VideoEntry.php.

Here is the call graph for this function:

setComments ( $ comments = null )

Sets the comments relating to the video.

Parameters:

Zend_Gdata_Extension_Comments $comments The comments relating to the video

Returns:: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

Definition at line 485 of file VideoEntry.php.

setFeedLink ( $ feedLink = null )

Sets the array of embedded feeds related to the video

Parameters:

array $feedLink The array of embedded feeds relating to the video

Returns:: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

Definition at line 507 of file VideoEntry.php.

setLocation ( $ location = null )

Sets the location information.

Parameters:

Zend_Gdata_YouTube_Extension_Location $location Where the video was recorded

Returns:: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

Definition at line 342 of file VideoEntry.php.

setNoEmbed ( $ noEmbed = null )

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:

Zend_Gdata_YouTube_Extension_NoEmbed $noEmbed Whether or not the video can be embedded.

Returns:: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

Definition at line 367 of file VideoEntry.php.

setRacy ( $ racy = null )

Specifies that the video has racy content.

Parameters:

Zend_Gdata_YouTube_Extension_Racy $racy The racy flag object

Exceptions:

Zend_Gdata_App_VersionException

Returns:: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

Definition at line 427 of file VideoEntry.php.

Here is the call graph for this function:

setRating ( $ rating = null )

Sets the rating relating to the video.

Parameters:

Zend_Gdata_Extension_Rating $rating The rating relating to the video

Returns:: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

Definition at line 463 of file VideoEntry.php.

Here is the caller graph for this function:

setRecorded ( $ recorded = null )

Sets when the video was recorded.

Parameters:

Zend_Gdata_YouTube_Extension_Recorded $recorded When the video was recorded

Returns:: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

Definition at line 319 of file VideoEntry.php.

Here is the caller graph for this function:

setStatistics ( $ statistics = null )

Sets the statistics relating to the video.

Parameters:

Zend_Gdata_YouTube_Extension_Statistics $statistics The statistics relating to the video

Returns:: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

Definition at line 404 of file VideoEntry.php.

setVideoCategory ( $ category )

Sets the category of the video as a string.

Parameters:

string $category Categories for the video

Returns:: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

Definition at line 954 of file VideoEntry.php.

Here is the call graph for this function:

setVideoDescription ( $ description )

Sets the description of the video as a string.

Parameters:

string $description Description for the video

Returns:: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

Definition at line 679 of file VideoEntry.php.

Here is the call graph for this function:

setVideoDeveloperTags ( $ developerTags )

Set multiple developer tags for the video as strings.

Parameters:

array $developerTags Array of developerTag for the video

Returns:: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

Definition at line 1015 of file VideoEntry.php.

Here is the call graph for this function:

setVideoPrivate ( )

Sets video to private.

Returns:: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

Definition at line 805 of file VideoEntry.php.

Here is the call graph for this function:

setVideoPublic ( )

Sets a private video to be public.

Returns:: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

Definition at line 817 of file VideoEntry.php.

Here is the call graph for this function:

setVideoRating ( $ ratingValue )

Helper function to conveniently set a video's rating.

Parameters:

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

Exceptions:

Zend_Gdata_Exception

Returns:: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface.

Definition at line 1062 of file VideoEntry.php.

Here is the call graph for this function:

setVideoRecorded ( $ recorded )

Sets the date that the video was recorded.

Parameters:

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

Definition at line 614 of file VideoEntry.php.

Here is the call graph for this function:

setVideoTags ( $ tags )

Sets the keyword tags for a video.

Parameters:

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

Returns:: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

Definition at line 852 of file VideoEntry.php.

Here is the call graph for this function:

setVideoTitle ( $ title )

Sets the title of the video as a string.

Parameters:

string $title Title for the video

Returns:: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

Definition at line 665 of file VideoEntry.php.

Here is the call graph for this function:

setWhere ( $ value )

Sets the georss:where element

Parameters:

Zend_Gdata_Geo_Extension_GeoRssWhere $value The georss:where class value

Returns:: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

Definition at line 637 of file VideoEntry.php.

takeChildFromDOM ( $ child ) [protected]

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

Parameters:

DOMNode $child The DOMNode to process

Reimplemented from Zend_Gdata_YouTube_MediaEntry.

Reimplemented in Zend_Gdata_YouTube_PlaylistVideoEntry.

Definition at line 247 of file VideoEntry.php.

Here is the call graph for this function:

Field Documentation

$_comments = null [protected]

Definition at line 145 of file VideoEntry.php.

$_entryClassName = 'Zend_Gdata_YouTube_VideoEntry' [protected]

Reimplemented from Zend_Gdata_YouTube_MediaEntry.

Reimplemented in Zend_Gdata_YouTube_PlaylistVideoEntry.

Definition at line 103 of file VideoEntry.php.

$_feedLink = array() [protected]

Definition at line 152 of file VideoEntry.php.

$_location = null [protected]

Definition at line 173 of file VideoEntry.php.

$_noEmbed = null [protected]

Definition at line 110 of file VideoEntry.php.

$_private = null [protected]

Definition at line 131 of file VideoEntry.php.

$_racy = null [protected]

Definition at line 124 of file VideoEntry.php.

$_rating = null [protected]

Definition at line 138 of file VideoEntry.php.

$_recorded = null [protected]

Definition at line 166 of file VideoEntry.php.

$_statistics = null [protected]

Definition at line 117 of file VideoEntry.php.

$_where = null [protected]

Definition at line 159 of file VideoEntry.php.

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

Definition at line 102 of file VideoEntry.php.

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

Definition at line 101 of file VideoEntry.php.

The documentation for this class was generated from the following file:

C:/xampp/htdocs/moodle/lib/zend/Zend/Gdata/YouTube/VideoEntry.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Field Documentation