Gdata/YouTube/VideoQuery.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Gdata  
Subpackage
YouTube  
Version
$Id: VideoQuery.php 25185 2013-01-08 08:07:08Z frosch $  

\Zend_Gdata_YouTube_VideoQuery

Package: Zend\Gdata\YouTube
Assists in constructing queries for YouTube videos

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

Parent(s)
\Zend_Gdata_Query
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Link
http://code.google.com/apis/youtube/  

Properties

>VPropertyprotectedstring $_category = null
inherited
Category for the query
Inherited from: \Zend_Gdata_Query::$$_category
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata_Query::$$_category  
>VPropertyprotectedstring $_defaultFeedUri = null
inherited
Default URL
Inherited from: \Zend_Gdata_Query::$$_defaultFeedUri
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata_Query::$$_defaultFeedUri  
>VPropertyprotectedarray $_params = array()
inherited
Query parameters.
Inherited from: \Zend_Gdata_Query::$$_params
Default valuearray()Details
Type
array
Inherited_from
\Zend_Gdata_Query::$$_params  
>VPropertyprotectedstring $_url = null
inherited
Base URL TODO: Add setters and getters
Inherited from: \Zend_Gdata_Query::$$_url
Default valuenullDetails
Type
string
Inherited_from
\Zend_Gdata_Query::$$_url  

Methods

methodpublic__construct( $url = null) : void

Create Gdata_YouTube_VideoQuery object

Parameters
NameTypeDescription
$url
methodpublic__get( $name) : void
inherited

Inherited from: \Zend_Gdata_Query::__get()
Parameters
NameTypeDescription
$name
methodpublic__set( $name,  $val) : void
inherited

Inherited from: \Zend_Gdata_Query::__set()
Parameters
NameTypeDescription
$name
$val
methodpublicgetAlt() : string
inherited

Inherited from: \Zend_Gdata_Query::getAlt()
Returns
TypeDescription
stringrss or atom
methodpublicgetAuthor() : string
inherited

Inherited from: \Zend_Gdata_Query::getAuthor()
Returns
TypeDescription
stringauthor
methodpublicgetCategory() : void
inherited

Inherited from: \Zend_Gdata_Query::getCategory()
methodpublicgetFormat() : string | null

Return the value of the format parameter

Returns
TypeDescription
string | nullThe value of format if it exists, null otherwise.
methodpublicgetLocation() : string | null

Get the value of the location parameter

Returns
TypeDescription
string | nullReturn the location if it exists, null otherwise.
methodpublicgetLocationRadius() : string | null

Get the value of the location-radius parameter

Returns
TypeDescription
string | nullReturn the location-radius if it exists, null otherwise.
methodpublicgetMaxResults() : int
inherited

Inherited from: \Zend_Gdata_Query::getMaxResults()
Returns
TypeDescription
intmaxResults
methodpublicgetOrderBy() : string | null

Return the value of the orderby parameter if it exists

Returns
TypeDescription
string | nullThe value of orderby if it exists, null otherwise.
methodpublicgetParam(string $name) : void
inherited

Inherited from: \Zend_Gdata_Query::getParam()
Parameters
NameTypeDescription
$namestring
methodpublicgetPublishedMax() : string
inherited

Inherited from: \Zend_Gdata_Query::getPublishedMax()
Returns
TypeDescription
stringpublishedMax
methodpublicgetPublishedMin() : string
inherited

Inherited from: \Zend_Gdata_Query::getPublishedMin()
Returns
TypeDescription
stringpublishedMin
methodpublicgetQuery() : string
inherited

Inherited from: \Zend_Gdata_Query::getQuery()
Returns
TypeDescription
stringquery
methodpublicgetQueryString(integer $majorProtocolVersion = null, integer $minorProtocolVersion = null) : string

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

Parameters
NameTypeDescription
$majorProtocolVersioninteger

The major protocol version

$minorProtocolVersioninteger

The minor protocol version

Returns
TypeDescription
stringquerystring
Throws
ExceptionDescription
\Zend_Gdata_App_VersionException
methodpublicgetQueryUrl(integer $majorProtocolVersion = null, integer $minorProtocolVersion = null) : string

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

Parameters
NameTypeDescription
$majorProtocolVersioninteger

The major protocol version

$minorProtocolVersioninteger

The minor protocol version

Returns
TypeDescription
stringThe URL
methodpublicgetRacy() : string | null

Whether or not to include racy videos in the search results

