\HEXONETResponseTemplateManager

HEXONET ResponseTemplateManager

Summary

Methods
Properties
Constants
getInstance()
generateTemplate()
addTemplate()
getTemplate()
getTemplates()
hasTemplate()
isTemplateMatchHash()
isTemplateMatchPlain()
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

getInstance()

getInstance() : 

Get ResponseTemplateManager Instance

Returns

generateTemplate()

generateTemplate(  code,   description) : 

Generate API response template string for given code and description

Parameters

code

API response code

description

API response description

Returns

generate response template string

addTemplate()

addTemplate(  id,   plain) : 

Add response template to template container

Parameters

id

template id

plain

API plain response

Returns

getTemplate()

getTemplate(  id) : \HEXONET\ResponseTemplate

Get response template instance from template container

Parameters

id

template id

Returns

\HEXONET\ResponseTemplate —

template instance

getTemplates()

getTemplates() : mixed|string|int

Return all available response templates

Returns

mixed|string|int —

all available response template instances

hasTemplate()

hasTemplate(  id) : 

Check if given template exists in template container

Parameters

id

template id

Returns

boolean result

isTemplateMatchHash()

isTemplateMatchHash(mixed|string|int  tpl,   id) : 

Check if given API response hash matches a given template by code and description

Parameters

mixed|string|int tpl

api response hash

id

template id

Returns

boolean result

isTemplateMatchPlain()

isTemplateMatchPlain(  plain,   id) : 

Check if given API plain response matches a given template by code and description

Parameters

plain

API plain response

id

template id

Returns

boolean result