Class Zend_Gdata_YouTube_VideoEntry

Description

Represents the YouTube video flavor of an Atom entry

  • copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Gdata/YouTube/VideoEntry.php (line 98)

Zend_Gdata_App_Base
   |
   --Zend_Gdata_App_FeedEntryParent
      |
      --Zend_Gdata_App_Entry
         |
         --Zend_Gdata_App_MediaEntry
            |
            --Zend_Gdata_Entry
               |
               --Zend_Gdata_Media_Entry
                  |
                  --Zend_Gdata_YouTube_MediaEntry
                     |
                     --Zend_Gdata_YouTube_VideoEntry
Direct descendents
Class Description
 class Zend_Gdata_YouTube_PlaylistVideoEntry Represents the YouTube video playlist flavor of an Atom entry
Class Constant Summary
 YOUTUBE_CATEGORY_SCHEMA = 'http://gdata.youtube.com/schemas/2007/categories.cat'
 YOUTUBE_DEVELOPER_TAGS_SCHEMA = 'http://gdata.youtube.com/schemas/2007/developertags.cat'
Variable Summary
Method Summary
 Zend_Gdata_YouTube_VideoEntry __construct ([DOMElement $element = null])
 DOMElement getDOM ([DOMDocument $doc = null], [ $majorVersion = 1], [ $minorVersion = null])
 mixed getFeedLink ([string $rel = null])
 string|null getFlashPlayerUrl ()
 string|null getVideoCategory ()
 string|null getVideoCommentFeedUrl ()
 string|null getVideoDescription ()
 array|null getVideoDeveloperTags ()
 string|null getVideoDuration ()
 array|null getVideoGeoLocation ()
 string getVideoId ()
 array|null getVideoRatingInfo ()
 string|null getVideoRecorded ()
 array getVideoTags ()
 string|null getVideoTitle ()
 string|null getVideoViewCount ()
 string|null getVideoWatchPageUrl ()
 bool isVideoPrivate ()
 Zend_Gdata_YouTube_VideoEntry setFeedLink ([array $feedLink = null])
 void setVideoRecorded (string $recorded)
 void takeChildFromDOM (DOMNode $child)
Variables
Zend_Gdata_Extensions_Comments $_comments = null (line 145)

Specifies the comments associated with a video.

  • access: protected
mixed $_entryClassName = 'Zend_Gdata_YouTube_VideoEntry' (line 103)
  • access: protected

Redefinition of:
Zend_Gdata_YouTube_MediaEntry::$_entryClassName

Redefined in descendants as:
array $_feedLink = array() (line 152)

Nested feed links

  • access: protected
Zend_Gdata_YouTube_Extension_Location|null $_location = null (line 173)

Location informtion for the video

  • access: protected
Zend_Gdata_YouTube_Extension_NoEmbed|null $_noEmbed = null (line 110)

If null, the video can be embedded

  • access: protected
Zend_Gdata_YouTube_Extension_Private|null $_private = null (line 131)

If not null, specifies that the video is private.

  • access: protected
Zend_Gdata_YouTube_Extension_Racy|null $_racy = null (line 124)

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

  • access: protected
Zend_Gdata_Extension_Rating $_rating = null (line 138)

Specifies the video's rating.

  • access: protected
Zend_Gdata_YouTube_Extension_Recorded|null $_recorded = null (line 166)

Recording date for the video

  • access: protected
Zend_Gdata_YouTube_Extension_Statistics $_statistics = null (line 117)

Specifies the statistics relating to the video.

  • access: protected
Zend_Gdata_Geo_Extension_GeoRssWhere $_where = null (line 159)

Geo location for the video

  • access: protected

Inherited Variables

Inherited from Zend_Gdata_YouTube_MediaEntry

Zend_Gdata_YouTube_MediaEntry::$_mediaGroup

Inherited from Zend_Gdata_App_MediaEntry

Zend_Gdata_App_MediaEntry::$_mediaSource

Inherited from Zend_Gdata_App_Entry

