interface BookingEventInterface in Rooms - Drupal Booking for Hotels, B&Bs and Vacation Rentals 7

@file Interface BookingEventInterface

Hierarchy

• interface \RoomsEventInterface
  • interface \BookingEventInterface

File

modules/rooms_availability/includes/rooms_availability.booking_event_interface.inc, line 8

Interface BookingEventInterface

interface BookingEventInterface extends RoomsEventInterface {

  /**
   * Locks event - updates the rooms_booking_locks table to indicate that this
   * event is locked.
   *
   * @return bool
   *   TRUE if the event is locked successfully, FALSE if was already blocked.
   */
  public function lock();

  /**
   * Unlocks the event.
   */
  public function unlock();

  /**
   * Returns event in a format amenable to FullCalendar display or generally
   * sensible JSON.
   *
   * @param int $style
   *   The visualization style.
   * @param string $unit_name
   *   The bookable unit name.
   *
   * @return array
   *   The processed event, in JSON ready format.
   */
  public function formatJson($style = ROOMS_AVAILABILITY_ADMIN_STYLE, $unit_name = '');

}

Members

Name	Modifiers	Type	Description	Overrides
BookingEventInterface::formatJson	public	function	Returns event in a format amenable to FullCalendar display or generally sensible JSON.	1
BookingEventInterface::lock	public	function	Locks event - updates the rooms_booking_locks table to indicate that this event is locked.	1
BookingEventInterface::unlock	public	function	Unlocks the event.	1
RoomsEventInterface::diff	public	function	Returns the date interval between end and start date.	1
RoomsEventInterface::endDay	public	function	Returns the booking end day.	1
RoomsEventInterface::endMonth	public	function	Returns the booking end month.	1
RoomsEventInterface::endYear	public	function	Returns the booking end year.	1
RoomsEventInterface::sameMonth	public	function	Checks if the event starts and ends in the same month.	1
RoomsEventInterface::sameYear	public	function	Checks if the event starts and ends in the same year.	1
RoomsEventInterface::startDay	public	function	Returns the booking start day.	1
RoomsEventInterface::startMonth	public	function	Returns the booking start month.	1
RoomsEventInterface::startYear	public	function	Returns the booking start year.	1
RoomsEventInterface::transformToMonthlyEvents	public	function	Takes a single event that spans several months and transforms it to monthly events - this assumes that the event is contained within a year	1
RoomsEventInterface::transformToYearlyEvents	public	function	Takes an event that spans several years and transforms it to yearly events	1