[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/zend/Zend/Gdata/YouTube/ -> VideoEntry.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
Version: $Id$
File Size: 1095 lines (34 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Zend_Gdata_YouTube_VideoEntry:: (53 methods):
  __construct()
  getDOM()
  takeChildFromDOM()
  setRecorded()
  getRecorded()
  setLocation()
  getLocation()
  setNoEmbed()
  getNoEmbed()
  isVideoEmbeddable()
  setStatistics()
  getStatistics()
  setRacy()
  getRacy()
  setRating()
  getRating()
  setComments()
  getComments()
  setFeedLink()
  getFeedLink()
  getVideoResponsesLink()
  getVideoRatingsLink()
  getVideoComplaintsLink()
  getVideoId()
  getVideoRecorded()
  setVideoRecorded()
  getWhere()
  setWhere()
  getVideoTitle()
  setVideoTitle()
  setVideoDescription()
  getVideoDescription()
  getVideoWatchPageUrl()
  getVideoThumbnails()
  getFlashPlayerUrl()
  getVideoDuration()
  isVideoPrivate()
  setVideoPrivate()
  setVideoPublic()
  getVideoTags()
  setVideoTags()
  getVideoViewCount()
  getVideoGeoLocation()
  getVideoRatingInfo()
  getVideoCategory()
  setVideoCategory()
  getVideoDeveloperTags()
  addVideoDeveloperTag()
  setVideoDeveloperTags()
  getVideoState()
  ensureMediaGroupIsNotNull()
  setVideoRating()
  getVideoCommentFeedUrl()


Class: Zend_Gdata_YouTube_VideoEntry  - X-Ref

Represents the YouTube video flavor of an Atom entry

__construct($element = null)   X-Ref
Creates a Video entry, representing an individual video

param: DOMElement $element (optional) DOMElement from which this

getDOM($doc = null, $majorVersion = 1, $minorVersion = null)   X-Ref
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.

param: DOMDocument $doc The DOMDocument used to construct DOMElements
return: DOMElement The DOMElement representing this element and all

takeChildFromDOM($child)   X-Ref
Creates individual Entry objects of the appropriate type and
stores them in the $_entry array based upon DOM data.

param: DOMNode $child The DOMNode to process

setRecorded($recorded = null)   X-Ref
Sets when the video was recorded.

param: Zend_Gdata_YouTube_Extension_Recorded $recorded When the video was recorded
return: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

getRecorded()   X-Ref
Gets the date that the video was recorded.

return: Zend_Gdata_YouTube_Extension_Recorded|null

setLocation($location = null)   X-Ref
Sets the location information.

param: Zend_Gdata_YouTube_Extension_Location $location Where the video
return: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

getLocation()   X-Ref
Gets the location where the video was recorded.

return: Zend_Gdata_YouTube_Extension_Location|null

setNoEmbed($noEmbed = null)   X-Ref
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.

param: Zend_Gdata_YouTube_Extension_NoEmbed $noEmbed Whether or not the
return: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

getNoEmbed()   X-Ref
If the return value is an instance of
Zend_Gdata_YouTube_Extension_NoEmbed, this video cannot be embedded.

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

isVideoEmbeddable()   X-Ref
Checks whether the video is embeddable.

return: bool Returns true if the video is embeddable.

setStatistics($statistics = null)   X-Ref
Sets the statistics relating to the video.

param: Zend_Gdata_YouTube_Extension_Statistics $statistics The statistics relating to the video
return: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

getStatistics()   X-Ref
Returns the statistics relating to the video.

return: Zend_Gdata_YouTube_Extension_Statistics  The statistics relating to the video

setRacy($racy = null)   X-Ref
Specifies that the video has racy content.

param: Zend_Gdata_YouTube_Extension_Racy $racy The racy flag object
return: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

getRacy()   X-Ref
Returns the racy flag object.

return: Zend_Gdata_YouTube_Extension_Racy|null  The racy flag object

setRating($rating = null)   X-Ref
Sets the rating relating to the video.

param: Zend_Gdata_Extension_Rating $rating The rating relating to the video
return: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

getRating()   X-Ref
Returns the rating relating to the video.

return: Zend_Gdata_Extension_Rating  The rating relating to the video

setComments($comments = null)   X-Ref
Sets the comments relating to the video.

param: Zend_Gdata_Extension_Comments $comments The comments relating to the video
return: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

getComments()   X-Ref
Returns the comments relating to the video.

return: Zend_Gdata_Extension_Comments  The comments relating to the video

setFeedLink($feedLink = null)   X-Ref
Sets the array of embedded feeds related to the video

param: array $feedLink The array of embedded feeds relating to the video
return: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

getFeedLink($rel = null)   X-Ref
Get the feed link property for this entry.

param: string $rel (optional) The rel value of the link to be found.
return: mixed If $rel is specified, a Zend_Gdata_Extension_FeedLink

getVideoResponsesLink()   X-Ref
Returns the link element relating to video responses.

return: Zend_Gdata_App_Extension_Link

getVideoRatingsLink()   X-Ref
Returns the link element relating to video ratings.

return: Zend_Gdata_App_Extension_Link

getVideoComplaintsLink()   X-Ref
Returns the link element relating to video complaints.

return: Zend_Gdata_App_Extension_Link

getVideoId()   X-Ref
Gets the YouTube video ID based upon the atom:id value

return: string The video ID

getVideoRecorded()   X-Ref
Gets the date that the video was recorded.

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

setVideoRecorded($recorded)   X-Ref
Sets the date that the video was recorded.

param: string $recorded The date that the video was recorded, in the

getWhere()   X-Ref
Gets the georss:where element

return: Zend_Gdata_Geo_Extension_GeoRssWhere

setWhere($value)   X-Ref
Sets the georss:where element

param: Zend_Gdata_Geo_Extension_GeoRssWhere $value The georss:where class value
return: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

getVideoTitle()   X-Ref
Gets the title of the video as a string.  null is returned
if the video title is not available.

return: string|null The title of the video

setVideoTitle($title)   X-Ref
Sets the title of the video as a string.

param: string $title Title for the video
return: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

setVideoDescription($description)   X-Ref
Sets the description of the video as a string.

param: string $description Description for the video
return: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

getVideoDescription()   X-Ref
Gets the description  of the video as a string.  null is returned
if the video description is not available.

return: string|null The description of the video

getVideoWatchPageUrl()   X-Ref
Gets the URL of the YouTube video watch page.  null is returned
if the video watch page URL is not available.

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

getVideoThumbnails()   X-Ref
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.

return: array An array of video thumbnails.

getFlashPlayerUrl()   X-Ref
Gets the URL of the flash player SWF.  null is returned if the
duration value is not available.

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

getVideoDuration()   X-Ref
Gets the duration of the video, in seconds.  null is returned
if the duration value is not available.

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

isVideoPrivate()   X-Ref
Checks whether the video is private.

return: bool Return true if video is private

setVideoPrivate()   X-Ref
Sets video to private.

return: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

setVideoPublic()   X-Ref
Sets a private video to be public.

return: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

getVideoTags()   X-Ref
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.

return: array An array of the tags assigned to this video

setVideoTags($tags)   X-Ref
Sets the keyword tags for a video.

param: mixed $tags Either a comma-separated string or an array
return: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

getVideoViewCount()   X-Ref
Gets the number of views for this video.  null is returned if the
number of views is not available.

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

getVideoGeoLocation()   X-Ref
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.

return: array|null The location specified for this video

getVideoRatingInfo()   X-Ref
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.

return: array|null The rating information for this video

getVideoCategory()   X-Ref
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.

return: string|null The category of this video

setVideoCategory($category)   X-Ref
Sets the category of the video as a string.

param: string $category Categories for the video
return: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

getVideoDeveloperTags()   X-Ref
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.

return: array|null The developer tags for this video or null if none were set.

addVideoDeveloperTag($developerTag)   X-Ref
Adds a developer tag to array of tags for the video.

param: string $developerTag DeveloperTag for the video
return: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

setVideoDeveloperTags($developerTags)   X-Ref
Set multiple developer tags for the video as strings.

param: array $developerTags Array of developerTag for the video
return: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface

getVideoState()   X-Ref
Get the current publishing state of the video.

return: Zend_Gdata_YouTube_Extension_State|null The publishing state of this video

ensureMediaGroupIsNotNull()   X-Ref
Get the VideoEntry's Zend_Gdata_YouTube_Extension_MediaGroup object.
If the mediaGroup does not exist, then set it.

return: void

setVideoRating($ratingValue)   X-Ref
Helper function to conveniently set a video's rating.

param: integer $ratingValue A number representing the rating. Must
return: Zend_Gdata_YouTube_VideoEntry Provides a fluent interface.

getVideoCommentFeedUrl()   X-Ref
Retrieve the URL for a video's comment feed.

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



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1