API Documentation

Json/Server/Response/Http.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_Json  
version
$Id: Http.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Json_Server_Response_Http

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

Methods

methodpublic__toString( ) : string

Cast to string (JSON)

Inherited from: \Zend_Json_Server_Response::__toString()
Returns
Type Description
string
methodpublicgetArgs( ) : mixed

Retrieve args

Inherited from: \Zend_Json_Server_Response::getArgs()
Returns
Type Description
mixed
methodpublicgetError( ) : null|\Zend_Json_Server_Error

Get response error

Inherited from: \Zend_Json_Server_Response::getError()
Returns
Type Description
null\Zend_Json_Server_Error
methodpublicgetId( ) : mixed

Get request ID

Inherited from: \Zend_Json_Server_Response::getId()
Returns
Type Description
mixed
methodpublicgetResult( ) : mixed

Get result

Inherited from: \Zend_Json_Server_Response::getResult()
Returns
Type Description
mixed
methodpublicgetServiceMap( ) : \Zend_Json_Server_Smd|null

Retrieve service map

Inherited from: \Zend_Json_Server_Response::getServiceMap()
Returns
Type Description
\Zend_Json_Server_Smdnull
methodpublicgetVersion( ) : string

Retrieve JSON-RPC version

Inherited from: \Zend_Json_Server_Response::getVersion()
Returns
Type Description
string
methodpublicisError( ) : bool

Is the response an error?

Inherited from: \Zend_Json_Server_Response::isError()
Returns
Type Description
bool
methodpublicsendHeaders( ) : void

Send headers

If headers are already sent, do nothing. If null ID, send HTTP 204 header. Otherwise, send content type header based on content type of service map.

methodpublicsetArgs( mixed $args ) : \Zend_Json_Server_Response_Http

Set args

Inherited from: \Zend_Json_Server_Response::setArgs()
Parameters
Name Type Description
$args mixed
Returns
Type Description
\Zend_Json_Server_Response_Http
Details
fluent
This method is part of a fluent interface and will return the same instance  
methodpublicsetError( \Zend_Json_Server_Error $error ) : \Zend_Json_Server_Response

Set result error

Inherited from: \Zend_Json_Server_Response::setError()
Parameters
Name Type Description
$error \Zend_Json_Server_Error
Returns
Type Description
\Zend_Json_Server_Response
methodpublicsetId( mixed $name ) : \Zend_Json_Server_Response

Set request ID

Inherited from: \Zend_Json_Server_Response::setId()
Parameters
Name Type Description
$name mixed
Returns
Type Description
\Zend_Json_Server_Response
methodpublicsetResult( mixed $value ) : \Zend_Json_Server_Response

Set result

Inherited from: \Zend_Json_Server_Response::setResult()
Parameters
Name Type Description
$value mixed
Returns
Type Description
\Zend_Json_Server_Response
methodpublicsetServiceMap( \Zend_Json_Server_Smd $serviceMap ) : \Zend_Json_Server_Response

Set service map object

Inherited from: \Zend_Json_Server_Response::setServiceMap()
Parameters
Name Type Description
$serviceMap \Zend_Json_Server_Smd
Returns
Type Description
\Zend_Json_Server_Response
methodpublicsetVersion( string $version ) : \Zend_Json_Server_Response

Set JSON-RPC version

Inherited from: \Zend_Json_Server_Response::setVersion()
Parameters
Name Type Description
$version string
Returns
Type Description
\Zend_Json_Server_Response
methodpublictoJson( ) : string

Emit JSON

Send appropriate HTTP headers. If no Id, then return an empty string.

Returns
Type Description
string
Documentation was generated by DocBlox 0.13.3.