1. class
  2. XELOS
  3. \
  4. Modules
  5. \
  6. Webservice
  7. \
  8. Page
  9. \
  10. RestPage

RestPage

class RestPage extends JsonPage

Properties

WebserviceController $mod
protected $default_page from  Page

Methods

ModuleService|null
getModuleServiceHook(string $moduleName, string $methodName)

No description

from  JsonPage
string
get_json_error(string $message, int $code = -32603, array $data = [], bool $isRestStyle = false)

JSON-RPC Error

from  JsonPage
xelos_global_template|string|bool
get_page(string $resourcePath = null)

No description

string
handleFileUploadToSystemDMS()

Small endpoint wrapper to call the upload service

from  JsonPage
string
invokeServiceMethod(string|Service $instance_id, string $method_name, array $parameters, int $groupContext = null)

No description

from  JsonPage
Template
page_json_docs(?string $instance = null)

JSON Documentation based on SOAP Services

from  JsonPage

Details

in JsonPage at line 213
protected ModuleService|null getModuleServiceHook(string $moduleName, string $methodName)

No description

Parameters

string $moduleName
string $methodName

Return Value

ModuleService|null

in JsonPage at line 180
protected string get_json_error(string $message, int $code = -32603, array $data = [], bool $isRestStyle = false)

JSON-RPC Error

Parameters

string $message

A String providing a short description of the error. The message SHOULD be limited to a concise single sentence.
int $code

A Number that indicates the error type that occurred. This MUST be an integer.
array $data

A Primitive or Structured value that contains additional information about the error. This may be omitted. The value of this member is defined by the Server (e.g. detailed error information, nested errors etc.).
bool $isRestStyle

Used in RestPage to differentiate REST-style error messages from JSON RPC messages

Return Value

string

JSON Format

at line 38
xelos_global_template|string|bool get_page(string $resourcePath = null)

No description

Parameters

string $resourcePath

Return Value

xelos_global_template|string|bool

Exceptions

ContentException

in JsonPage at line 493
string handleFileUploadToSystemDMS()

Small endpoint wrapper to call the upload service

Return Value

string

in JsonPage at line 243
protected string invokeServiceMethod(string|Service $instance_id, string $method_name, array $parameters, int $groupContext = null)

No description

Parameters

string|Service $instance_id
string $method_name

Function name containing module name, hook name and method name
array $parameters
int $groupContext

Local Group ID

Return Value

string

An empty string, since the output is already written to the stdout

Exceptions

ReflectionException
Exception

in JsonPage at line 345
Template page_json_docs(?string $instance = null)

JSON Documentation based on SOAP Services

Parameters

?string $instance

Return Value

Template