Zend_Gdata_App_Entry::$_content
Zend_Gdata_App_Entry::$_control
Zend_Gdata_App_Entry::$_edited
Zend_Gdata_App_Entry::$_published
Zend_Gdata_App_Entry::$_rootElement
Zend_Gdata_App_Entry::$_source
Zend_Gdata_App_Entry::$_summary

Inherited from Zend_Gdata_App_FeedEntryParent

Zend_Gdata_App_FeedEntryParent::$_author
Zend_Gdata_App_FeedEntryParent::$_category
Zend_Gdata_App_FeedEntryParent::$_contributor
Zend_Gdata_App_FeedEntryParent::$_etag
Zend_Gdata_App_FeedEntryParent::$_id
Zend_Gdata_App_FeedEntryParent::$_link
Zend_Gdata_App_FeedEntryParent::$_majorProtocolVersion
Zend_Gdata_App_FeedEntryParent::$_minorProtocolVersion
Zend_Gdata_App_FeedEntryParent::$_rights
Zend_Gdata_App_FeedEntryParent::$_service
Zend_Gdata_App_FeedEntryParent::$_title
Zend_Gdata_App_FeedEntryParent::$_updated

Inherited from Zend_Gdata_App_Base

Zend_Gdata_App_Base::$_extensionAttributes
Zend_Gdata_App_Base::$_extensionElements
Zend_Gdata_App_Base::$_namespaceLookupCache
Zend_Gdata_App_Base::$_namespaces
Zend_Gdata_App_Base::$_rootNamespace
Zend_Gdata_App_Base::$_rootNamespaceURI
Zend_Gdata_App_Base::$_text
Methods
Constructor __construct (line 181)

Creates a Video entry, representing an individual video

  • access: public
Zend_Gdata_YouTube_VideoEntry __construct ([DOMElement $element = null])
  • DOMElement $element: (optional) DOMElement from which this object should be constructed.

Redefinition of:
Zend_Gdata_Media_Entry::__construct()
Create a new instance.

Redefined in descendants as:
addVideoDeveloperTag (line 994)

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

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_YouTube_VideoEntry addVideoDeveloperTag (string $developerTag)
  • string $developerTag: DeveloperTag for the video
ensureMediaGroupIsNotNull (line 1047)

Get the VideoEntry's Zend_Gdata_YouTube_Extension_MediaGroup object.

If the mediaGroup does not exist, then set it.

  • access: public
void ensureMediaGroupIsNotNull ()
getComments (line 496)

Returns the comments relating to the video.

  • return: The comments relating to the video
  • access: public
getDOM (line 197)

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.

  • return: The DOMElement representing this element and all child properties.
  • access: public
DOMElement getDOM ([DOMDocument $doc = null], [ $majorVersion = 1], [ $minorVersion = null])
  • DOMDocument $doc: The DOMDocument used to construct DOMElements
  • $majorVersion
  • $minorVersion

Redefinition of:
Zend_Gdata_Media_Entry::getDOM()
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 application storage/persistence.

Redefined in descendants as:
  • Zend_Gdata_YouTube_PlaylistVideoEntry::getDOM() : 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.
getFeedLink (line 526)

Get the feed link property for this entry.

  • return: 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.
  • see: Zend_Gdata_YouTube_VideoEntry::setFeedLink()
  • access: public
mixed getFeedLink ([string $rel = null])
  • string $rel: (optional) The rel value of the link to be found. If null, the array of links is returned.
getFlashPlayerUrl (line 758)

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

  • return: The URL of the flash player SWF
  • access: public
string|null getFlashPlayerUrl ()
getLocation (line 353)

Gets the location where the video was recorded.

  • access: public
getNoEmbed (line 379)

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

  • return: Whether or not the video can be embedded
  • access: public
getRacy (line 446)

Returns the racy flag object.

  • return: The racy flag object
  • throws: Zend_Gdata_App_VersionException
  • access: public
getRating (line 474)

Returns the rating relating to the video.

  • return: The rating relating to the video
  • access: public
getRecorded (line 330)

Gets the date that the video was recorded.

  • access: public
getStatistics (line 415)

Returns the statistics relating to the video.

  • return: The statistics relating to the video
  • access: public
getVideoCategory (line 934)

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: The category of this video
  • access: public
string|null getVideoCategory ()
getVideoCommentFeedUrl (line 1082)

