\Linusx\Empyr\ControllersEmpyrVenue

Class EmpyrVenue.

Summary

Methods
Properties
Constants
__construct()
venue()
search()
searchByPhone()
segmented()
summary()
userVenueTotals()
add()
addPhoto()
bookmark()
removeBookmark()
removePhoto()
update()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

__construct()

__construct(array  $data = array()) 

Empyr Venue Constructor.

Parameters

array $data

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

venue()

venue(integer  $venue_id) : boolean|mixed

Returns the venue with the associated id.

Parameters

integer $venue_id

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

boolean|mixed

search()

search(array  $options = array()) : boolean|mixed

Searches the venue directory for active venues with the given parameters.

Parameters

array $options

Throws

\GuzzleHttp\Exception\GuzzleException

Returns

boolean|mixed

searchByPhone()

searchByPhone(string  $phone_number) : boolean|mixed

Searches the venue directory for venues by phone.

Parameters

string $phone_number

Throws

\GuzzleHttp\Exception\GuzzleException

Returns

boolean|mixed

segmented()

segmented() : boolean|mixed

Returns all the businesses that require segmentation data.

Throws

\GuzzleHttp\Exception\GuzzleException

Returns

boolean|mixed

summary()

summary(integer  $venue_id, array  $options = array()) : boolean|mixed

Retrieves the summary of information and data about a business for a given number of months.

Parameters

integer $venue_id
array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

boolean|mixed

userVenueTotals()

userVenueTotals(integer  $venue_id, array  $options = array()) : boolean|mixed

Returns user venue totals for the given month. Can be used to build leaderboards.

Parameters

integer $venue_id
array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

boolean|mixed

add()

add(array  $options = array()) : boolean|mixed

Creates a new business in the business directory.

Parameters

array $options

Throws

\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields
\GuzzleHttp\Exception\GuzzleException

Returns

boolean|mixed

addPhoto()

addPhoto(string  $file_path, array  $options = array()) : boolean|mixed

Add a new business image.

Parameters

string $file_path

File path to send.

array $options

Throws

\GuzzleHttp\Exception\GuzzleException
\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields

Returns

boolean|mixed

bookmark()

bookmark(integer  $venue_id, array  $options = array()) : boolean|mixed

Bookmarks the business for the authenticated user.

Parameters

integer $venue_id
array $options

Throws

\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields
\GuzzleHttp\Exception\GuzzleException

Returns

boolean|mixed

removeBookmark()

removeBookmark(integer  $venue_id, array  $options = array()) : boolean|mixed

Removes the venue bookmark for the authenticated user.

Parameters

integer $venue_id
array $options

Throws

\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields
\GuzzleHttp\Exception\GuzzleException

Returns

boolean|mixed

removePhoto()

removePhoto(integer  $venue_id, array  $options = array()) : boolean|mixed

Removes the venue bookmark for the authenticated user.

Parameters

integer $venue_id
array $options

Throws

\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields
\GuzzleHttp\Exception\GuzzleException

Returns

boolean|mixed

update()

update(array  $options = array()) : boolean|mixed

Updates a business in the business directory.

Parameters

array $options

Throws

\Linusx\Empyr\Exceptions\EmpyrMissingRequiredFields
\GuzzleHttp\Exception\GuzzleException

Returns

boolean|mixed