Gdata/YouTube/VideoQuery.php
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Gdata
- Subpackage
- YouTube
- Version
- $Id$
\Zend_Gdata_YouTube_VideoQuery
Package: Zend_Gdata\YouTubeAssists 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
getFormat() : string | nullReturn the value of the format parameter
Returns| Type | Description |
|---|
| string | null | The value of format if it exists, null otherwise. |
getLocation() : string | nullGet the value of the location parameter
Returns| Type | Description |
|---|
| string | null | Return the location if it exists, null otherwise. |
getLocationRadius() : string | nullGet the value of the location-radius parameter
Returns| Type | Description |
|---|
| string | null | Return the location-radius if it exists,
null otherwise. |
getOrderBy() : string | nullReturn the value of the orderby parameter if it exists
Returns| Type | Description |
|---|
| string | null | The value of orderby if it exists, null otherwise. |
getQueryString(integer $majorProtocolVersion = null, integer $minorProtocolVersion = null) : stringGenerate 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 getQueryUrl(integer $majorProtocolVersion = null, integer $minorProtocolVersion = null) : stringReturns 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 |
getRacy() : string | nullWhether or not to include racy videos in the search results
Returns| Type | Description |
|---|
| string | null | The value of racy if it exists, null otherwise. |
getSafeSearch() : string | nullReturn the value of the safeSearch parameter
Returns| Type | Description |
|---|
| string | null | The value of the safeSearch parameter if it has been
set, null otherwise. |
getTime() : string | nullReturn the value of the time parameter
Returns| Type | Description |
|---|
| string | null | The time parameter if it exists, null otherwise. |
getVideoQuery() : string | nullReturn 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. |
setFeedType(string $feedType, string $videoId = null, string $entry = null) : voidSets 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 |
|---|
setFormat(string $value = null) : \Zend_Gdata_YouTube_VideoQuerySets the param to return videos of a specific format
Parameters| Name | Type | Description |
|---|
| $value | string | |
|---|
Returns setLocation(string $value) : \Zend_Gdata_YouTube_VideoQuerySets the location parameter for the query
Parameters| Name | Type | Description |
|---|
| $value | string | |
|---|
ReturnsThrows setLocationRadius(string $value) : \Zend_Gdata_YouTube_VideoQuerySets the location-radius parameter for the query
Parameters| Name | Type | Description |
|---|
| $value | string | |
|---|
Returns setOrderBy(string $value) : \Zend_Gdata_YouTube_QuerySet the value of the orderby parameter
Parameters| Name | Type | Description |
|---|
| $value | string | |
|---|
Returns setRacy(string $value = null) : \Zend_Gdata_YouTube_VideoQuerySets whether or not to include racy videos in the search results
Parameters| Name | Type | Description |
|---|
| $value | string | |
|---|
Returns setSafeSearch(string $value) : \Zend_Gdata_YouTube_VideoQuerySet the safeSearch parameter
Parameters| Name | Type | Description |
|---|
| $value | string | The value of the parameter, currently only 'none',
'moderate' or 'strict' are allowed values.
|
|---|
ReturnsThrows setTime(string $value = null) : \Zend_Gdata_YouTube_VideoQuerySets the time period over which this query should apply
Parameters| Name | Type | Description |
|---|
| $value | string | |
|---|
ReturnsThrows setUploader(string $value = null) : \Zend_Gdata_YouTube_VideoQuerySets 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'.
|
|---|
ReturnsThrows setVideoQuery(string $value = null) : \Zend_Gdata_YouTube_VideoQuerySets the formatted video query (vq) URL param value
Parameters| Name | Type | Description |
|---|
| $value | string | |
|---|
Returns 
inherited
Classes