Docs For Class ActionCalendar

Description

View a bookings calendar and make bookings

Located in /inc/actions/calendar.php (line 35)

ActionAction
   |
   --ActionViewBase
      |
      --ActionCalendar

Variable Summary

boolean $_haveWriteAccess

Method Summary

void ActionCalendar (BumblebeeAuth $auth, $PDATA, array $pdata)

void go ()

void instrumentDay ()

void instrumentMonth ()

void mungeInputData ()

string _linksForwardBack ( $centre, $back, $forward, $calLength, [ $extra = array()])

void _makeCalendarConfigDialogue ()

void _makeInstrumentAddDialogue ()

void _makeQuickJumpLinks ( $caption, $direction, $calLength, $centre, $centreOffset, $script)

void _viewCalendarForbidden ()

Variables

boolean $_haveWriteAccess = false (line 37)

var: logged in user can modify booking

Inherited Variables

Inherited from ActionViewBase

ActionViewBase::$instrument
ActionViewBase::$maxFutureDays
ActionViewBase::$row

Inherited from ActionAction

ActionAction::$auth
ActionAction::$DEBUG
ActionAction::$ob_flush_ok
ActionAction::$PD
ActionAction::$PDATA
ActionAction::$readOnly
ActionAction::$stdmessages

Methods

Constructor ActionCalendar (line 46)

Initialising the class

return: nothing

void ActionCalendar (BumblebeeAuth $auth, $PDATA, array $pdata)

BumblebeeAuth $auth: Authorisation object
array $pdata: extra state data from the call path
$PDATA

go (line 59)

void go ()

Redefinition of:

ActionAction::go(): Actually perform the action that this Action* class is to perform

instrumentDay (line 354)

Display a single day's calendar for the selected instrument

todo: ///TODO: combine this function with instrumentMonth to reduce duplication

void instrumentDay ()

instrumentMonth (line 119)

Display the monthly calendar for the selected instrument

void instrumentMonth ()

mungeInputData (line 79)

void mungeInputData ()

Redefinition of:

ActionViewBase::mungeInputData()

_linksForwardBack (line 208)

Generate back | today | forward links for the calendar

return: html for links

string _linksForwardBack ( $centre, $back, $forward, $calLength, [ $extra = array()])

$centre
$back
$forward
$calLength
$extra

_makeCalendarConfigDialogue (line 289)

void _makeCalendarConfigDialogue ()

_makeInstrumentAddDialogue (line 331)

void _makeInstrumentAddDialogue ()

_makeQuickJumpLinks (line 264)

void _makeQuickJumpLinks ( $caption, $direction, $calLength, $centre, $centreOffset, $script)

$caption
$direction
$calLength
$centre
$centreOffset
$script

_viewCalendarForbidden (line 419)

void _viewCalendarForbidden ()

Inherited Methods

Inherited From ActionViewBase

ActionViewBase::ActionViewBase()
ActionViewBase::BookingPastNormalCalendar()
ActionViewBase::displayInstrumentFooter()
ActionViewBase::displayInstrumentHeader()
ActionViewBase::MakeBookingHref()
ActionViewBase::MakeBookingPermitted()
ActionViewBase::mungeInputData()
ActionViewBase::ViewCalendarPermitted()
ActionViewBase::_calendarViewLink()
ActionViewBase::_checkBookingAuth()
ActionViewBase::_Forbidden()
ActionViewBase::_forbiddenError()
ActionViewBase::_instrumentNotes()
ActionViewBase::_loadMultiInstrument()
ActionViewBase::_offset()
ActionViewBase::_UnknownBooking()
ActionViewBase::_UnknownInstrument()

Inherited From ActionAction

ActionAction::ActionAction()
ActionAction::delete()
ActionAction::edit()
ActionAction::go()
ActionAction::log()
ActionAction::mungeInputData()
ActionAction::readOnlyError()
ActionAction::reportAction()
ActionAction::select()
ActionAction::_dataCleanse()