Gdata/YouTube/VideoQuery.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Gdata
subpackage: YouTube
version: $Id: VideoQuery.php 20097 2010-01-06 15:40:27Z bate $
Classes: Zend_Gdata_YouTube_VideoQuery

Description

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.

Zend_Gdata_YouTube_VideoQuery
jump to top

Extends from: Zend_Gdata_Query
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
link: http://code.google.com/apis/youtube/
package: Zend_Gdata
subpackage: YouTube
Methods: __construct; setFeedType; setLocation; getLocation; setLocationRadius; getLocationRadius; setTime; setUploader; setVideoQuery; setFormat; setRacy; getRacy; setSafeSearch; getSafeSearch; setOrderBy; getFormat; getVideoQuery; getTime; getOrderBy; getQueryString; getQueryUrl

Description

Assists in constructing queries for YouTube videos

Methods

__construct
jump to class

__construct(
           $url
              =
              null
          )
        
        :

Create Gdata_YouTube_VideoQuery object

Arguments

$url

Details

visibility: public
final: false
static: false

getFormat
jump to class

getFormat(
          
          )
        
        :
        string|null

Return the value of the format parameter

Output

string|null: The value of format if it exists, null otherwise.

Details

visibility: public
final: false
static: false

getLocation
jump to class

getLocation(
          
          )
        
        :
        string|null

Get the value of the location parameter

Output

string|null: Return the location if it exists, null otherwise.

Details

visibility: public
final: false
static: false

getLocationRadius
jump to class

getLocationRadius(
          
          )
        
        :
        string|null

Get the value of the location-radius parameter

Output

string|null: Return the location-radius if it exists, null otherwise.

Details

visibility: public
final: false
static: false

getOrderBy
jump to class

getOrderBy(
          
          )
        
        :
        string|null

Return the value of the orderby parameter if it exists

Output

string|null: The value of orderby if it exists, null otherwise.

Details

visibility: public
final: false
static: false

getQueryString
jump to class

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

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

Arguments

$majorProtocolVersion: integer
The major protocol version
$minorProtocolVersion: integer
The minor protocol version

Output

string: querystring

Details

visibility: public
final: false
static: false
throws

getQueryUrl
jump to class

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

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

Arguments

$majorProtocolVersion: integer
The major protocol version
$minorProtocolVersion: integer
The minor protocol version

Output

string: The URL

Details

visibility: public
final: false
static: false

getRacy
jump to class

getRacy(
          
          )
        
        :
        string|null

Whether or not to include racy videos in the search results

Output

string|null: The value of racy if it exists, null otherwise.

Details

visibility: public
final: false
static: false

getSafeSearch
jump to class

getSafeSearch(
          
          )
        
        :
        string|null

Return the value of the safeSearch parameter

Output

string|null: The value of the safeSearch parameter if it has been set, null otherwise.

Details

visibility: public
final: false
static: false

getTime
jump to class

getTime(
          
          )
        
        :
        string|null

Return the value of the time parameter

Output

string|null: The time parameter if it exists, null otherwise.

Details

visibility: public
final: false
static: false

getVideoQuery
jump to class

getVideoQuery(
          
          )
        
        :
        string|null

Return the value of the video query that has been set

Output

string|null: The value of the video query if it exists, null otherwise.

Details

visibility: public
final: false
static: false

setFeedType
jump to class

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

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

Arguments

$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

Details

visibility: public
final: false
static: false

setFormat
jump to class

setFormat(
          string $value
              =
              null
          )
        
        :
        Zend_Gdata_YouTube_VideoQuery

Sets the param to return videos of a specific format

Arguments

$value: string

Output

Zend_Gdata_YouTube_VideoQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false

setLocation
jump to class

setLocation(
          string $value
          )
        
        :
        Zend_Gdata_YouTube_VideoQuery

Sets the location parameter for the query

Arguments

$value: string

Output

Zend_Gdata_YouTube_VideoQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false
throws

setLocationRadius
jump to class

setLocationRadius(
          string $value
          )
        
        :
        Zend_Gdata_YouTube_VideoQuery

Sets the location-radius parameter for the query

Arguments

$value: string

Output

Zend_Gdata_YouTube_VideoQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false

setOrderBy
jump to class

setOrderBy(
          string $value
          )
        
        :
        Zend_Gdata_YouTube_Query

Set the value of the orderby parameter

Arguments

$value: string

Output

Zend_Gdata_YouTube_Query: Provides a fluent interface

Details

visibility: public
final: false
static: false

setRacy
jump to class

setRacy(
          string $value
              =
              null
          )
        
        :
        Zend_Gdata_YouTube_VideoQuery

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

Arguments

$value: string

Output

Zend_Gdata_YouTube_VideoQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false

setSafeSearch
jump to class

setSafeSearch(
          string $value
          )
        
        :
        Zend_Gdata_YouTube_VideoQuery

Set the safeSearch parameter

Arguments

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

Output

Zend_Gdata_YouTube_VideoQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false
throws

setTime
jump to class

setTime(
          string $value
              =
              null
          )
        
        :
        Zend_Gdata_YouTube_VideoQuery

Sets the time period over which this query should apply

Arguments

$value: string

Output

Zend_Gdata_YouTube_VideoQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false
throws

setUploader
jump to class

setUploader(
          string $value
              =
              null
          )
        
        :
        Zend_Gdata_YouTube_VideoQuery

Sets the value of the uploader parameter

Arguments

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

Output

Zend_Gdata_YouTube_VideoQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false
throws

setVideoQuery
jump to class

setVideoQuery(
          string $value
              =
              null
          )
        
        :
        Zend_Gdata_YouTube_VideoQuery

Sets the formatted video query (vq) URL param value

Arguments

$value: string

Output

Zend_Gdata_YouTube_VideoQuery: Provides a fluent interface

Details

visibility: public
final: false
static: false

API Documentation

Gdata/YouTube/VideoQuery.php

Description

Zend_Gdata_YouTube_VideoQueryjump to top

Description

Methods

__constructjump to class

Arguments

Details

getFormatjump to class

Output

Details

getLocationjump to class

Output

Details

getLocationRadiusjump to class

Output

Details

getOrderByjump to class

Output

Details

getQueryStringjump to class

Arguments

Output

Details

getQueryUrljump to class

Arguments

Output

Details

getRacyjump to class

Output

Details

getSafeSearchjump to class

Output

Details

getTimejump to class

Output

Details

getVideoQueryjump to class

Output

Details

setFeedTypejump to class

Arguments

Details

setFormatjump to class

Arguments

Output

Details

setLocationjump to class

Arguments

Output

Details

setLocationRadiusjump to class

Arguments

Output

Details

setOrderByjump to class

Arguments

Output

Details

setRacyjump to class

Arguments

Output

Details

setSafeSearchjump to class

Arguments

Output

Details

setTimejump to class

Arguments

Output

Details

setUploaderjump to class

Arguments

Output

Details

setVideoQueryjump to class

Arguments

Output

Details

Zend_Gdata_YouTube_VideoQuery
jump to top

__construct
jump to class

getFormat
jump to class

getLocation
jump to class

getLocationRadius
jump to class

getOrderBy
jump to class

getQueryString
jump to class

getQueryUrl
jump to class

getRacy
jump to class

getSafeSearch
jump to class

getTime
jump to class

getVideoQuery
jump to class

setFeedType
jump to class

setFormat
jump to class

setLocation
jump to class

setLocationRadius
jump to class

setOrderBy
jump to class

setRacy
jump to class

setSafeSearch
jump to class

setTime
jump to class

setUploader
jump to class

setVideoQuery
jump to class