Base
in package
Base caching class.
Tags
Table of Contents
- $config : array<string|int, mixed>
- Config data.
- $customFields : array<string|int, mixed>
- Custom Fields.
- $docUrl : string
- Provider documentation url address.
- $name : string
- Provider name.
- __construct() : mixed
- Construct.
- find() : array<string|int, mixed>
- Find address.
- getCustomFields() : array<string|int, mixed>
- Get provider custom fields.
- getDataFromRequest() : array<string|int, mixed>
- Gets data from request.
- getDocUrl() : string
- Get provider documentation url address.
- getName() : string
- Get provider name.
- isActive() : bool
- Function checks if provider is active.
- isConfigured() : bool
- Function checks if provider been configured?
- validate() : bool
- Validate configuration.
Properties
$config
Config data.
public
array<string|int, mixed>
$config
$customFields
Custom Fields.
public
array<string|int, mixed>
$customFields
= []
$docUrl
Provider documentation url address.
public
string
$docUrl
= ''
$name
Provider name.
public
string
$name
Methods
__construct()
Construct.
public
__construct() : mixed
Return values
mixed —find()
Find address.
public
abstract find( $value) : array<string|int, mixed>
Parameters
Return values
array<string|int, mixed> —getCustomFields()
Get provider custom fields.
public
getCustomFields([array<string|int, mixed> $data = [] ]) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed> = []
Return values
array<string|int, mixed> —getDataFromRequest()
Gets data from request.
public
getDataFromRequest(Request $request) : array<string|int, mixed>
Parameters
- $request : Request
Return values
array<string|int, mixed> —getDocUrl()
Get provider documentation url address.
public
getDocUrl() : string
Return values
string —getName()
Get provider name.
public
getName() : string
Return values
string —isActive()
Function checks if provider is active.
public
isActive() : bool
Return values
bool —isConfigured()
Function checks if provider been configured?
public
isConfigured() : bool
Return values
bool —validate()
Validate configuration.
public
validate() : bool