API Documentation
\
mindpowered
reservedseating

\mindpowered\reservedseatingReservedSeating

An Library for Reserved Seating Venues have Seats, Events are at Venues Reservations are Seats at Events

Summary

Methods
Properties
Constants
__construct()
CreateVenue()
CreateVenueConfiguration()
CreateSeat()
CreateEvent()
CreateTable()
CreateOrder()
GetVenue()
GetVenueConfiguration()
GetSeat()
GetEvent()
GetTable()
UpdateVenue()
UpdateVenueConfiguration()
UpdateSeat()
UpdateEvent()
UpdateTable()
DeleteVenue()
DeleteVenueConfiguration()
DeleteSeat()
DeleteEvent()
DeleteTable()
DeleteOrder()
CompleteOrder()
AddSeatToOrder()
ContinueOrder()
AutoSelect()
CancelEvent()
CancelReservation()
GetSeatsAndTablesForEvent()
FindAbandonedOrders()
GetOrdersForUser()
GetAllEventsOnSale()
UpdateVenueConfigurationAvailability()
GetVenueConfigurations()
GetOrderSummary()
GetAllVenuesByOwner()
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()

ReservedSeating

CreateVenue()

CreateVenue(string  $ownerId, string  $name, float  $maxPeople) : string

Create a new venue

Parameters

string $ownerId

Who is responsible for this venue
string $name

Name of Venue
float $maxPeople

Maximum people permitted in venue

Returns

string —

the id of the new venue

CreateVenueConfiguration()

CreateVenueConfiguration(string  $venueId, string  $name, float  $maxPeople) : string

Create a new Venue Congiguration

Parameters

string $venueId

Venue
string $name

Name of Venue Configuration
float $maxPeople

Maximum number of people permitted in this Venue Configuration

Returns

string —

the id of the new Venue Configuration

CreateSeat()

CreateSeat(string  $name, string  $seatClass, string  $venueConfigId, array  $nextTo, string  $tableId, object  $geometry) : string

Create a new seat

Parameters

string $name

The seat name
string $seatClass

The class of seat
string $venueConfigId

the Venue Configuration the seat belongs to
array $nextTo

the seats that are next to this one
string $tableId

the table this seat is at
object $geometry

Information about where the Seat is

Returns

string —

the id of the new seat

CreateEvent()

CreateEvent(string  $ownerId, string  $venueConfigId, float  $maxPeople) : string

Create a new Event

Parameters

string $ownerId

Who is responsible for this event
string $venueConfigId

Venue Configuration to use for this event
float $maxPeople

Maximum people permitted in venue

Returns

string —

the id of the new Event

CreateTable()

CreateTable(string  $venueConfigId, float  $minSeats, float  $maxSeats, object  $geometry) : string

Create a new Table

Parameters

string $venueConfigId

Venue Configuration to use for this event
float $minSeats

Minimum number of people in a party to reserve the table
float $maxSeats

Maximum number of people that can sit at this table
object $geometry

Information about where the Table is

Returns

string —

the id of the new Table

CreateOrder()

CreateOrder(string  $userId, string  $eventId, float  $expires) : string

Create a new Order

Parameters

string $userId

The user who is placing the reservation
string $eventId

The event that the order is for
float $expires

Timestamp when order expires and is considered abondoned

Returns

string —

the id of the new Order

GetVenue()

GetVenue(string  $id) : object

Get a Venue

Parameters

string $id

Venue ID

Returns

object —

the Venue data as an object

GetVenueConfiguration()

GetVenueConfiguration(string  $id) : object

Get a Venue Configuration

Parameters

string $id

Venue Configuration ID

Returns

object —

the VenueConfiguration data as an object

GetSeat()

GetSeat(string  $id) : object

Get a Seat

Parameters

string $id

Seat ID

Returns

object —

the Seat data as an object

GetEvent()

GetEvent(string  $id) : object

Get an Event

Parameters

string $id

Event ID

Returns

object —

the Event data as an object

GetTable()

GetTable(string  $id) : object

Get a Table

Parameters

string $id

Table ID

Returns

object —

the Table data as an object

UpdateVenue()

UpdateVenue(object  $data, boolean  $complete) : void

Update a Venue

Parameters

object $data

Venue data to update
boolean $complete

if set to true, missing fields should be deleted

UpdateVenueConfiguration()

UpdateVenueConfiguration(object  $data, boolean  $complete) : void

Update a Venue Configuration

Parameters

object $data

Venue Configuration data to update
boolean $complete

