Class Zend_Gdata_YouTube_VideoQuery

Description
Description | Vars | Methods (details)

Assists in constructing queries for YouTube videos

Located in /Gdata/YouTube/VideoQuery.php (line 45) 

Zend_Gdata_Query
   |
   --Zend_Gdata_YouTube_VideoQuery
Method Summary
Description | Vars | Methods (details)
Zend_Gdata_YouTube_VideoQuery __construct ([ $url = null])
string|null getFormat ()
string|null getLocation ()
string|null getLocationRadius ()
string|null getOrderBy ()
string getQueryString ([integer $majorProtocolVersion = null], [integer $minorProtocolVersion = null])
string getQueryUrl ([integer $majorProtocolVersion = null], [integer $minorProtocolVersion = null])
string|null getRacy ()
string|null getSafeSearch ()
string|null getTime ()
string|null getVideoQuery ()
void setFeedType (string $feedType, [string $videoId = null], [string $entry = null])
Zend_Gdata_YouTube_VideoQuery setFormat ([string $value = null])
Zend_Gdata_YouTube_VideoQuery setLocation (string $value)
Zend_Gdata_YouTube_VideoQuery setLocationRadius (string $value)
Zend_Gdata_YouTube_Query setOrderBy (string $value)
Zend_Gdata_YouTube_VideoQuery setRacy ([string $value = null])
Zend_Gdata_YouTube_VideoQuery setSafeSearch (string $value)
Zend_Gdata_YouTube_VideoQuery setTime ([string $value = null])
Zend_Gdata_YouTube_VideoQuery setUploader ([string $value = null])
Zend_Gdata_YouTube_VideoQuery setVideoQuery ([string $value = null])
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from Zend_Gdata_Query

Zend_Gdata_Query::$_category
 Zend_Gdata_Query::$_defaultFeedUri
 Zend_Gdata_Query::$_params
 Zend_Gdata_Query::$_url
Methods
Description | Vars Methods (details)
Constructor __construct (line 51)

Create Gdata_YouTube_VideoQuery object

  • access: public
Zend_Gdata_YouTube_VideoQuery __construct ([ $url = null])
  • $url
Redefinition of:
Zend_Gdata_Query::__construct()
Create Gdata_Query object
getFormat (line 393)

Return the value of the format parameter

  • return: The value of format if it exists, null otherwise.
  • access: public
string|null getFormat ()
getLocation (line 161)

Get the value of the location parameter

  • return: Return the location if it exists, null otherwise.
  • access: public
string|null getLocation ()
getLocationRadius (line 193)

Get the value of the location-radius parameter

  • return: Return the location-radius if it exists, null otherwise.
  • access: public
string|null getLocationRadius ()
getOrderBy (line 436)

Return the value of the orderby parameter if it exists

  • return: The value of orderby if it exists, null otherwise.
  • access: public
string|null getOrderBy ()
getQueryString (line 454)

Generate the query string from the URL parameters, optionally modifying them based on protocol version.

  • return: querystring
  • throws: Zend_Gdata_App_VersionException
  • access: public
string getQueryString ([integer $majorProtocolVersion = null], [integer $minorProtocolVersion = null])
  • integer $majorProtocolVersion: The major protocol version
  • integer $minorProtocolVersion: The minor protocol version
Redefinition of:
Zend_Gdata_Query::getQueryString()
getQueryUrl (line 524)

Returns the generated full query URL, optionally modifying it based on the protocol version.

  • return: The URL
  • access: public
string getQueryUrl ([integer $majorProtocolVersion = null], [integer $minorProtocolVersion = null])
  • integer $majorProtocolVersion: The major protocol version
  • integer $minorProtocolVersion: The minor protocol version
Redefinition of:
Zend_Gdata_Query::getQueryUrl()
getRacy (line 319)

Whether or not to include racy videos in the search results

  • return: The value of racy if it exists, null otherwise.
  • access: public
string|null getRacy ()
getSafeSearch (line 364)

Return the value of the safeSearch parameter

  • return: The value of the safeSearch parameter if it has been set, null otherwise.
  • access: public
