Zend_Gdata_YouTube_VideoQuery Class Reference

Public Member Functions
	__construct ($url=null)
	Create Gdata_YouTube_VideoQuery object.
	setFeedType ($feedType, $videoId=null, $entry=null)
	Sets the type of feed this query should be used to search.
	setLocation ($value)
	Sets the location parameter for the query.
	getLocation ()
	Get the value of the location parameter.
	setLocationRadius ($value)
	Sets the location-radius parameter for the query.
	getLocationRadius ()
	Get the value of the location-radius parameter.
	setTime ($value=null)
	Sets the time period over which this query should apply.
	setUploader ($value=null)
	Sets the value of the uploader parameter.
	setVideoQuery ($value=null)
	Sets the formatted video query (vq) URL param value.
	setFormat ($value=null)
	Sets the param to return videos of a specific format.
	setRacy ($value=null)
	Sets whether or not to include racy videos in the search results.
	getRacy ()
	Whether or not to include racy videos in the search results.
	setSafeSearch ($value)
	Set the safeSearch parameter.
	getSafeSearch ()
	Return the value of the safeSearch parameter.
	setOrderBy ($value)
	Set the value of the orderby parameter.
	getFormat ()
	Return the value of the format parameter.
	getVideoQuery ()
	Return the value of the video query that has been set.
	getTime ()
	Return the value of the time parameter.
	getOrderBy ()
	Return the value of the orderby parameter if it exists.
	getQueryString ($majorProtocolVersion=null, $minorProtocolVersion=null)
	Generate the query string from the URL parameters, optionally modifying them based on protocol version.
	getQueryUrl ($majorProtocolVersion=null, $minorProtocolVersion=null)
	Returns the generated full query URL, optionally modifying it based on the protocol version.
Public Member Functions inherited from Zend_Gdata_Query
	__construct ($url=null)
	Create Gdata_Query object.
	getQueryString ()
	resetParameters ()
	getQueryUrl ()
	setParam ($name, $value)
	getParam ($name)
	setAlt ($value)
	setMaxResults ($value)
	setQuery ($value)
	setStartIndex ($value)
	setUpdatedMax ($value)
	setUpdatedMin ($value)
	setPublishedMax ($value)
	setPublishedMin ($value)
	setAuthor ($value)
	getAlt ()
	getMaxResults ()
	getQuery ()
	getStartIndex ()
	getUpdatedMax ()
	getUpdatedMin ()
	getPublishedMax ()
	getPublishedMin ()
	getAuthor ()
	setCategory ($value)
	getCategory ()
	__get ($name)
	__set ($name, $val)

Additional Inherited Members
Protected Attributes inherited from Zend_Gdata_Query
	$_params = array()
	$_defaultFeedUri = null
	$_url = null
	$_category = null

Constructor & Destructor Documentation

__construct

(

$url = null

)

Create Gdata_YouTube_VideoQuery object.

Member Function Documentation

getFormat

(

)

Return the value of the format parameter.

Returns

string|null The value of format if it exists, null otherwise.

getLocation

(

)

Get the value of the location parameter.

Returns

string|null Return the location if it exists, null otherwise.

getLocationRadius

(

)

Get the value of the location-radius parameter.

Returns

string|null Return the location-radius if it exists, null otherwise.

getOrderBy

(

)

Return the value of the orderby parameter if it exists.

Returns

string|null The value of orderby if it exists, null otherwise.

getQueryString	(		$majorProtocolVersion = null,
			$minorProtocolVersion = null
	)

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

Parameters

integer	$majorProtocolVersion	The major protocol version
integer	$minorProtocolVersion	The minor protocol version

Exceptions

Zend_Gdata_App_VersionException

Returns

string querystring

getQueryUrl	(		$majorProtocolVersion = null,
			$minorProtocolVersion = null
	)

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

Parameters

integer	$majorProtocolVersion	The major protocol version
integer	$minorProtocolVersion	The minor protocol version

Returns

string The URL

getRacy

(

)

Whether or not to include racy videos in the search results.

Returns

string|null The value of racy if it exists, null otherwise.

getSafeSearch

(

)

Return the value of the safeSearch parameter.

Returns

string|null The value of the safeSearch parameter if it has been set, null otherwise.

getTime

(

)

Return the value of the time parameter.

Returns

string|null The time parameter if it exists, null otherwise.

getVideoQuery

(

)

Return the value of the video query that has been set.

Returns

string|null The value of the video query if it exists, null otherwise.

setFeedType	(		$feedType,
			$videoId = null,
			$entry = null
	)

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

Parameters

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

(

$value = null

)

Sets the param to return videos of a specific format.

Parameters

string

$value

Returns

Zend_Gdata_YouTube_VideoQuery Provides a fluent interface

setLocation

(

$value

)

Sets the location parameter for the query.

Parameters

string

$value

Exceptions

Zend_Gdata_App_InvalidArgumentException

Returns

Zend_Gdata_YouTube_VideoQuery Provides a fluent interface

setLocationRadius

(

$value

)

Sets the location-radius parameter for the query.

Parameters

string

$value

Returns

Zend_Gdata_YouTube_VideoQuery Provides a fluent interface

setOrderBy

(

$value

)

Set the value of the orderby parameter.

Parameters

string

$value

Returns

Zend_Gdata_YouTube_Query Provides a fluent interface

setRacy

(

$value = null

)

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

Parameters

string

$value

Returns

Zend_Gdata_YouTube_VideoQuery Provides a fluent interface

setSafeSearch

(

$value

)

Set the safeSearch parameter.

Parameters

string

$value

The value of the parameter, currently only 'none', 'moderate' or 'strict' are allowed values.

Exceptions

Zend_Gdata_App_InvalidArgumentException

Returns

Zend_Gdata_YouTube_VideoQuery Provides a fluent interface

setTime

(

$value = null

)

Sets the time period over which this query should apply.

Parameters

string

$value

Exceptions

Zend_Gdata_App_InvalidArgumentException

Returns

Zend_Gdata_YouTube_VideoQuery Provides a fluent interface

setUploader

(

$value = null

)

Sets the value of the uploader parameter.

Parameters

string

$value

The value of the uploader parameter. Currently this can only be set to the value of 'partner'.

Exceptions

Zend_Gdata_App_InvalidArgumentException

Returns

Zend_Gdata_YouTube_VideoQuery Provides a fluent interface

setVideoQuery

(

$value = null

)

Sets the formatted video query (vq) URL param value.

Parameters

string

$value

Returns

Zend_Gdata_YouTube_VideoQuery Provides a fluent interface