Inheritance diagram for Zend_Gdata_YouTube_VideoQuery:

Collaboration diagram for Zend_Gdata_YouTube_VideoQuery:

Public Member Functions
	__construct ($url=null)
	setFeedType ($feedType, $videoId=null, $entry=null)
	setLocation ($value)
	getLocation ()
	setLocationRadius ($value)
	getLocationRadius ()
	setTime ($value=null)
	setUploader ($value=null)
	setVideoQuery ($value=null)
	setFormat ($value=null)
	setRacy ($value=null)
	getRacy ()
	setSafeSearch ($value)
	getSafeSearch ()
	setOrderBy ($value)
	getFormat ()
	getVideoQuery ()
	getTime ()
	getOrderBy ()
	getQueryString ($majorProtocolVersion=null, $minorProtocolVersion=null)
	getQueryUrl ($majorProtocolVersion=null, $minorProtocolVersion=null)

Detailed Description

Definition at line 45 of file VideoQuery.php.

Constructor & Destructor Documentation

__construct ( $ url = null )

Create Gdata_YouTube_VideoQuery object

Reimplemented from Zend_Gdata_Query.

Definition at line 51 of file VideoQuery.php.

Member Function Documentation

getFormat ( )

Return the value of the format parameter

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

Definition at line 393 of file VideoQuery.php.

getLocation ( )

Get the value of the location parameter

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

Definition at line 161 of file VideoQuery.php.

getLocationRadius ( )

Get the value of the location-radius parameter

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

Definition at line 193 of file VideoQuery.php.

getOrderBy ( )

Return the value of the orderby parameter if it exists

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

Definition at line 436 of file VideoQuery.php.

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

Definition at line 454 of file VideoQuery.php.

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

Definition at line 524 of file VideoQuery.php.

Here is the call graph for this function:

getRacy ( )

Whether or not to include racy videos in the search results

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

Definition at line 319 of file VideoQuery.php.

getSafeSearch ( )

Return the value of the safeSearch parameter

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

Definition at line 364 of file VideoQuery.php.

getTime ( )

Return the value of the time parameter

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

Definition at line 422 of file VideoQuery.php.

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.

Definition at line 408 of file VideoQuery.php.

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

Definition at line 63 of file VideoQuery.php.

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

Definition at line 282 of file VideoQuery.php.

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

Definition at line 125 of file VideoQuery.php.

setLocationRadius ( $ value )

Sets the location-radius parameter for the query

Parameters:

string $value

Returns:: Zend_Gdata_YouTube_VideoQuery Provides a fluent interface

Definition at line 177 of file VideoQuery.php.

setOrderBy ( $ value )

Set the value of the orderby parameter

Parameters:

string $value

Returns:: Zend_Gdata_YouTube_Query Provides a fluent interface

Definition at line 378 of file VideoQuery.php.

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

Definition at line 298 of file VideoQuery.php.

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

Definition at line 336 of file VideoQuery.php.

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

Definition at line 209 of file VideoQuery.php.

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

Definition at line 243 of file VideoQuery.php.

setVideoQuery ( $ value = null )

Sets the formatted video query (vq) URL param value

Parameters:

string $value

Returns:: Zend_Gdata_YouTube_VideoQuery Provides a fluent interface

Definition at line 266 of file VideoQuery.php.

The documentation for this class was generated from the following file:

C:/xampp/htdocs/moodle/lib/zend/Zend/Gdata/YouTube/VideoQuery.php

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation