API Documentation

Zend/Gdata/YouTube/VideoQuery.php

Show: inherited
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 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Gdata_YouTube_VideoQuery

Package: Zend\Gdata\YouTube

Assists in constructing queries for YouTube videos

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/  

Methods

methodpublic__construct(  $url = null ) : void

Create Gdata_YouTube_VideoQuery object

Parameters
Name Type Description
$url
methodpublicgetFormat( ) : string|null

Return the value of the format parameter

Returns
Type Description
string|null The value of format if it exists, null otherwise.
methodpublicgetLocation( ) : string|null

Get the value of the location parameter

Returns
Type Description
string|null Return the location if it exists, null otherwise.
methodpublicgetLocationRadius( ) : string|null

Get the value of the location-radius parameter

Returns
Type Description
string|null Return the location-radius if it exists, null otherwise.
methodpublicgetOrderBy( ) : string|null

Return the value of the orderby parameter if it exists

Returns
Type Description
string|null The 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
Name Type Description
$majorProtocolVersion integer

The major protocol version

$minorProtocolVersion integer

The minor protocol version

Returns
Type Description
string querystring
Throws
Exception Description
\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
Name Type Description
$majorProtocolVersion integer

The major protocol version

$minorProtocolVersion integer

The minor protocol version

Returns
Type Description
string The URL
methodpublicgetRacy( ) : string|null

Whether or not to include racy videos in the search results

Returns
Type Description
string|null The value of racy if it exists, null otherwise.
methodpublicgetSafeSearch( ) : string|null

Return the value of the safeSearch parameter

Returns
Type Description
string|null The value of the safeSearch parameter if it has been set, null otherwise.
methodpublicgetTime( ) : string|null

Return the value of the time parameter

Returns
Type Description
string|null The time parameter if it exists, null otherwise.
methodpublicgetVideoQuery( ) : string|null

Return the value of the video query that has been set

Returns
Type Description
string|null The 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
Name Type Description
$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

methodpublicsetFormat( string $value = null ) : \Zend_Gdata_YouTube_VideoQuery

Sets the param to return videos of a specific format

Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_YouTube_VideoQuery Provides a fluent interface
methodpublicsetLocation( string $value ) : \Zend_Gdata_YouTube_VideoQuery

Sets the location parameter for the query

Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_YouTube_VideoQuery Provides a fluent interface
Throws
Exception Description
\Zend_Gdata_App_InvalidArgumentException
methodpublicsetLocationRadius( string $value ) : \Zend_Gdata_YouTube_VideoQuery

Sets the location-radius parameter for the query

Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_YouTube_VideoQuery Provides a fluent interface
methodpublicsetOrderBy( string $value ) : \Zend_Gdata_YouTube_Query

Set the value of the orderby parameter

Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_YouTube_Query Provides a fluent interface
methodpublicsetRacy( string $value = null ) : \Zend_Gdata_YouTube_VideoQuery

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

Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_YouTube_VideoQuery Provides a fluent interface
methodpublicsetSafeSearch( string $value ) : \Zend_Gdata_YouTube_VideoQuery

Set the safeSearch parameter

Parameters
Name Type Description
$value string

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

Returns
Type Description
\Zend_Gdata_YouTube_VideoQuery Provides a fluent interface
Throws
Exception Description
\Zend_Gdata_App_InvalidArgumentException
methodpublicsetTime( string $value = null ) : \Zend_Gdata_YouTube_VideoQuery

Sets the time period over which this query should apply

Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_YouTube_VideoQuery Provides a fluent interface
Throws
Exception Description
\Zend_Gdata_App_InvalidArgumentException
methodpublicsetUploader( string $value = null ) : \Zend_Gdata_YouTube_VideoQuery

Sets the value of the uploader parameter

Parameters
Name Type Description
$value string

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

Returns
Type Description
\Zend_Gdata_YouTube_VideoQuery Provides a fluent interface
Throws
Exception Description
\Zend_Gdata_App_InvalidArgumentException
methodpublicsetVideoQuery( string $value = null ) : \Zend_Gdata_YouTube_VideoQuery

Sets the formatted video query (vq) URL param value

Parameters
Name Type Description
$value string
Returns
Type Description
\Zend_Gdata_YouTube_VideoQuery Provides a fluent interface
Documentation was generated by DocBlox 0.15.1.