Assists in constructing queries for YouTube videos

Queries are not defined for APP, but are provided by Gdata services as an extension.

link http://code.google.com/apis/youtube/
category Zend
package Zend_Gdata
subpackage YouTube
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License
inherited_from \Zend_Gdata_Query

 Methods

Create Gdata_YouTube_VideoQuery object

__construct($url = null
inherited_from \Zend_Gdata_Query::__construct()

Parameters

$url

Create Gdata_Query object

__construct($url = null
Inherited

Parameters

$url

__get()

__get($name) 
Inherited

Parameters

$name

__set()

__set($name, $val) 
Inherited

Parameters

$name

$val

getAlt()

getAlt() : string
Inherited

Returns

stringrss or atom

getAuthor()

getAuthor() : string
Inherited

Returns

stringauthor

getCategory()

getCategory() 
Inherited

Return the value of the format parameter

getFormat() : string | null

Returns

stringnullThe value of format if it exists, null otherwise.

Get the value of the location parameter

getLocation() : string | null

Returns

stringnullReturn the location if it exists, null otherwise.

Get the value of the location-radius parameter

getLocationRadius() : string | null

Returns

stringnullReturn the location-radius if it exists, null otherwise.

getMaxResults()

getMaxResults() : integer
Inherited

Returns

integermaxResults

Return the value of the orderby parameter if it exists

getOrderBy() : string | null

Returns

stringnullThe value of orderby if it exists, null otherwise.

getParam()

getParam(string $name) 
Inherited

Parameters

$name

string

getPublishedMax()

getPublishedMax() : string
Inherited

Returns

stringpublishedMax

getPublishedMin()

getPublishedMin() : string
Inherited

Returns

stringpublishedMin

getQuery()

getQuery() : string
Inherited

Returns

stringquery

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

getQueryString(integer $majorProtocolVersion = null, integer $minorProtocolVersion = null) : string
inherited_from \Zend_Gdata_Query::getQueryString()

Parameters

$majorProtocolVersion

integer

The major protocol version

$minorProtocolVersion

integer

The minor protocol version

Exceptions

\Zend_Gdata_App_VersionException

Returns

stringquerystring

getQueryString()

getQueryString() : string
Inherited

Returns

stringquerystring

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

getQueryUrl(integer $majorProtocolVersion = null, integer $minorProtocolVersion = null) : string
inherited_from \Zend_Gdata_Query::getQueryUrl()

Parameters

$majorProtocolVersion

integer

The major protocol version

$minorProtocolVersion

integer

The minor protocol version

Returns

stringThe URL

getQueryUrl()

getQueryUrl() : string
Inherited

Returns

stringurl

Whether or not to include racy videos in the search results

getRacy() : string | null

Returns

stringnullThe value of racy if it exists, null otherwise.

Return the value of the safeSearch parameter

getSafeSearch() : string | null

Returns

stringnullThe value of the safeSearch parameter if it has been set, null otherwise.

getStartIndex()

getStartIndex() : integer
Inherited

Returns

integerstartIndex

Return the value of the time parameter

getTime() : string | null

Returns

stringnullThe time parameter if it exists, null otherwise.

getUpdatedMax()

getUpdatedMax() : string
Inherited

Returns

stringupdatedMax

getUpdatedMin()

getUpdatedMin() : string
Inherited

Returns

stringupdatedMin

Return the value of the video query that has been set

getVideoQuery() : string | null

Returns

stringnullThe value of the video query if it exists, null otherwise.

resetParameters()

resetParameters() 
Inherited

setAlt()

setAlt(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setAuthor()

setAuthor(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setCategory()

setCategory(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

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

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

Parameters

$feedType

string

The type of feed

$videoId

string

The ID of the video associated with this query

$entry

string

The ID of the entry associated with this query

Sets the param to return videos of a specific format

setFormat(string $value = null) : \Zend_Gdata_YouTube_VideoQuery

Parameters

$value

string

Returns

\Zend_Gdata_YouTube_VideoQueryProvides a fluent interface

Sets the location parameter for the query

setLocation(string $value) : \Zend_Gdata_YouTube_VideoQuery

Parameters

$value

string

Exceptions

\Zend_Gdata_App_InvalidArgumentException

Returns

\Zend_Gdata_YouTube_VideoQueryProvides a fluent interface

Sets the location-radius parameter for the query

setLocationRadius(string $value) : \Zend_Gdata_YouTube_VideoQuery

Parameters

$value

string

Returns

\Zend_Gdata_YouTube_VideoQueryProvides a fluent interface

setMaxResults()

setMaxResults(integer $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

integer

Returns

\Zend_Gdata_QueryProvides a fluent interface

Set the value of the orderby parameter

setOrderBy(string $value) : \Zend_Gdata_YouTube_Query

Parameters

$value

string

Returns

\Zend_Gdata_YouTube_QueryProvides a fluent interface

setParam()

setParam(string $name, string $value) : \Zend_Gdata_Query
Inherited

Parameters

$name

string

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setPublishedMax()

setPublishedMax(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setPublishedMin()

setPublishedMin(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setQuery()

setQuery(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

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

setRacy(string $value = null) : \Zend_Gdata_YouTube_VideoQuery

Parameters

$value

string

Returns

\Zend_Gdata_YouTube_VideoQueryProvides a fluent interface

Set the safeSearch parameter

setSafeSearch(string $value) : \Zend_Gdata_YouTube_VideoQuery

Parameters

$value

string

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

Exceptions

\Zend_Gdata_App_InvalidArgumentException

Returns

\Zend_Gdata_YouTube_VideoQueryProvides a fluent interface

setStartIndex()

setStartIndex(integer $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

integer

Returns

\Zend_Gdata_QueryProvides a fluent interface

Sets the time period over which this query should apply

setTime(string $value = null) : \Zend_Gdata_YouTube_VideoQuery

Parameters

$value

string

Exceptions

\Zend_Gdata_App_InvalidArgumentException

Returns

\Zend_Gdata_YouTube_VideoQueryProvides a fluent interface

setUpdatedMax()

setUpdatedMax(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

setUpdatedMin()

setUpdatedMin(string $value) : \Zend_Gdata_Query
Inherited

Parameters

$value

string

Returns

\Zend_Gdata_QueryProvides a fluent interface

Sets the value of the uploader parameter

setUploader(string $value = null) : \Zend_Gdata_YouTube_VideoQuery

Parameters

$value

string

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_VideoQueryProvides a fluent interface

Sets the formatted video query (vq) URL param value

setVideoQuery(string $value = null) : \Zend_Gdata_YouTube_VideoQuery

Parameters

$value

string

Returns

\Zend_Gdata_YouTube_VideoQueryProvides a fluent interface

 Properties

 

Category for the query

$_category : string

Default

null
 

Default URL

$_defaultFeedUri : string

Default

null
 

Query parameters.

$_params : array

Default

array()
 

Base URL TODO: Add setters and getters

$_url : string

Default

null