DataFeedInterface
Data feed interface
Table of Contents
Methods
| errors() | Retrieves any errors associated with the data feed |
| 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 |
Methods
errors()
Retrieves any errors associated with the data feed
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