SelfDocumentingServerTrait
Table of Contents
Properties
- $default_doclang : mixed
- $default_doctype : string
- $editorpath : string|null
- $execute_on_form_submit : bool
- $supported_doctypes : array<string|int, string>
- $supported_langs : array<string|int, string>
- $documentationGenerator : mixed
- $templates : array<string|int, string>
Methods
- setTemplate() : void
- generateDocs() : string
- getTemplates() : array<string|int, mixed>
- handleNonRPCRequest() : mixed
Properties
$default_doclang
public
mixed
$default_doclang
= 'en'
$default_doctype
public
string
$default_doctype
= 'html'
default format for generated documentation: either wsdl or html
$editorpath
public
string|null
$editorpath
= ''
relative path to the visual xml-rpc editing dialog
$execute_on_form_submit
public
bool
$execute_on_form_submit
= true
$supported_doctypes
public
array<string|int, string>
$supported_doctypes
= array('html', 'wsdl')
$supported_langs
public
array<string|int, string>
$supported_langs
= array('en')
$documentationGenerator
protected
mixed
$documentationGenerator
$templates
protected
array<string|int, string>
$templates
= array()
Methods
setTemplate()
public
setTemplate(string $name, string $contents) : void
Parameters
- $name : string
- $contents : string
generateDocs()
protected
generateDocs([string $doctype = 'html' ][, string $lang = 'en' ][, string $editorPath = '' ][, bool $displayExecutionForm = true ]) : string
Parameters
- $doctype : string = 'html'
- $lang : string = 'en'
- $editorPath : string = ''
- $displayExecutionForm : bool = true
Return values
stringgetTemplates()
protected
getTemplates() : array<string|int, mixed>
Return values
array<string|int, mixed>handleNonRPCRequest()
protected
handleNonRPCRequest(mixed $docType, mixed $returnPayload) : mixed
Parameters
- $docType : mixed
- $returnPayload : mixed