ServiceFeed extends AbstractDataFeed
Service feed
Table of Contents
Properties
| $Html | |
| $options |
Methods
| __construct() | Initialize client feed |
| errors() | Retrieves any errors associated with the captcha |
| get() | Executes and returns the result of a given endpoint |
| getDescription() | Returns the description of the data feed |
| getName() | Returns the name of the data feed |
| getOptionFields() | Gets a list of the options input fields |
| setOptions() | Sets options for the data feed |
| setErrors() | Sets the given errors |
| countEndpoint() | Gets the number of services of a particular status or module |
Methods
__construct()
Initialize client feed
public
__construct() : mixed
errors()
Retrieves any errors associated with the captcha
public
errors() : array<string|int, mixed>
Return values
array<string|int, mixed> —An array of errors
get()
Executes and returns the result of a given endpoint
public
get(string $endpoint[, array<string|int, mixed> $vars = [] ]) : mixed
Parameters
- $endpoint : string
-
The endpoint to execute
- $vars : array<string|int, mixed> = []
-
An array containing the feed parameters
Return values
mixed —The data feed response
getDescription()
Returns the description of the data feed
public
getDescription() : string
Return values
string —The description of the data feed
getName()
Returns the name of the data feed
public
getName() : string
Return values
string —The name of the data feed
getOptionFields()
Gets a list of the options input fields
public
getOptionFields([array<string|int, mixed> $vars = [] ]) : InputFields
Parameters
- $vars : array<string|int, mixed> = []
-
An array containing the posted fields
Return values
InputFields —An object representing the list of input fields
setOptions()
Sets options for the data feed
public
setOptions(array<string|int, mixed> $options) : mixed
Parameters
- $options : array<string|int, mixed>
-
An array of options
setErrors()
Sets the given errors
protected
setErrors(array<string|int, mixed> $errors) : mixed
Parameters
- $errors : array<string|int, mixed>
-
An array of error messages in the format:
- ['name' => ['type' => 'Error Message']]
countEndpoint()
Gets the number of services of a particular status or module
private
countEndpoint(array<string|int, mixed> $vars) : mixed
Parameters
- $vars : array<string|int, mixed>
-
An array containing the following items:
- status The status type of the clients to fetch ('active', 'inactive', 'fraud', default null for all)
- module The class (in snake_case) of the module