FormService extends Service
in package
Uses ServiceTrait, CacheTrait

This is the Data Validation service class.

This class will retrieve the Data Validations from LogiCommerce API and transform them to objects. All the needed Data Validations operations previous to Framework must be done here.

Tags
see
FormService::getDataValidations()
see
FormService::getDataValidation()
see
FormService::customFormSendData()
see
FormService::customFormSendMail()
see
DataValidation
see
FormService::addGetDataValidations()
see
FormService::addGetDataValidation()
see
BatchRequests
see
Service
see
ServiceTrait
see
CacheTrait
uses
ServiceTrait
uses
CacheTrait

Table of Contents

DATA_VALIDATOR_HEADER  = 'dataValidator'
DELETE  = \SDK\Core\Enums\MethodType::DELETE
GET  = \SDK\Core\Enums\MethodType::GET
ITEMS  = 'items'
POST  = \SDK\Core\Enums\MethodType::POST
PUT  = \SDK\Core\Enums\MethodType::PUT
addGetDataValidation() Add the request to get the data validation that matches the given public identifier  : void
addGetDataValidations() Add the request to get the website available data validations  : void
customFormSendData() Submit a form with information and custom fields.  : Status|null
customFormSendMail() Submit an email with information and attachments.  : Status|null
getDataValidation() Returns the data validation that matches the given public identifier  : DataValidation|null
getDataValidations() Returns the website available data validations  : ElementCollection|null
getInstance() Returns the requested model instance.  : Service
__construct()  : mixed
call()  : array<string|int, mixed>
extractParameters()  : array<string|int, mixed>
getCollection()  : mixed
getConnection()  : Connection
getElement()  : Element|null
getElements()  : ElementCollection|null
getResourceElement()  : Element|null
getResponse()  : ElementCollection|null
prepareElement()  : Element|null
prepareElements()  : array<string|int, mixed>
replaceWildcards()  : string

Constants

DATA_VALIDATOR_HEADER

public mixed DATA_VALIDATOR_HEADER = 'dataValidator'

DELETE

protected mixed DELETE = \SDK\Core\Enums\MethodType::DELETE

GET

protected mixed GET = \SDK\Core\Enums\MethodType::GET

ITEMS

protected mixed ITEMS = 'items'

POST

protected mixed POST = \SDK\Core\Enums\MethodType::POST

PUT

protected mixed PUT = \SDK\Core\Enums\MethodType::PUT

Methods

addGetDataValidation()

Add the request to get the data validation that matches the given public identifier

public addGetDataValidation(BatchRequests $batchRequests, string $batchName, int $id) : void
Parameters
$batchRequests : BatchRequests
$batchName : string

the name that will identify the request on the batch return.

$id : int
Return values
void —

addGetDataValidations()

Add the request to get the website available data validations

public addGetDataValidations(BatchRequests $batchRequests, string $batchName[, string $type = '' ]) : void
Parameters
$batchRequests : BatchRequests
$batchName : string

the name that will identify the request on the batch return.

$type : string = ''
Return values
void —

getDataValidation()

Returns the data validation that matches the given public identifier

public getDataValidation(int $id) : DataValidation|null
Parameters
$id : int
Return values
DataValidation|null —

getInstance()

Returns the requested model instance.

public static getInstance() : Service

If is not setted, this method will set it.

Return values
Service —

__construct()

protected __construct() : mixed
Return values
mixed —

call()

protected call(Request $request[, string $apiUrl = null ]) : array<string|int, mixed>
Parameters
$request : Request
$apiUrl : string = null
Return values
array<string|int, mixed> —

extractParameters()

protected extractParameters([ParametersGroup|null $parametersGroup = null ]) : array<string|int, mixed>
Parameters
$parametersGroup : ParametersGroup|null = null
Return values
array<string|int, mixed> —

getCollection()

protected getCollection(array<string|int, mixed> $data, string $class) : mixed
Parameters
$data : array<string|int, mixed>
$class : string
Return values
mixed —

getElement()

protected getElement(string $class, string $resource[, int $id = null ][, mixed $params = null ]) : Element|null
Parameters
$class : string
$resource : string
$id : int = null
$params : mixed = null
Return values
Element|null —

getResourceElement()

protected getResourceElement(string $class, string $resource[, mixed $params = [] ]) : Element|null
Parameters
$class : string
$resource : string
$params : mixed = []
Return values
Element|null —

getResponse()

protected getResponse(array<string|int, mixed> $data, string $class) : ElementCollection|null
Parameters
$data : array<string|int, mixed>
$class : string
Return values
ElementCollection|null —

prepareElement()

protected prepareElement(array<string|int, mixed> $data, string $class) : Element|null
Parameters
$data : array<string|int, mixed>
$class : string
Return values
Element|null —

prepareElements()

protected prepareElements(array<string|int, mixed> $data, string $class) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
$class : string
Return values
array<string|int, mixed> —

replaceWildcards()

protected replaceWildcards(string $resource, array<string|int, mixed> $wildcards) : string
Parameters
$resource : string
$wildcards : array<string|int, mixed>
Return values
string —

Search results