if set to true, missing fields should be deleted

UpdateSeat()

UpdateSeat(object  $data, boolean  $complete) : void

Update a Seat

Parameters

object $data

Seat data to update
boolean $complete

if set to true, missing fields should be deleted

UpdateEvent()

UpdateEvent(object  $data, boolean  $complete) : void

Update an Event

Parameters

object $data

Event data to update
boolean $complete

if set to true, missing fields should be deleted

UpdateTable()

UpdateTable(object  $data, boolean  $complete) : void

Update a Table

Parameters

object $data

Table data to update
boolean $complete

if set to true, missing fields should be deleted

DeleteVenue()

DeleteVenue(string  $id) : void

Delete a Venue

Parameters

string $id

Venue ID

DeleteVenueConfiguration()

DeleteVenueConfiguration(string  $id) : void

Delete a Venue Configuration Must be unavailable first

Parameters

string $id

Venue Configuration ID

DeleteSeat()

DeleteSeat(string  $id) : void

Delete a Seat Venue Configuration must be unavailable first

Parameters

string $id

Seat ID

DeleteEvent()

DeleteEvent(string  $id) : void

Delete an Event Events on sale must be cancelled before being deleted.

Parameters

string $id

Event ID

DeleteTable()

DeleteTable(string  $id) : void

Delete a Table Venue Configuration must be unavailable first

Parameters

string $id

Table ID

DeleteOrder()

DeleteOrder(string  $id) : void

Delete an Order Reservations must be cancelled first

Parameters

string $id

Order ID

CompleteOrder()

CompleteOrder(string  $orderId) : void

Complete order and convert holds into reservations

Parameters

string $orderId

Order ID

AddSeatToOrder()

AddSeatToOrder(string  $orderId, string  $seatId) : void

Place a hold on a seat and add it to an order

Parameters

string $orderId

Order ID
string $seatId

Seat ID

ContinueOrder()

ContinueOrder(string  $orderId, float  $expires) : void

Keep an order from expiring and becoming abondoned

Parameters

string $orderId

Order ID
float $expires

New timestamp when order will expire

AutoSelect()

AutoSelect(float  $numSeats, array  $seatClassPreference) : void

Automatically select some seats and add them to the order

Parameters

float $numSeats

Number of seats to select
array $seatClassPreference

Which seat classes to prefer in order

CancelEvent()

CancelEvent(string  $eventId) : void

Cancel an event and all reservations for that event

Parameters

string $eventId

Event ID

CancelReservation()

CancelReservation(string  $orderId, string  $seatId) : void

Cancel a reservation and release the seats

Parameters

string $orderId

Order ID
string $seatId

Seat ID

GetSeatsAndTablesForEvent()

GetSeatsAndTablesForEvent(string  $eventId, float  $page, float  $perpage) : void

Get all Seats and Tables for an Event

Parameters

string $eventId

Event ID
float $page

page number
float $perpage

per page

FindAbandonedOrders()

FindAbandonedOrders(float  $page, float  $perpage) : array

Get any abondoned (expired) orders

Parameters

float $page

page number
float $perpage

per page

Returns

array —

abondoned orders

GetOrdersForUser()

GetOrdersForUser(string  $userId, float  $page, float  $perpage) : array

Get a users orders

Parameters

string $userId

User ID
float $page

page number
float $perpage

per page

Returns

array —

orders for user

GetAllEventsOnSale()

GetAllEventsOnSale(float  $page, float  $perpage) : array

Get all Events marked on sale

Parameters

float $page

page number
float $perpage

per page

Returns

array —

events on sale

UpdateVenueConfigurationAvailability()

UpdateVenueConfigurationAvailability(string  $venueConfigurationId, boolean  $available) : void

Make a venue configuration available or unavailable.

Must not have any events for sale using this venute configuration.

Parameters

string $venueConfigurationId

Venue Configuration ID
boolean $available

availability

GetVenueConfigurations()

GetVenueConfigurations(string  $venueId) : array

Get Venue Configurations for a Venue

Parameters

string $venueId

Venue ID

Returns

array —

the Venue Configurations for the specified Venue

GetOrderSummary()

GetOrderSummary(string  $orderId) : array

Get a summary of an Order

Parameters

string $orderId

Order ID

Returns

array —

the summary for the specified Order

GetAllVenuesByOwner()

GetAllVenuesByOwner(string  $ownerId) : array

Get all Venues for an owner

Parameters

string $ownerId

owner id

Returns

array —

List of venues