API Documentation

Service/Twitter/Search.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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Service  
subpackage
Twitter  
version
$Id: Search.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Service_Twitter_Search

Extends from
\Zend_Rest_Client
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Service  
subpackage
Twitter  

Properties

PropertyprotectedString  $_responseType= 'json'

Return Type

Default valuejsonDetails
Type
String
Propertyprotectedarray  $_responseTypes= 'array'

Response Format Types

Default valuearrayDetails
Type
array
Propertyprotected\Zend_Uri_Http  $_uri= ''

Uri Compoent

Details
Type
\Zend_Uri_Http

Methods

methodpublic__call( string $method, array $args ) : \Zend_Rest_Client_Result|\Zend_Rest_Client

Method call overload

Inherited from: \Zend_Rest_Client::__call()

Allows calling REST actions as object methods; however, you must follow-up by chaining the request with a request to an HTTP request method (post, get, delete, put):

$response = $rest->sayHello('Foo', 'Manchu')->get();

Or use them together, but in sequential calls:

$rest->sayHello('Foo', 'Manchu');
$response = $rest->get();
Parameters
Name Type Description
$method string Method name
$args array Method args
Returns
Type Description
\Zend_Rest_Client_Result\Zend_Rest_Client Zend_Rest_Client if using a remote method, Zend_Rest_Client_Result if using an HTTP request method
methodpublic__construct(  $responseType = json ) : void

Constructor

Parameters
Name Type Description
$responseType
methodprotected_performPost( mixed $method, mixed $data = null ) : \Zend_Http_Response

Perform a POST or PUT

Inherited from: \Zend_Rest_Client::_performPost()

Performs a POST or PUT request. Any data provided is set in the HTTP client. String data is pushed in as raw POST data; array or object data is pushed in as POST parameters.

Parameters
Name Type Description
$method mixed
$data mixed
Returns
Type Description
\Zend_Http_Response
methodprivate_prepareRest( string $path ) : void

Call a remote REST web service URI and return the Zend_Http_Response object

Inherited from: \Zend_Rest_Client::_prepareRest()
Parameters
Name Type Description
$path string The path to append to the URI
Throws
Exception Description
\Zend_Rest_Client_Exception
methodpublicgetHttpClient( ) : \Zend_Http_Client
static

Gets the HTTP client object.

Inherited from: \Zend_Service_Abstract::getHttpClient()
Returns
Type Description
\Zend_Http_Client
methodpublicgetResponseType( ) : string

Retrieve responseType

Returns
Type Description
string
methodpublicgetUri( ) : \Zend_Uri_Http

Retrieve the current request URI object

Inherited from: \Zend_Rest_Client::getUri()
Returns
Type Description
\Zend_Uri_Http
methodpublicrestDelete( string $path,  $data = null ) : \Zend_Http_Response

Performs an HTTP DELETE request to $path.

Inherited from: \Zend_Rest_Client::restDelete()
Parameters
Name Type Description
$path string
$data
Returns
Type Description
\Zend_Http_Response
Throws
Exception Description
\Zend_Http_Client_Exception
methodpublicrestGet( string $path, array $query = null ) : \Zend_Http_Response

Performs an HTTP GET request to the $path.

Inherited from: \Zend_Rest_Client::restGet()
Parameters
Name Type Description
$path string
$query array Array of GET parameters
Returns
Type Description
\Zend_Http_Response
Throws
Exception Description
\Zend_Http_Client_Exception
methodpublicrestPost( string $path, mixed $data = null ) : \Zend_Http_Response

Performs an HTTP POST request to $path.

Inherited from: \Zend_Rest_Client::restPost()
Parameters
Name Type Description
$path string
$data mixed Raw data to send
Returns
Type Description
\Zend_Http_Response
Throws
Exception Description
\Zend_Http_Client_Exception
methodpublicrestPut( string $path, mixed $data = null ) : \Zend_Http_Response

Performs an HTTP PUT request to $path.

Inherited from: \Zend_Rest_Client::restPut()
Parameters
Name Type Description
$path string
$data mixed Raw data to send in request
Returns
Type Description
\Zend_Http_Response
Throws
Exception Description
\Zend_Http_Client_Exception
methodpublicsearch(  $query,  $params = array ) : void

Performs a Twitter search query.

Parameters
Name Type Description
$query
$params
Throws
Exception Description
\Zend_Http_Client_Exception
methodpublicsetHttpClient( \Zend_Http_Client $httpClient ) : void
static

Sets the HTTP client object to use for retrieving the feeds. If none is set, the default Zend_Http_Client will be used.

Inherited from: \Zend_Service_Abstract::setHttpClient()
Parameters
Name Type Description
$httpClient \Zend_Http_Client
methodpublicsetResponseType( string $responseType = json ) : \Zend_Service_Twitter_Search

set responseType

Parameters
Name Type Description
$responseType string
Returns
Type Description
\Zend_Service_Twitter_Search
Throws
Exception Description
\Zend_Service_Twitter_Exception
methodpublicsetUri( string|\Zend_Uri_Http $uri ) : \Zend_Rest_Client

Set the URI to use in the request

Inherited from: \Zend_Rest_Client::setUri()
Parameters
Name Type Description
$uri string|\Zend_Uri_Http URI for the web service
Returns
Type Description
\Zend_Rest_Client
methodpublictrends( ) : array

Get the current twitter trends. Currnetly only supports json as the return.

Returns
Type Description
array
Throws
Exception Description
\Zend_Http_Client_Exception
Documentation was generated by DocBlox 0.13.3.