string|null getSafeSearch ()
getTime (line 422)

Return the value of the time parameter

  • return: The time parameter if it exists, null otherwise.
  • access: public
string|null getTime ()
getVideoQuery (line 408)

Return the value of the video query that has been set

  • return: The value of the video query if it exists, null otherwise.
  • access: public
string|null getVideoQuery ()
setFeedType (line 63)

Sets the type of feed this query should be used to search

  • access: public
void setFeedType (string $feedType, [string $videoId = null], [string $entry = null])
  • string $feedType: The type of feed
  • string $videoId: The ID of the video associated with this query
  • string $entry: The ID of the entry associated with this query
setFormat (line 282)

Sets the param to return videos of a specific format

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_YouTube_VideoQuery setFormat ([string $value = null])
  • string $value
setLocation (line 125)

Sets the location parameter for the query

  • return: Provides a fluent interface
  • throws: Zend_Gdata_App_InvalidArgumentException
  • access: public
Zend_Gdata_YouTube_VideoQuery setLocation (string $value)
  • string $value
setLocationRadius (line 177)

Sets the location-radius parameter for the query

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_YouTube_VideoQuery setLocationRadius (string $value)
  • string $value
setOrderBy (line 378)

Set the value of the orderby parameter

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_YouTube_Query setOrderBy (string $value)
  • string $value
setRacy (line 298)

Sets whether or not to include racy videos in the search results

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_YouTube_VideoQuery setRacy ([string $value = null])
  • string $value
setSafeSearch (line 336)

Set the safeSearch parameter

  • return: Provides a fluent interface
  • throws: Zend_Gdata_App_InvalidArgumentException
  • access: public
Zend_Gdata_YouTube_VideoQuery setSafeSearch (string $value)
  • string $value: The value of the parameter, currently only 'none', 'moderate' or 'strict' are allowed values.
setTime (line 209)

Sets the time period over which this query should apply

  • return: Provides a fluent interface
  • throws: Zend_Gdata_App_InvalidArgumentException
  • access: public
Zend_Gdata_YouTube_VideoQuery setTime ([string $value = null])
  • string $value
setUploader (line 243)

Sets the value of the uploader parameter

  • return: Provides a fluent interface
  • throws: Zend_Gdata_App_InvalidArgumentException
  • access: public
Zend_Gdata_YouTube_VideoQuery setUploader ([string $value = null])
  • string $value: The value of the uploader parameter. Currently this can only be set to the value of 'partner'.
setVideoQuery (line 266)

Sets the formatted video query (vq) URL param value

  • return: Provides a fluent interface
  • access: public
Zend_Gdata_YouTube_VideoQuery setVideoQuery ([string $value = null])
  • string $value

Inherited Methods

Inherited From Zend_Gdata_Query

Zend_Gdata_Query::__construct()
Zend_Gdata_Query::getAlt()
Zend_Gdata_Query::getAuthor()
Zend_Gdata_Query::getCategory()
Zend_Gdata_Query::getMaxResults()
Zend_Gdata_Query::getParam()
Zend_Gdata_Query::getPublishedMax()
Zend_Gdata_Query::getPublishedMin()
Zend_Gdata_Query::getQuery()
Zend_Gdata_Query::getQueryString()
Zend_Gdata_Query::getQueryUrl()
Zend_Gdata_Query::getStartIndex()
Zend_Gdata_Query::getUpdatedMax()
Zend_Gdata_Query::getUpdatedMin()
Zend_Gdata_Query::resetParameters()
Zend_Gdata_Query::setAlt()
Zend_Gdata_Query::setAuthor()
Zend_Gdata_Query::setCategory()
Zend_Gdata_Query::setMaxResults()
Zend_Gdata_Query::setParam()
Zend_Gdata_Query::setPublishedMax()
Zend_Gdata_Query::setPublishedMin()
Zend_Gdata_Query::setQuery()
Zend_Gdata_Query::setStartIndex()
Zend_Gdata_Query::setUpdatedMax()
Zend_Gdata_Query::setUpdatedMin()
Zend_Gdata_Query::__get()
Zend_Gdata_Query::__set()

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