\EventsForceClient

Client method for handling bootstrapping and making requests to the resources

Summary

Methods
Properties
Constants
__construct()
request()
$events
$attendees
$sessions
$people
$invoices
$payments
No constants found
No protected methods found
No protected properties found
N/A
bootstrapResources()
blankKey()
$efUri
$efApiEndpoint
$apiKey
$clientSlug
$client
N/A

Properties

$events

$events : object

Instance of Events resource class \EventsForce\Resources\Events

Type

object

$attendees

$attendees : object

Instance of Attendees resource class \EventsForce\Resources\Attendees

Type

object

$sessions

$sessions : object

Instance of Sessions resource class \EventsForce\Resources\Sessions

Type

object

$people

$people : object

Instance of People resource class \EventsForce\Resources\People

Type

object

$invoices

$invoices : object

Instance of Invoices resource class \EventsForce\Resources\Invoices

Type

object

$payments

$payments : object

Instance of Payments resource class \EventsForce\Resources\Payments

Type

object

$efUri

$efUri : string

The first part of the eventsforce api endpoint uri together: $ef_uri . {client_slug} . $ef_api_endpoint;

Type

string

$efApiEndpoint

$efApiEndpoint : string

The second part of the eventsforce api endpoint uri together: $ef_uri . {client_slug} . $ef_api_endpoint;

Type

string

$apiKey

$apiKey : string

Store the blanked api key

Type

string

$clientSlug

$clientSlug : string

Store the client slug

Type

string

$client

$client : object

Instance of our Guzzle Client

Type

object

Methods

__construct()

__construct(  $client_slug = '', string  $api_key_unblanked = '') 

Client constructor.

Parameters

$client_slug
string $api_key_unblanked

Throws

\EventsForce\Exceptions\InvalidArgumentException

request()

request(  $parameters = array()) : \EventsForce\Request

Method that creates a Request instance (EventsForce\Request)

Parameters

$parameters

Returns

\EventsForce\Request

bootstrapResources()

bootstrapResources() 

Method that bootstraps our resources

blankKey()

blankKey(  $key) : string

A method that blanks a key passed in The events force api expects a blanked key

Parameters

$key

Returns

string