abstract class RoomsCalendar in Rooms - Drupal Booking for Hotels, B&Bs and Vacation Rentals 7

Handles querying and updating the availability information relative to a single bookable unit.

Hierarchy

• class \RoomsCalendar implements RoomsCalendarInterface

File

includes/rooms.calendar.inc, line 7

abstract class RoomsCalendar implements RoomsCalendarInterface {

  /**
   * The default state for the room if it has no specific booking.
   *
   * @var int
   */
  protected $unit_id;

  /**
   * The default state for the room if it has no specific booking.
   *
   * @var int
   */
  protected $default_state;

  /**
   * The base table where calendar data is stored.
   *
   * @var string
   */
  protected $base_table;

  /**
   * {@inheritdoc}
   */
  public abstract function updateCalendar($events);

  /**
   * {@inheritdoc}
   */
  public function addMonthEvent(RoomsEventInterface $event) {

    // First check if the month exists and do an update if so
    if ($this
      ->monthDefined($event
      ->startMonth(), $event
      ->startYear())) {
      $partial_month_row = $this
        ->preparePartialMonthArray($event);
      $update = db_update($this->base_table)
        ->condition('unit_id', $this->unit_id)
        ->condition('month', $event
        ->startMonth())
        ->condition('year', $event
        ->startYear())
        ->fields($partial_month_row)
        ->execute();
    }
    else {

      // Prepare the days array
      $days = $this
        ->prepareFullMonthArray($event);
      $month_row = array(
        'unit_id' => $this->unit_id,
        'year' => $event
          ->startYear(),
        'month' => $event
          ->startMonth(),
      );
      $month_row = array_merge($month_row, $days);
      $insert = db_insert($this->base_table)
        ->fields($month_row);
      $insert
        ->execute();
    }
  }

  /**
   * Given an event it prepares the entire month array for it
   * assuming no other events in the month and days where there
   * is no event get set to the default state.
   *
   * @param RoomsEventInterface $event
   *   The event to process.
   *
   * @return array
   *   The days of the month states processed array.
   */
  protected abstract function prepareFullMonthArray(RoomsEventInterface $event);

  /**
   * Given an event it prepares a partial array covering just the days
   * for which the event is involved
   *
   * @param RoomsEventInterface $event
   *   The event to process.
   *
   * @return array
   *   The days of the month states processed array.
   */
  protected abstract function preparePartialMonthArray(RoomsEventInterface $event);

  /**
   * {@inheritdoc}
   */
  public abstract function getEvents(DateTime $start_date, DateTime $end_date);

  /**
   * {@inheritdoc}
   */
  public abstract function getRawDayData(DateTime $start_date, DateTime $end_date);

  /**
   * {@inheritdoc}
   */
  public function monthDefined($month, $year) {
    $query = db_select($this->base_table, 'a');
    $query
      ->addField('a', 'unit_id');
    $query
      ->addField('a', 'year');
    $query
      ->addField('a', 'month');
    $query
      ->condition('a.unit_id', $this->unit_id);
    $query
      ->condition('a.year', $year);
    $query
      ->condition('a.month', $month);
    $result = $query
      ->execute()
      ->fetchAll(PDO::FETCH_ASSOC);
    if (count($result) > 0) {
      return TRUE;
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
RoomsCalendar::$base_table	protected	property	The base table where calendar data is stored.
RoomsCalendar::$default_state	protected	property	The default state for the room if it has no specific booking.	1
RoomsCalendar::$unit_id	protected	property	The default state for the room if it has no specific booking.
RoomsCalendar::addMonthEvent	public	function	Adds an event to the calendar Overrides RoomsCalendarInterface::addMonthEvent
RoomsCalendar::getEvents	abstract public	function	Given a date range returns an array of RoomEvents. The heavy lifting really takes place in the getRawDayData function - here we are simply acting as a factory for event objects Overrides RoomsCalendarInterface::getEvents	2
RoomsCalendar::getRawDayData	abstract public	function	Given a date range it returns all data within that range including the start and end dates of states. The MySQL queries are kept simple and then the data is cleared up. Overrides RoomsCalendarInterface::getRawDayData	2
RoomsCalendar::monthDefined	public	function	Checks if a month exists. Overrides RoomsCalendarInterface::monthDefined
RoomsCalendar::prepareFullMonthArray	abstract protected	function	Given an event it prepares the entire month array for it assuming no other events in the month and days where there is no event get set to the default state.	2
RoomsCalendar::preparePartialMonthArray	abstract protected	function	Given an event it prepares a partial array covering just the days for which the event is involved	2
RoomsCalendar::updateCalendar	abstract public	function	Given an array of RoomEvents the calendar is updated with regards to the events that are relevant to the Unit this calendar refers to Overrides RoomsCalendarInterface::updateCalendar	2