API Documentation

Zend/Json/Server/Response.php

Show: inherited
Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Json  
Subpackage
Server  
Version
$Id: Response.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Json_Server_Response

Package: Zend\Json\Server

Children
\Zend_Json_Server_Response_Http
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectednull|\Zend_Json_Server_Error  $_error= ''

Response error

Details
Type
null\Zend_Json_Server_Error
Propertyprotectedmixed  $_id= ''

Request ID

Details
Type
mixed
Propertyprotectedmixed  $_result= ''

Result

Details
Type
mixed
Propertyprotected\Zend_Json_Server_Smd  $_serviceMap= ''

Service map

Details
Type
\Zend_Json_Server_Smd
Propertyprotectedstring  $_version= ''

JSON-RPC version

Details
Type
string

Methods

methodpublic__toString( ) : string

Cast to string (JSON)

Returns
Type Description
string
methodpublicgetArgs( ) : mixed

Retrieve args

Returns
Type Description
mixed
methodpublicgetError( ) : null|\Zend_Json_Server_Error

Get response error

Returns
Type Description
null|\Zend_Json_Server_Error
methodpublicgetId( ) : mixed

Get request ID

Returns
Type Description
mixed
methodpublicgetResult( ) : mixed

Get result

Returns
Type Description
mixed
methodpublicgetServiceMap( ) : \Zend_Json_Server_Smd|null

Retrieve service map

Returns
Type Description
\Zend_Json_Server_Smd|null
methodpublicgetVersion( ) : string

Retrieve JSON-RPC version

Returns
Type Description
string
methodpublicisError( ) : bool

Is the response an error?

Returns
Type Description
bool
methodpublicsetArgs( mixed $args ) : \Zend_Json_Server_Response

Set args

Parameters
Name Type Description
$args mixed
Returns
Type Description
\Zend_Json_Server_Response
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

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

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

Set result

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

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

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

Cast to JSON

Returns
Type Description
string
Documentation was generated by DocBlox 0.15.1.