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 [email protected] so we can send you a copy immediately.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Gdata  
Subpackage
YouTube  
Version
$Id$  

\Zend_Gdata_YouTube_VideoQuery
jump to top

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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Link
http://code.google.com/apis/youtube/  

Methods

methodpublic__construct( $url = null) : void

Create Gdata_YouTube_VideoQuery object

Parameters
NameTypeDescription
$url
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.
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.
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.
methodpublicgetTime() : string | null

Return the value of the time parameter

Returns
TypeDescription
string | nullThe time parameter if it exists, null otherwise.
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.
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
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
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
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
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.2.0 .