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.

array
$_functions= 'array()'
array()
Details
boolean
$_returnResponse= 'false'
Whether or not {@link handle()} should send output or return the response.
Defaults to falsefalse
Details
_callObjectMethod(
string $class, array $args
)
:
mixed
Call an instance method of an object
Name | Type | Description |
---|---|---|
$class | string | |
$args | array |
Type | Description |
---|---|
mixed |
Exception | Description |
---|---|
\Zend_Rest_Server_Exception | For invalid class name |

_callStaticMethod(
string $class, array $args
)
:
mixed
Call a static class method and return the result
Name | Type | Description |
---|---|---|
$class | string | |
$args | array |
Type | Description |
---|---|
mixed |

_handleScalar(
string|int|boolean $value
)
:
string
Handle a single value
Name | Type | Description |
---|---|---|
$value | string|int|boolean | Result value |
Type | Description |
---|---|
string | XML Response |

_handleStruct(
array|object $struct
)
:
string
Handle an array or object result
Name | Type | Description |
---|---|---|
$struct | array|object | Result Value |
Type | Description |
---|---|
string | XML Response |

_structValue(
mixed $struct, \DOMDocument $dom, \DOMElement $parent
)
:
void
Recursively iterate through a struct
Recursively iterates through an associative array or object's properties to build XML response.
Name | Type | Description |
---|---|---|
$struct | mixed | |
$dom | \DOMDocument | |
$parent | \DOMElement |

addFunction(
string $function, string $namespace
=
''
)
:
void
Implement Zend_Server_Interface::addFunction()
Name | Type | Description |
---|---|---|
$function | string | Function Name |
$namespace | string | Function namespace (unused) |

fault(
$exception
=
null, int $code
=
null
)
:
\DOMDocument
Implement Zend_Server_Interface::fault()
Creates XML error response, returning DOMDocument with response.
Name | Type | Description |
---|---|---|
$exception | ||
$code | int | Error Code |
Type | Description |
---|---|
\DOMDocument |

getFunctions(
)
:
array
Implement Zend_Server_Interface::getFunctions()
Type | Description |
---|---|
array | An array of Zend_Server_Reflection_Method's |

getHeaders(
)
:
array
Retrieve any HTTP extra headers set by the server
Type | Description |
---|---|
array |

handle(
array $request
=
false
)
:
string|void
Implement Zend_Server_Interface::handle()
Name | Type | Description |
---|---|---|
$request | array |
Type | Description |
---|---|
string|void |
Exception | Description |
---|---|
\Zend_Rest_Server_Exception |

loadFunctions(
array $functions
)
:
void
Implement Zend_Server_Interface::loadFunctions()
Name | Type | Description |
---|---|---|
$functions | array |

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

returnResponse(
boolean $flag
=
null
)
:
boolean|\Zend_Rest_Server
Whether or not to return a response
If called without arguments, returns the value of the flag. If called with an argument, sets the flag.
When 'return response' is true, {@link handle()} will not send output, but will instead return the response from the dispatched function/method.
Name | Type | Description |
---|---|---|
$flag | boolean |
Type | Description |
---|---|
boolean|\Zend_Rest_Server | Returns Zend_Rest_Server when used to set the flag; returns boolean flag value otherwise. |

setClass(
string $classname, string $namespace
=
'', array $argv
=
array()
)
:
void
Implement Zend_Server_Interface::setClass()
Name | Type | Description |
---|---|---|
$classname | string | Class name |
$namespace | string | Class namespace (unused) |
$argv | array | An array of Constructor Arguments |