Retrieve the URL for a video's comment feed.

  • return: The URL if found, or null if not found.
  • access: public
string|null getVideoCommentFeedUrl ()
getVideoComplaintsLink (line 565)

Returns the link element relating to video complaints.

  • access: public
Zend_Gdata_App_Extension_Link getVideoComplaintsLink ()
getVideoDescription (line 694)

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

  • return: The description of the video
  • access: public
string|null getVideoDescription ()
getVideoDeveloperTags (line 969)

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: The developer tags for this video or null if none were set.
  • access: public
array|null getVideoDeveloperTags ()
getVideoDuration (line 775)

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

  • return: The duration of the video, in seconds.
  • access: public
string|null getVideoDuration ()
getVideoGeoLocation (line 886)

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: The location specified for this video
  • access: public
array|null getVideoGeoLocation ()
getVideoId (line 575)

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

  • return: The video ID
  • access: public
string getVideoId ()
getVideoRatingInfo (line 914)

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: The rating information for this video
  • access: public
array|null getVideoRatingInfo ()
getVideoRatingsLink (line 555)

Returns the link element relating to video ratings.

  • access: public
Zend_Gdata_App_Extension_Link getVideoRatingsLink ()
getVideoRecorded (line 598)

Gets the date that the video was recorded.

  • return: The date that the video was recorded
  • access: public
string|null getVideoRecorded ()
getVideoResponsesLink (line 545)

Returns the link element relating to video responses.

  • access: public
Zend_Gdata_App_Extension_Link getVideoResponsesLink ()
getVideoState (line 1029)

Get the current publishing state of the video.

  • return: The publishing state of this video
  • access: public
Zend_Gdata_YouTube_Extension_State|null getVideoState ()
getVideoTags (line 831)

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: An array of the tags assigned to this video
  • access: public
array getVideoTags ()
getVideoThumbnails (line 731)

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: An array of video thumbnails.
  • access: public
array getVideoThumbnails ()
getVideoTitle (line 649)

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

  • return: The title of the video
  • access: public
string|null getVideoTitle ()
getVideoViewCount (line 870)

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

  • return: The number of views for this video
  • access: public
string|null getVideoViewCount ()
getVideoWatchPageUrl (line 710)

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

  • return: The URL of the YouTube video watch page
  • access: public
string|null getVideoWatchPageUrl ()
getWhere (line 626)

Gets the georss:where element

  • access: public
isVideoEmbeddable (line 389)

Checks whether the video is embeddable.

  • return: Returns true if the video is embeddable.
  • access: public
bool isVideoEmbeddable ()
isVideoPrivate (line 790)

Checks whether the video is private.

  • return: Return true if video is private
  • access: public
bool isVideoPrivate ()
setComments (line 485)

Sets the comments relating to the video.

  • return: Provides a fluent interface
  • access: public
setFeedLink (line 507)

Sets the array of embedded feeds related to the video

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_YouTube_VideoEntry setFeedLink ([array $feedLink = null])
  • array $feedLink: The array of embedded feeds relating to the video
setLocation (line 342)

Sets the location information.

  • return: Provides a fluent interface
  • access: public
setNoEmbed (line 367)

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.

  • return: Provides a fluent interface
  • access: public
setRacy (line 427)

Specifies that the video has racy content.

  • return: Provides a fluent interface
  • throws: Zend_Gdata_App_VersionException
  • access: public
setRating (line 463)

Sets the rating relating to the video.

  • return: Provides a fluent interface
  • access: public
setRecorded (line 319)

Sets when the video was recorded.

  • return: Provides a fluent interface
  • access: public
setStatistics (line 404)

Sets the statistics relating to the video.

  • return: Provides a fluent interface
  • access: public
setVideoCategory (line 954)

Sets the category of the video as a string.

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_YouTube_VideoEntry setVideoCategory (string $category)
  • string $category: Categories for the video
setVideoDescription (line 679)

Sets the description of the video as a string.

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_YouTube_VideoEntry setVideoDescription (string $description)
  • string $description: Description for the video
setVideoDeveloperTags (line 1015)

