Zend Framework  1.12
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Zend_Gdata_YouTube_PlaylistVideoEntry Class Reference

Public Member Functions

 __construct ($element=null)
 Creates a Playlist video entry, representing an individual video in a list of videos contained within a specific playlist.
 
 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 Retrieves a DOMElement which corresponds to this element and all child properties.
 
 setPosition ($position=null)
 Sets the array of embedded feeds related to the video.
 
 getPosition ()
 Returns the position of the entry in the feed, as specified by the user.
 
- Public Member Functions inherited from Zend_Gdata_YouTube_VideoEntry
 __construct ($element=null)
 Creates a Video entry, representing an individual video.
 
 getDOM ($doc=null, $majorVersion=1, $minorVersion=null)
 Retrieves a DOMElement which corresponds to this element and all child properties.
 
 setRecorded ($recorded=null)
 Sets when the video was recorded.
 
 getRecorded ()
 Gets the date that the video was recorded.
 
 setLocation ($location=null)
 Sets the location information.
 
 getLocation ()
 Gets the location where the video was recorded.
 
 setNoEmbed ($noEmbed=null)
 If an instance of Zend_Gdata_YouTube_Extension_NoEmbed is passed in, the video cannot be embedded.
 
 getNoEmbed ()
 If the return value is an instance of Zend_Gdata_YouTube_Extension_NoEmbed, this video cannot be embedded.
 
 isVideoEmbeddable ()
 Checks whether the video is embeddable.
 
 setStatistics ($statistics=null)
 Sets the statistics relating to the video.
 
 getStatistics ()
 Returns the statistics relating to the video.
 
 setRacy ($racy=null)
 Specifies that the video has racy content.
 
 getRacy ()
 Returns the racy flag object.
 
 setRating ($rating=null)
 Sets the rating relating to the video.
 
 getRating ()
 Returns the rating relating to the video.
 
 setComments ($comments=null)
 Sets the comments relating to the video.
 
 getComments ()
 Returns the comments relating to the video.
 
 setFeedLink ($feedLink=null)
 Sets the array of embedded feeds related to the video.
 
 getFeedLink ($rel=null)
 Get the feed link property for this entry.
 
 getVideoResponsesLink ()
 Returns the link element relating to video responses.
 
 getVideoRatingsLink ()
 Returns the link element relating to video ratings.
 
 getVideoComplaintsLink ()
 Returns the link element relating to video complaints.
 
 getVideoId ()
 Gets the YouTube video ID based upon the atom:id value.
 
 getVideoRecorded ()
 Gets the date that the video was recorded.
 
 setVideoRecorded ($recorded)
 Sets the date that the video was recorded.
 
 getWhere ()
 Gets the georss:where element.
 
 setWhere ($value)
 Sets the georss:where element.
 
 getVideoTitle ()
 Gets the title of the video as a string.
 
 setVideoTitle ($title)
 Sets the title of the video as a string.
 
 setVideoDescription ($description)
 Sets the description of the video as a string.
 
 getVideoDescription ()
 Gets the description of the video as a string.
 
 getVideoWatchPageUrl ()
 Gets the URL of the YouTube video watch page.
 
 getVideoThumbnails ()
 Gets an array of the thumbnails representing the video.
 
 getFlashPlayerUrl ()
 Gets the URL of the flash player SWF.
 
 getVideoDuration ()
 Gets the duration of the video, in seconds.
 
 isVideoPrivate ()
 Checks whether the video is private.
 
 setVideoPrivate ()
 Sets video to private.
 
 setVideoPublic ()
 Sets a private video to be public.
 
 getVideoTags ()
 Gets an array of the tags assigned to this video.
 
 setVideoTags ($tags)
 Sets the keyword tags for a video.
 
 getVideoViewCount ()
 Gets the number of views for this video.
 
 getVideoGeoLocation ()
 Gets the location specified for this video, if available.
 
 getVideoRatingInfo ()
 Gets the rating information for this video, if available.
 
 getVideoCategory ()
 Gets the category of this video, if available.
 
 setVideoCategory ($category)
 Sets the category of the video as a string.
 
 getVideoDeveloperTags ()
 Gets the developer tags for the video, if available and if client is authenticated with a valid developerKey.
 
 addVideoDeveloperTag ($developerTag)
 Adds a developer tag to array of tags for the video.
 
 setVideoDeveloperTags ($developerTags)
 Set multiple developer tags for the video as strings.
 
 getVideoState ()
 Get the current publishing state of the video.
 
 ensureMediaGroupIsNotNull ()
 Get the VideoEntry's Zend_Gdata_YouTube_Extension_MediaGroup object.
 
 setVideoRating ($ratingValue)
 Helper function to conveniently set a video's rating.
 
 getVideoCommentFeedUrl ()
 Retrieve the URL for a video's comment feed.
 

