Docs For Class BookingData

Description

Obtains booking data from the database

Can be used either to find all bookings that are within a time period or to look for a specific booking id. Note that when using time periods to define the query, a booking is within the query time if *any* part of the booking period overlaps with *any* part of the query period.

Can optionally exclude deleted bookings from the list.

Located in /inc/bookings/bookingdata.php (line 33)

Variable Summary

Booking $booking

array $bookinglist

boolean $fatal_sql

integer $id

boolean $includeDeleted

integer $instrument

string $start

string $stop

Method Summary

BookingData BookingData (array $arr, [ $includeDeleted = false])

array dataArray ()

Booking dataEntry ()

void _fill ()

Variables

Booking $booking (line 45)

var: single Booking object returned for id match

array $bookinglist (line 43)

var: list of Booking objects returned for time period

boolean $fatal_sql = 1 (line 47)

var: sql errors are fatal

integer $id (line 41)

var: specific booking that is of interest

boolean $includeDeleted = 0 (line 49)

var: include deleted bookings in listing

integer $instrument (line 39)

var: instrument id number of interest

string $start (line 35)

var: start of the query (SQL date-time string)

string $stop (line 37)

var: stop of the query (SQL date-time string)

Methods

Constructor BookingData (line 57)

Obtain the booking listing within defined parameters

BookingData BookingData (array $arr, [ $includeDeleted = false])

array $arr: data => value pairs where data can be start, stop, instrument, id
$includeDeleted

dataArray (line 137)

obtain the list of bookings

return: list of Booking objects

array dataArray ()

dataEntry (line 145)

obtain the bookings

return: booking object

Booking dataEntry ()

_fill (line 75)

Interrogate the database to get the bookings

global: string $TABLEPREFIX: prefix prepended to all table names in database

void _fill ()