Rest/Client.php
Show:
inherited
inherited
Classes
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_Rest
- Subpackage
- Client
- Version
- $Id$
\Zend_Rest_Client
Package: Zend_Rest\Client
Returns
Returns
- Parent(s)
- \Zend_Service_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
array $_data = array()Data for the query
Default value
array()Details- Type
- array
bool $_noReset = falseFlag indicating the Zend_Http_Client is fresh and needs no reset.
Must be set explicitly if you want to keep preset parameters.
Default valuefalseDetails- Type
- bool
Methods
__call(string $method, array $args) : \Zend_Rest_Client_Result | \Zend_Rest_ClientMethod call overload
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):
Parameters
$response = $rest->sayHello('Foo', 'Manchu')->get();
Or use them together, but in sequential calls:
$rest->sayHello('Foo', 'Manchu');
$response = $rest->get();
| Name | Type | Description |
|---|---|---|
| $method | string | Method name |
| $args | array | Method args |
| 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 |
__construct(string | \Zend_Uri_Http $uri = null) : voidConstructor
Parameters
| Name | Type | Description |
|---|---|---|
| $uri | string | \Zend_Uri_Http | URI for the web service |
_performPost(mixed $method, mixed $data = null) : \Zend_Http_ResponsePerform a POST or PUT
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 |
| Type | Description |
|---|---|
| \Zend_Http_Response |
_prepareRest(string $path) : voidCall a remote REST web service URI and return the Zend_Http_Response object
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $path | string | The path to append to the URI |
| Exception | Description |
|---|---|
| \Zend_Rest_Client_Exception |
getUri() : \Zend_Uri_HttpRetrieve the current request URI object
Returns
| Type | Description |
|---|---|
| \Zend_Uri_Http |
restDelete(string $path, $data = null) : \Zend_Http_ResponsePerforms an HTTP DELETE request to $path.
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $path | string | |
| $data |
| Type | Description |
|---|---|
| \Zend_Http_Response |
| Exception | Description |
|---|---|
| \Zend_Http_Client_Exception |
restGet(string $path, array $query = null) : \Zend_Http_ResponsePerforms an HTTP GET request to the $path.
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $path | string | |
| $query | array | Array of GET parameters |
| Type | Description |
|---|---|
| \Zend_Http_Response |
| Exception | Description |
|---|---|
| \Zend_Http_Client_Exception |
restPost(string $path, mixed $data = null) : \Zend_Http_ResponsePerforms an HTTP POST request to $path.
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $path | string | |
| $data | mixed | Raw data to send |
| Type | Description |
|---|---|
| \Zend_Http_Response |
| Exception | Description |
|---|---|
| \Zend_Http_Client_Exception |
restPut(string $path, mixed $data = null) : \Zend_Http_ResponsePerforms an HTTP PUT request to $path.
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $path | string | |
| $data | mixed | Raw data to send in request |
| Type | Description |
|---|---|
| \Zend_Http_Response |
| Exception | Description |
|---|---|
| \Zend_Http_Client_Exception |
setNoReset(boolean $bool = true) : voidTells Zend_Rest_Client not to reset all parameters on it's Zend_Http_Client. If you want no reset, this must be called explicitly before every request for which you do not want to reset the parameters.
Parameters will accumulate between requests, but as soon as you do not
call this function prior to any request, all preset parameters will be reset
as by default.
Parameters| Name | Type | Description |
|---|---|---|
| $bool | boolean |
setUri(string | \Zend_Uri_Http $uri) : \Zend_Rest_ClientSet the URI to use in the request
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $uri | string | \Zend_Uri_Http | URI for the web service |
| Type | Description |
|---|---|
| \Zend_Rest_Client |