Set multiple developer tags for the video as strings.

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_YouTube_VideoEntry setVideoDeveloperTags (array $developerTags)
  • array $developerTags: Array of developerTag for the video
setVideoPrivate (line 805)

Sets video to private.

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_YouTube_VideoEntry setVideoPrivate ()
setVideoPublic (line 817)

Sets a private video to be public.

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_YouTube_VideoEntry setVideoPublic ()
setVideoRating (line 1062)

Helper function to conveniently set a video's rating.

  • return: Provides a fluent interface.
  • throws: Zend_Gdata_Exception
  • access: public
Zend_Gdata_YouTube_VideoEntry setVideoRating (integer $ratingValue)
  • integer $ratingValue: A number representing the rating. Must be between 1 and 5 inclusive.
setVideoRecorded (line 614)

Sets the date that the video was recorded.

  • access: public
void setVideoRecorded (string $recorded)
  • string $recorded: The date that the video was recorded, in the format of '2001-06-19'
setVideoTags (line 852)

Sets the keyword tags for a video.

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_YouTube_VideoEntry setVideoTags (mixed $tags)
  • mixed $tags: Either a comma-separated string or an array of tags for the video
setVideoTitle (line 665)

Sets the title of the video as a string.

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_YouTube_VideoEntry setVideoTitle (string $title)
  • string $title: Title for the video
setWhere (line 637)

Sets the georss:where element

  • return: Provides a fluent interface
  • access: public
takeChildFromDOM (line 247)

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

  • access: protected
void takeChildFromDOM (DOMNode $child)
  • DOMNode $child: The DOMNode to process

Redefinition of:
Zend_Gdata_YouTube_MediaEntry::takeChildFromDOM()
Creates individual Entry objects of the appropriate type and stores them as members of this entry based upon DOM data.

Redefined in descendants as:

Inherited Methods

Inherited From Zend_Gdata_YouTube_MediaEntry

 Zend_Gdata_YouTube_MediaEntry::takeChildFromDOM()

Inherited From Zend_Gdata_Media_Entry

 Zend_Gdata_Media_Entry::__construct()
 Zend_Gdata_Media_Entry::getDOM()
 Zend_Gdata_Media_Entry::getMediaGroup()
 Zend_Gdata_Media_Entry::setMediaGroup()
 Zend_Gdata_Media_Entry::takeChildFromDOM()

Inherited From Zend_Gdata_Entry

 Zend_Gdata_Entry::__construct()
 Zend_Gdata_Entry::getDOM()
 Zend_Gdata_Entry::takeAttributeFromDOM()
 Zend_Gdata_Entry::takeChildFromDOM()

Inherited From Zend_Gdata_App_MediaEntry

 Zend_Gdata_App_MediaEntry::__construct()
 Zend_Gdata_App_MediaEntry::encode()
 Zend_Gdata_App_MediaEntry::getMediaSource()
 Zend_Gdata_App_MediaEntry::setMediaSource()

Inherited From Zend_Gdata_App_Entry

 Zend_Gdata_App_Entry::delete()
 Zend_Gdata_App_Entry::getContent()
 Zend_Gdata_App_Entry::getControl()
 Zend_Gdata_App_Entry::getDOM()
 Zend_Gdata_App_Entry::getPublished()
 Zend_Gdata_App_Entry::getSource()
 Zend_Gdata_App_Entry::getSummary()
 Zend_Gdata_App_Entry::reload()
 Zend_Gdata_App_Entry::save()
 Zend_Gdata_App_Entry::setContent()
 Zend_Gdata_App_Entry::setControl()
 Zend_Gdata_App_Entry::setPublished()
 Zend_Gdata_App_Entry::setSource()
 Zend_Gdata_App_Entry::setSummary()
 Zend_Gdata_App_Entry::takeChildFromDOM()

