Docs For Class Booking

Description

Object for an individual booking

Located in /inc/bookings/booking.php (line 30)

TimeSlot
   |
   --Booking

Variable Summary

string $comments

integer $discount

integer $id

string $instrumentDescription

string $instrumentName

string $log

string $masqemail

integer $masquser

integer $masquserid

string $masqusername

string $name

integer $project

string $useremail

integer $userid

string $username

string $userphone

Method Summary

Booking Booking (array $arr)

string display (boolean $displayAdmin, boolean $displayOwner)

string displayInCell ()

string displayInTable ( $cols, boolean $displayAdmin, boolean $displayOwner)

string generateBookingTitle ()

string generateLongDescription ([ $short = false])

Variables

string $comments (line 38)

var: log message for the booking calendar

integer $discount (line 34)

var: percentage discount to be applied to the booking

integer $id (line 32)

var: booking id number

string $instrumentDescription (line 62)

var: instrument description

string $instrumentName (line 60)

var: instrument name

string $log (line 36)

var: log message for the instrument log book

string $masqemail (line 58)

var: email address for user that booked the instrument

integer $masquser (line 54)

var: full name of user for user that booked the instrument

integer $masquserid (line 52)

var: user id number for user that booked the instrument

string $masqusername (line 56)

var: username of user for user that booked the instrument

string $name (line 46)

var: full name of user for user that will use instrument

integer $project (line 40)

var: project id number

string $useremail (line 48)

var: email address for user that will use instrument

integer $userid (line 42)

var: user id number for user that will use instrument

string $username (line 44)

var: username of user for user that will use instrument

string $userphone (line 50)

var: phone number for user that will use instrument

Inherited Variables

Inherited from TimeSlot

TimeSlot::$arb_start
TimeSlot::$arb_stop
TimeSlot::$baseclass
TimeSlot::$displayStart
TimeSlot::$displayStop
TimeSlot::$duration
TimeSlot::$freeBusyOnly
TimeSlot::$href
TimeSlot::$isDisabled
TimeSlot::$isStart
TimeSlot::$isVacant
TimeSlot::$slotRule
TimeSlot::$start
TimeSlot::$stop
TimeSlot::$_dayStart
TimeSlot::$_dayStop

Methods

Constructor Booking (line 69)

Create a booking object

Booking Booking (array $arr)

array $arr: key => value paids

display (line 100)

display the booking as a list of settings

return: html representation of booking

string display (boolean $displayAdmin, boolean $displayOwner)

boolean $displayAdmin: show admin-only information (discount etc)
boolean $displayOwner: show owner-only information (project etc)

displayInCell (line 138)

display the booking as a single cell in a calendar

return: html representation of booking

string displayInCell ()

displayInTable (line 111)

display the booking as a list of settings

return: html representation of booking

string displayInTable ( $cols, boolean $displayAdmin, boolean $displayOwner)

boolean $displayAdmin: show admin-only information (discount etc)
boolean $displayOwner: show owner-only information (project etc)
$cols

generateBookingTitle (line 184)

work out the title (start and stop times) for the booking for display

return: title

string generateBookingTitle ()

Redefinition of:

TimeSlot::generateBookingTitle(): work out the title (start and stop times) for the vacancy for display

generateLongDescription (line 198)

construct a long description of the time slot for pop-ups

return: description

string generateLongDescription ([ $short = false])

$short

Redefinition of:

TimeSlot::generateLongDescription(): construct a long description of the time slot for pop-ups

Inherited Methods

Inherited From TimeSlot

TimeSlot::TimeSlot()
TimeSlot::dayStart()
TimeSlot::dayStop()
TimeSlot::displayShort()
TimeSlot::generateBookingTitle()
TimeSlot::generateLongDescription()
TimeSlot::_TimeSlot_SimpleDate()