Protected Member Functions

 takeChildFromDOM ($child)
 Creates individual Entry objects of the appropriate type and stores them in the $_entry array based upon DOM data.
 
- Protected Member Functions inherited from Zend_Gdata_YouTube_VideoEntry
 takeChildFromDOM ($child)
 Creates individual Entry objects of the appropriate type and stores them in the $_entry array based upon DOM data.
 
- Protected Member Functions inherited from Zend_Gdata_YouTube_MediaEntry
 takeChildFromDOM ($child)
 Creates individual Entry objects of the appropriate type and stores them as members of this entry based upon DOM data.
 
- Protected Member Functions inherited from Zend_Gdata_Media_Entry
 takeChildFromDOM ($child)
 Creates individual Entry objects of the appropriate type and stores them as members of this entry based upon DOM data.
 
- Protected Member Functions inherited from Zend_Gdata_Entry
 takeChildFromDOM ($child)
 
 takeAttributeFromDOM ($attribute)
 Given a DOMNode representing an attribute, tries to map the data into instance members.
 

Protected Attributes

 $_entryClassName = 'Zend_Gdata_YouTube_PlaylistVideoEntry'
 
 $_position = null
 
- Protected Attributes inherited from Zend_Gdata_YouTube_VideoEntry
 $_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
 
- Protected Attributes inherited from Zend_Gdata_YouTube_MediaEntry
 $_entryClassName = 'Zend_Gdata_YouTube_MediaEntry'
 
 $_mediaGroup = null
 
- Protected Attributes inherited from Zend_Gdata_Media_Entry
 $_entryClassName = 'Zend_Gdata_Media_Entry'
 
 $_mediaGroup = null
 
- Protected Attributes inherited from Zend_Gdata_Entry
 $_entryClassName = 'Zend_Gdata_Entry'
 
- Protected Attributes inherited from Zend_Gdata_App_MediaEntry
 $_mediaSource = null
 
- Protected Attributes inherited from Zend_Gdata_App_Entry
 $_rootElement = 'entry'
 
 $_entryClassName = 'Zend_Gdata_App_Entry'
 
 $_content = null
 
 $_published = null
 
 $_source = null
 
 $_summary = null
 
 $_control = null
 
 $_edited = null
 
- Protected Attributes inherited from Zend_Gdata_App_FeedEntryParent
 $_service = null
 Service instance used to make network requests.
 
 $_etag = NULL
 
 $_author = array()
 
 $_category = array()
 
 $_contributor = array()
 
 $_id = null
 
 $_link = array()
 
 $_rights = null
 
 $_title = null
 
 $_updated = null
 
 $_majorProtocolVersion = 1
 Indicates the major protocol version that should be used.
 
 $_minorProtocolVersion = null
 Indicates the minor protocol version that should be used.
 
- Protected Attributes inherited from Zend_Gdata_App_Base
 $_rootElement = null
 
 $_rootNamespace = 'atom'
 
 $_rootNamespaceURI = null
 
 $_extensionElements = array()
 
 $_extensionAttributes = array()
 
 $_text = null
 
 $_namespaces
 

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Gdata_App_Base
static flushNamespaceLookupCache ()
 Flush namespace lookup cache.
 
- Public Attributes inherited from Zend_Gdata_YouTube_VideoEntry
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'
 
- Static Protected Attributes inherited from Zend_Gdata_App_Base
static $_namespaceLookupCache = array()
 

Constructor & Destructor Documentation

__construct (   $element = null)

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

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

Member Function Documentation

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$docThe DOMDocument used to construct DOMElements
Returns
DOMElement The DOMElement representing this element and all child properties.
getPosition ( )

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

Returns
Zend_Gdata_YouTube_Extension_Position The position
setPosition (   $position = null)

Sets the array of embedded feeds related to the video.

Parameters
Zend_Gdata_YouTube_Extension_Position$positionThe position of the entry in the feed, as specified by the user.
Returns
Zend_Gdata_YouTube_PlaylistVideoEntry Provides a fluent interface
takeChildFromDOM (   $child)
protected

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

Parameters
DOMNode$childThe DOMNode to process

Member Data Documentation

$_entryClassName = 'Zend_Gdata_YouTube_PlaylistVideoEntry'
protected
$_position = null
protected