\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

File: Controllers/EmpyrVenue.php
Package: Empyr
Class hierarchy: \Linusx\Empyr\Controllers\EmpyrController

\Linusx\Empyr\Controllers\EmpyrVenue

Tags

None found

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

Tags

mogl	https://www.mogl.com/api/docs/v2/Venues/get

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

Tags

mogl

https://www.mogl.com/api/docs/v2/Venues/search

options

query A user entered query to search venues by.
queryLocation A user entered location to search venues by (could be a city/state or zip).
city The name of a city to search in. Not required if lat and long are provided.
state The two letter abbreviation of the state. Required if city is provided.
lat Specific latitude to search within. If specified then requires long and distance.
long Specific longitude to search within. If specified then requires lat and distance.
page Page number of results.
numResults Number of results to return per page.
checkBookmarks Whether to check whether the results are in bookmarks (and mark them)
checkLinks Whether to check whether the offers have links to the current user.
featured Whether to only return featured businesses.
sort The sort order for the business.
cities multi A list of cities to restrict the results to. (Use facet filtering).
distance A distance filter to restrict results to.
attributes multi A list of attributes to restrict the results to. (Use facet filtering).
categories multi A list of categories to restrict the results to. (Use facet filtering).
features multi A list of features to restrict the results to. (Use facet filtering).
ambiances multi A list of ambiances to restrict the results to. (Use facet filtering).
serves multi A list of serves to restrict the results to. (Use facet filtering).
priceRanges multi A list of priceranges to restrict the results to. (Use facet filtering).
bestNights multi A list of best nights to restrict the results to. (Use facet filtering).
minRating Minimum rating for the business.
facet Return a facet map for filtering results. Defaults to false for better performance.

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

Tags

mogl	https://www.mogl.com/api/docs/v2/Venues/searchByPhone

segmented()

segmented() : boolean|mixed

Returns all the businesses that require segmentation data.

Throws

\GuzzleHttp\Exception\GuzzleException

Returns

boolean|mixed

Tags

mogl	https://www.mogl.com/api/docs/v2/Venues/segmented

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

Tags

mogl	https://www.mogl.com/api/docs/v2/Venues/summary

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

Tags

mogl	https://www.mogl.com/api/docs/v2/Venues/userVenueTotals
options	user The id of the specific user we want to find totals for. date The month that we want to look at totals for. If not provided then will be the most current. page Page number of results. numResults Number of results to return per page.

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

Tags

mogl	https://www.mogl.com/api/docs/v2/Venues/add

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

Tags

mogl	https://www.mogl.com/api/docs/v2/Venues/addPhoto

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

Tags

mogl	https://www.mogl.com/api/docs/v2/Venues/bookmark

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

Tags

mogl	https://www.mogl.com/api/docs/v2/Venues/removeBookmark

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

Tags

mogl	https://www.mogl.com/api/docs/v2/Venues/removePhoto
todo	Not working. Have to figure out what 'media' is.

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

Tags

mogl	https://www.mogl.com/api/docs/v2/Venues/update