API Documentation
\

\ExampleService

This is a test/example service. Remove it for production use

Summary

Methods
Properties
Constants
returnOneParam()
returnSum()
returnNull()
returnBla()
throwException()
returnAfterOneSecond()
returnTestHeader()
_reservedMethod()
returnArray()
returnOpposite()
returnBitwiseAnd()
staticReturnOneParam()
returnLargeDataSet()
returnLargeTypedDataSet()
manyParams()
testAmfphpHide()
testArrayCollection()
testComplicatedTypedObj()
testCustomMonitorTime()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

returnOneParam()

returnOneParam(mixed $param) : mixed

return one param

Parameters

mixed $param

example: {"_explicitType":"myType", "intVal":2, "stringVal":"bla", "arrayVal":[1,2, "ert"]}

Returns

mixed

returnSum()

returnSum(integer $number1, integer $number2) : integer

return sum

Parameters

integer $number1

example: 2
integer $number2

example: 3

Returns

integer

returnNull()

returnNull() : null

return null

Returns

null

returnBla()

returnBla() : String

return bla

Returns

String

throwException()

throwException(string $arg1)

throy exception

Parameters

string $arg1

Throws

\Exception

returnAfterOneSecond()

returnAfterOneSecond() : String

return after one second

Returns

String

returnTestHeader()

returnTestHeader() : mixed

return test header

Returns

mixed

_reservedMethod()

_reservedMethod()

shouldn't appear in the service browser or be available as a service

returnArray()

returnArray() : array

return array

Returns

array

returnOpposite()

returnOpposite(boolean $value) : boolean

return opposite

Parameters

boolean $value

Returns

boolean

returnBitwiseAnd()

returnBitwiseAnd(boolean $value1, boolean $value2) : boolean

return bitwise and

Parameters

boolean $value1
boolean $value2

Returns

boolean

staticReturnOneParam()

staticReturnOneParam(mixed $param) : mixed

static return one param

Parameters

mixed $param

Returns

mixed

returnLargeDataSet()

returnLargeDataSet(integer $numItems) : array

use to test for serialization performance. Each item contains a random int, float, and string

Parameters

integer $numItems

example: 1000

Returns

array

returnLargeTypedDataSet()

returnLargeTypedDataSet(integer $numItems) : array

use to test Vo conversion performance. Each item contains a random int, float, and string, and is typed

Parameters

integer $numItems

example: 1000

Returns

array

manyParams()

manyParams(\type $a, \type $b, \type $c, \type $d, \type $e, \type $f)

dummy function to see how the backoffice tools react when there are many parameters.

Parameters

\type $a
\type $b
\type $c
\type $d
\type $e
\type $f

testAmfphpHide()

testAmfphpHide()

simply to see if this doesn't appear in the back office, but is still callable

testArrayCollection()

testArrayCollection(array $data)

receives an array(flex array collections are deserialized to arrays), and sends back an array collection.

Parameters

array $data

testComplicatedTypedObj()

testComplicatedTypedObj(mixed $param)

useful for testing a messy, nested typed obj

Parameters

mixed $param

example: {"_explicitType":"UserVo1", "name":"ariel", "status":"bla", "sub1": {"_explicitType":"Sub1", "name":"ariel", "status":"bla", "sub2": {"_explicitType":"Sub2", "name":"ariel", "status":"bla"}, "sub2again": {"_explicitType":"Sub2", "name":"ariel2", "status":"bla2"}}}

testCustomMonitorTime()

testCustomMonitorTime()

adds custom markers for monitoring