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_Server_Abstract

bool
$_autoEmitResponse= 'true'
Flag: whether or not to auto-emit the response
true
Details
bool
$_overwriteExistingMethods= 'true'
true
Details
__call(
string $method, array $args
)
:
mixed
Overload to accessors of SMD object
Name | Type | Description |
---|---|---|
$method | string | |
$args | array |
Type | Description |
---|---|
mixed |

__construct(
)
:
void
Constructor
Inherited from: \Zend_Server_Abstract::__construct()Setup server description

_addMethodServiceMap(
\Zend_Server_Reflection_Function $method
)
:
void
Add service method to service map
Name | Type | Description |
---|---|---|
$method | \Zend_Server_Reflection_Function |

_buildCallback(
\Zend_Server_Reflection_Function_Abstract $reflection
)
:
\Zend_Server_Method_Callback
Build callback for method signature
Inherited from: \Zend_Server_Abstract::_buildCallback()Name | Type | Description |
---|---|---|
$reflection | \Zend_Server_Reflection_Function_Abstract |
Type | Description |
---|---|
\Zend_Server_Method_Callback |

_buildSignature(
\Zend_Server_Reflection_Function_Abstract $reflection, null|string|object $class
=
null
)
:
\Zend_Server_Method_Definition
Build a method signature
Inherited from: \Zend_Server_Abstract::_buildSignature()Name | Type | Description |
---|---|---|
$reflection | \Zend_Server_Reflection_Function_Abstract | |
$class | null|string|object |
Type | Description |
---|---|
\Zend_Server_Method_Definition |
Exception | Description |
---|---|
\Zend_Server_Exception | on duplicate entry |

_dispatch(
\Zend_Server_Method_Definition $invocable, array $params
)
:
mixed
Dispatch method
Inherited from: \Zend_Server_Abstract::_dispatch()Name | Type | Description |
---|---|---|
$invocable | \Zend_Server_Method_Definition | |
$params | array |
Type | Description |
---|---|
mixed |

_fixType(
string $type
)
:
string
Translate PHP type to JSON type
Name | Type | Description |
---|---|---|
$type | string |
Type | Description |
---|---|
string |

_getDefaultParams(
array $args, array $params
)
:
array
Get default params from signature
Name | Type | Description |
---|---|---|
$args | array | |
$params | array |
Type | Description |
---|---|
array |

_getParams(
\Zend_Server_Reflection_Function_Abstract $method
)
:
string|array
Get method param type
Name | Type | Description |
---|---|---|
$method | \Zend_Server_Reflection_Function_Abstract |
Type | Description |
---|---|
stringarray |

_getReadyResponse(
)
:
\Zend_Json_Server_Response
Set response state
Type | Description |
---|---|
\Zend_Json_Server_Response |

_getReturnType(
\Zend_Server_Reflection_Function_Abstract $method
)
:
string|array
Get method return type
Name | Type | Description |
---|---|---|
$method | \Zend_Server_Reflection_Function_Abstract |
Type | Description |
---|---|
stringarray |

_getSmdMethods(
)
:
array
Retrieve list of allowed SMD methods for proxying
Type | Description |
---|---|
array |

addFunction(
string|array $function, string $namespace
)
:
\Zend_Json_Server
Attach a function or callback to the server
Namespacing is primarily for xmlrpc, but may be used with other implementations to prevent naming collisions.
Name | Type | Description |
---|---|---|
$function | string|array | Valid PHP callback |
$namespace | string | Ignored |
Type | Description |
---|---|
\Zend_Json_Server |

fault(
string $fault
=
null, int $code
=
404, $data
=
null
)
:
false
Indicate fault response
Name | Type | Description |
---|---|---|
$fault | string | |
$code | int | |
$data |
Type | Description |
---|---|
false |

getFunctions(
)
:
\Zend_Server_Definition
Returns a list of registered methods
Inherited from: \Zend_Server_Abstract::getFunctions()Returns an array of method definitions.
Type | Description |
---|---|
\Zend_Server_Definition |

getRequest(
)
:
\Zend_Json_Server_Request
Get JSON-RPC request object
Type | Description |
---|---|
\Zend_Json_Server_Request |

getResponse(
)
:
\Zend_Json_Server_Response
Get response object
Type | Description |
---|---|
\Zend_Json_Server_Response |

getServiceMap(
)
:
\Zend_Json_Server_Smd
Retrieve SMD object
Type | Description |
---|---|
\Zend_Json_Server_Smd |

handle(
\Zend_Json_Server_Request $request
=
false
)
:
null|\Zend_Json_Server_Response
Handle request
Requests may be passed in, or the server may automagically determine the request based on defaults. Dispatches server request to appropriate method and returns a response
Name | Type | Description |
---|---|---|
$request | \Zend_Json_Server_Request |
Type | Description |
---|---|
null\Zend_Json_Server_Response |

loadFunctions(
array|\Zend_Server_Definition $definition
)
:
void
Load function definitions
Used for persistence; loads a construct as returned by {@link getFunctions()}.
Name | Type | Description |
---|---|---|
$definition | array|\Zend_Server_Definition |

lowerCase(
$value, string $key
)
:
string
Lowercase's a string by reference
Name | Type | Description |
---|---|---|
$value | ||
$key | string |
Type | Description |
---|---|
string | Lower cased string |

setAutoEmitResponse(
bool $flag
)
:
\Zend_Json_Server
Set flag indicating whether or not to auto-emit response

setClass(
string $class, string $namespace, mixed $argv
=
null
)
:
\Zend_Json_Server
Register a class with the server
The individual implementations should probably allow passing a variable number of arguments in, so that developers may define custom runtime arguments to pass to server methods.
Namespacing is primarily for xmlrpc, but could be used for other implementations as well.
Name | Type | Description |
---|---|---|
$class | string | |
$namespace | string | Ignored |
$argv | mixed | Ignored |
Type | Description |
---|---|
\Zend_Json_Server |

setRequest(
\Zend_Json_Server_Request $request
)
:
\Zend_Json_Server
Set request object
Name | Type | Description |
---|---|---|
$request | \Zend_Json_Server_Request |
Type | Description |
---|---|
\Zend_Json_Server |

setResponse(
\Zend_Json_Server_Response $response
)
:
\Zend_Json_Server
Set response object
Name | Type | Description |
---|---|---|
$response | \Zend_Json_Server_Response |
Type | Description |
---|---|
\Zend_Json_Server |