\RevelRevel

Summary

Methods

Properties

Constants

__construct()
guzzle()
auth()
fullUrl()
categories()
products()
establishments()
ordering()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

_provider()

$_domain
$_secret
$_key
$_client
$_providers

N/A

File: Revel.php
Package: Default
Class hierarchy: \Revel\Revel

Properties

$_domain

$_domain : string

Type

string

$_secret

$_secret : string

Type

string

$_key

$_key : string

Type

string

$_client

$_client : \GuzzleHttp\Client

Type

\GuzzleHttp\Client

$_providers

$_providers : array<mixed,\Revel\Api\Api>

Type

array<mixed,\Revel\Api\Api>

Methods

__construct()

__construct(string  $domain, string  $secret, string  $key)

Revel constructor.

Parameters

string	$domain	The Revel domain prefix.
string	$secret	The Revel API secret, provided by Revel.
string	$key	The Revel API key, provided by Revel.

guzzle()

guzzle() : \GuzzleHttp\Client

Get the Guzzle client.

Returns

\GuzzleHttp\Client

auth()

auth() : string

Get the API-AUTHENTICATION header.

Returns

string

fullUrl()

fullUrl() : string

Get the full API URL e.g. `https://<domain>.revelup.com`. Never contains a trailing slash.

Returns

string

categories()

categories() : \Revel\Api\Categories

Returns

\Revel\Api\Categories

products()

products() : \Revel\Api\Products

Returns

\Revel\Api\Products

establishments()

establishments() : \Revel\Api\Establishments

Returns

\Revel\Api\Establishments

ordering()

ordering() : \Revel\Api\Ordering

Returns

\Revel\Api\Ordering

_provider()

_provider(string  $name) : \Revel\Api\Api|mixed

Get an API provider.

Parameters

string

$name

The API provider name.

Returns

\Revel\Api\Api|mixed