DataFeed
Data Feed Utility
Attributes
- #[AllowDynamicProperties]
Table of Contents
Methods
| execute() | Executes a data feed endpoint |
| get() | Retrieve an instance of the data feed |
| getOptions() | Fetches the default options for the data feed |
Methods
execute()
Executes a data feed endpoint
public
static execute(string $feed, string $endpoint[, array<string|int, mixed> $vars = [] ][, int $company_id = null ][, string $dir = null ]) : mixed
Parameters
- $feed : string
-
The class name of the data feed to instantiate
- $endpoint : string
-
The endpoint to execute through the data feed
- $vars : array<string|int, mixed> = []
-
An array containing the parameters for the request
- $company_id : int = null
-
The ID of the company where the data feed will be executed
- $dir : string = null
-
The plugin directory where the data feed class is located
Return values
mixed —The response of the data feed
get()
Retrieve an instance of the data feed
public
static get(string $feed[, int $company_id = null ][, string $dir = null ]) : mixed
Parameters
- $feed : string
-
The class name of the data feed to instantiate
- $company_id : int = null
-
The ID of the company where the data feed will be executed
- $dir : string = null
-
The plugin directory where the data feed class is located
Return values
mixed —The response of the data feed
getOptions()
Fetches the default options for the data feed
public
static getOptions(string $feed[, int $company_id = null ][, string $dir = null ]) : array<string|int, mixed>
Parameters
- $feed : string
-
The class name of the data feed to instantiate
- $company_id : int = null
-
The ID of the company where the options will be fetched
- $dir : string = null
-
The plugin directory where the data feed class is located
Return values
array<string|int, mixed> —A list containing the data feed options for the current company