Inherited From Zend_Gdata_App_FeedEntryParent

 Zend_Gdata_App_FeedEntryParent::__construct()
 Zend_Gdata_App_FeedEntryParent::getAlternateLink()
 Zend_Gdata_App_FeedEntryParent::getAuthor()
 Zend_Gdata_App_FeedEntryParent::getCategory()
 Zend_Gdata_App_FeedEntryParent::getContributor()
 Zend_Gdata_App_FeedEntryParent::getDOM()
 Zend_Gdata_App_FeedEntryParent::getEditLink()
 Zend_Gdata_App_FeedEntryParent::getEtag()
 Zend_Gdata_App_FeedEntryParent::getHttpClient()
 Zend_Gdata_App_FeedEntryParent::getId()
 Zend_Gdata_App_FeedEntryParent::getLicenseLink()
 Zend_Gdata_App_FeedEntryParent::getLink()
 Zend_Gdata_App_FeedEntryParent::getMajorProtocolVersion()
 Zend_Gdata_App_FeedEntryParent::getMinorProtocolVersion()
 Zend_Gdata_App_FeedEntryParent::getNextLink()
 Zend_Gdata_App_FeedEntryParent::getPreviousLink()
 Zend_Gdata_App_FeedEntryParent::getRights()
 Zend_Gdata_App_FeedEntryParent::getSelfLink()
 Zend_Gdata_App_FeedEntryParent::getService()
 Zend_Gdata_App_FeedEntryParent::getTitle()
 Zend_Gdata_App_FeedEntryParent::getTitleValue()
 Zend_Gdata_App_FeedEntryParent::getUpdated()
 Zend_Gdata_App_FeedEntryParent::lookupNamespace()
 Zend_Gdata_App_FeedEntryParent::setAuthor()
 Zend_Gdata_App_FeedEntryParent::setCategory()
 Zend_Gdata_App_FeedEntryParent::setContributor()
 Zend_Gdata_App_FeedEntryParent::setEtag()
 Zend_Gdata_App_FeedEntryParent::setHttpClient()
 Zend_Gdata_App_FeedEntryParent::setId()
 Zend_Gdata_App_FeedEntryParent::setLink()
 Zend_Gdata_App_FeedEntryParent::setMajorProtocolVersion()
 Zend_Gdata_App_FeedEntryParent::setMinorProtocolVersion()
 Zend_Gdata_App_FeedEntryParent::setRights()
 Zend_Gdata_App_FeedEntryParent::setService()
 Zend_Gdata_App_FeedEntryParent::setTitle()
 Zend_Gdata_App_FeedEntryParent::setUpdated()
 Zend_Gdata_App_FeedEntryParent::takeChildFromDOM()

Inherited From Zend_Gdata_App_Base

 Zend_Gdata_App_Base::__construct()
 Zend_Gdata_App_Base::encode()
 Zend_Gdata_App_Base::flushNamespaceLookupCache()
 Zend_Gdata_App_Base::getDOM()
 Zend_Gdata_App_Base::getExtensionAttributes()
 Zend_Gdata_App_Base::getExtensionElements()
 Zend_Gdata_App_Base::getText()
 Zend_Gdata_App_Base::getXML()
 Zend_Gdata_App_Base::lookupNamespace()
 Zend_Gdata_App_Base::registerAllNamespaces()
 Zend_Gdata_App_Base::registerNamespace()
 Zend_Gdata_App_Base::saveXML()
 Zend_Gdata_App_Base::setExtensionAttributes()
 Zend_Gdata_App_Base::setExtensionElements()
 Zend_Gdata_App_Base::setText()
 Zend_Gdata_App_Base::takeAttributeFromDOM()
 Zend_Gdata_App_Base::takeChildFromDOM()
 Zend_Gdata_App_Base::transferFromDOM()
 Zend_Gdata_App_Base::transferFromXML()
 Zend_Gdata_App_Base::__get()
 Zend_Gdata_App_Base::__isset()
 Zend_Gdata_App_Base::__set()
 Zend_Gdata_App_Base::__toString()
 Zend_Gdata_App_Base::__unset()
Class Constants
YOUTUBE_CATEGORY_SCHEMA = 'http://gdata.youtube.com/schemas/2007/categories.cat' (line 102)
YOUTUBE_DEVELOPER_TAGS_SCHEMA = 'http://gdata.youtube.com/schemas/2007/developertags.cat' (line 101)

Documentation generated on Mon, 21 Jun 2010 15:51:44 -0400 by phpDocumentor 1.4.3