Returns
TypeDescription
string | nullThe value of racy if it exists, null otherwise.
methodpublicgetSafeSearch() : string | null

Return the value of the safeSearch parameter

Returns
TypeDescription
string | nullThe value of the safeSearch parameter if it has been set, null otherwise.
methodpublicgetStartIndex() : int
inherited

Inherited from: \Zend_Gdata_Query::getStartIndex()
Returns
TypeDescription
intstartIndex
methodpublicgetTime() : string | null

Return the value of the time parameter

Returns
TypeDescription
string | nullThe time parameter if it exists, null otherwise.
methodpublicgetUpdatedMax() : string
inherited

Inherited from: \Zend_Gdata_Query::getUpdatedMax()
Returns
TypeDescription
stringupdatedMax
methodpublicgetUpdatedMin() : string
inherited

Inherited from: \Zend_Gdata_Query::getUpdatedMin()
Returns
TypeDescription
stringupdatedMin
methodpublicgetVideoQuery() : string | null

Return the value of the video query that has been set

Returns
TypeDescription
string | nullThe value of the video query if it exists, null otherwise.
methodpublicresetParameters() : void
inherited

Inherited from: \Zend_Gdata_Query::resetParameters()
methodpublicsetAlt(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setAlt()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetAuthor(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setAuthor()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetCategory(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setCategory()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetFeedType(string $feedType, string $videoId = null, string $entry = null) : void

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

Parameters
NameTypeDescription
$feedTypestring

The type of feed

$videoIdstring

The ID of the video associated with this query

$entrystring

The ID of the entry associated with this query

methodpublicsetFormat(string $value = null) : \Zend_Gdata_YouTube_VideoQuery

Sets the param to return videos of a specific format

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_YouTube_VideoQueryProvides a fluent interface
methodpublicsetLocation(string $value) : \Zend_Gdata_YouTube_VideoQuery

Sets the location parameter for the query

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_YouTube_VideoQueryProvides a fluent interface
Throws
ExceptionDescription
\Zend_Gdata_App_InvalidArgumentException
methodpublicsetLocationRadius(string $value) : \Zend_Gdata_YouTube_VideoQuery

Sets the location-radius parameter for the query

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_YouTube_VideoQueryProvides a fluent interface
methodpublicsetMaxResults(int $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setMaxResults()
Parameters
NameTypeDescription
$valueint
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetOrderBy(string $value) : \Zend_Gdata_YouTube_Query

Set the value of the orderby parameter

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_YouTube_QueryProvides a fluent interface
methodpublicsetParam(string $name, string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setParam()
Parameters
NameTypeDescription
$namestring
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetPublishedMax(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setPublishedMax()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetPublishedMin(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setPublishedMin()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetQuery(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setQuery()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetRacy(string $value = null) : \Zend_Gdata_YouTube_VideoQuery

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

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_YouTube_VideoQueryProvides a fluent interface
methodpublicsetSafeSearch(string $value) : \Zend_Gdata_YouTube_VideoQuery

Set the safeSearch parameter

Parameters
NameTypeDescription
$valuestring

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

Returns
TypeDescription
\Zend_Gdata_YouTube_VideoQueryProvides a fluent interface
Throws
ExceptionDescription
\Zend_Gdata_App_InvalidArgumentException
methodpublicsetStartIndex(int $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setStartIndex()
Parameters
NameTypeDescription
$valueint
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetTime(string $value = null) : \Zend_Gdata_YouTube_VideoQuery

Sets the time period over which this query should apply

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_YouTube_VideoQueryProvides a fluent interface
Throws
ExceptionDescription
\Zend_Gdata_App_InvalidArgumentException
methodpublicsetUpdatedMax(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setUpdatedMax()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetUpdatedMin(string $value) : \Zend_Gdata_Query
inherited

Inherited from: \Zend_Gdata_Query::setUpdatedMin()
Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_QueryProvides a fluent interface
methodpublicsetUploader(string $value = null) : \Zend_Gdata_YouTube_VideoQuery

Sets the value of the uploader parameter

Parameters
NameTypeDescription
$valuestring

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

Returns
TypeDescription
\Zend_Gdata_YouTube_VideoQueryProvides a fluent interface
Throws
ExceptionDescription
\Zend_Gdata_App_InvalidArgumentException
methodpublicsetVideoQuery(string $value = null) : \Zend_Gdata_YouTube_VideoQuery

Sets the formatted video query (vq) URL param value

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Gdata_YouTube_VideoQueryProvides a fluent interface
Documentation was generated by phpDocumentor 2.0.0a12.