You are here

rooms_availability.booking_event_interface.inc in Rooms - Drupal Booking for Hotels, B&Bs and Vacation Rentals 7

Interface BookingEventInterface

File

modules/rooms_availability/includes/rooms_availability.booking_event_interface.inc
View source
<?php

/**
 * @file
 * 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 = '');

}

Interfaces

Namesort descending Description
BookingEventInterface @file Interface BookingEventInterface