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

Hierarchy

• class \RoomsEvent implements RoomsEventInterface

File

includes/rooms.event.inc, line 3

abstract class RoomsEvent implements RoomsEventInterface {

  /**
   * The booking unit the event is relevant to
   * @var int
   */
  public $unit_id;

  /**
   * The default state for the room if it has no specific booking.
   *
   * @var DateTime
   */
  public $start_date;

  /**
   * The end date for the event.
   *
   * @var DateTime
   */
  public $end_date;

  /**
   * {@inheritdoc}
   */
  public function startDay($format = 'j') {
    return $this->start_date
      ->format($format);
  }

  /**
   * {@inheritdoc}
   */
  public function startMonth($format = 'n') {
    return $this->start_date
      ->format($format);
  }

  /**
   * {@inheritdoc}
   */
  public function startYear($format = 'Y') {
    return $this->start_date
      ->format($format);
  }

  /**
   * {@inheritdoc}
   */
  public function endDay($format = 'j') {
    return $this->end_date
      ->format($format);
  }

  /**
   * {@inheritdoc}
   */
  public function endMonth($format = 'n') {
    return $this->end_date
      ->format($format);
  }

  /**
   * {@inheritdoc}
   */
  public function endYear($format = 'Y') {
    return $this->end_date
      ->format($format);
  }

  /**
   * {@inheritdoc}
   */
  public function diff() {
    $interval = $this->start_date
      ->diff($this->end_date);
    return $interval;
  }

  /**
   * {@inheritdoc}
   */
  public function sameMonth() {
    if ($this
      ->startMonth() == $this
      ->endMonth() && $this
      ->startYear() == $this
      ->endYear()) {
      return TRUE;
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function sameYear() {
    if ($this
      ->startYear() == $this
      ->endYear()) {
      return TRUE;
    }
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function transformToYearlyEvents() {

    // If same year return the event
    if ($this
      ->sameYear()) {
      $sd = new DateTime();
      $sd
        ->setDate($this
        ->startYear(), $this
        ->startMonth(), $this
        ->startDay());
      $ed = new DateTime();
      $ed
        ->setDate($this
        ->endYear(), $this
        ->endMonth(), $this
        ->endDay());
      $be = $this
        ->createEvent($sd, $ed);
      return array(
        $be,
      );
    }

    // Else split into years
    $events = array();
    for ($i = $this
      ->startYear(); $i <= $this
      ->endYear(); $i++) {
      $sd = new DateTime();
      $ed = new DateTime();
      if ($i == $this
        ->startYear()) {
        $sd
          ->setDate($i, $this
          ->startMonth(), $this
          ->startDay());
        $ed
          ->setDate($i, 12, 31);
        $events[$i] = $this
          ->createEvent($sd, $ed);
      }
      elseif ($i == $this
        ->endYear()) {
        $sd
          ->setDate($i, 1, 1);
        $ed
          ->setDate($i, $this
          ->endMonth(), $this
          ->endDay());
        $events[$i] = $this
          ->createEvent($sd, $ed);
      }
      else {
        $sd
          ->setDate($i, 1, 1);
        $ed
          ->setDate($i, 12, 31);
        $events[$i] = $this
          ->createEvent($sd, $ed);
      }
    }
    return $events;
  }

  /**
   * {@inheritdoc}
   */
  public function transformToMonthlyEvents() {
    $events = array();

    //First we need to split into events in separate years
    if (!$this
      ->sameYear()) {
      return FALSE;
    }
    if ($this
      ->sameMonth()) {
      $sd = new DateTime();
      $sd
        ->setDate($this
        ->startYear(), $this
        ->startMonth(), $this
        ->startDay());
      $ed = new DateTime();
      $ed
        ->setDate($this
        ->endYear(), $this
        ->endMonth(), $this
        ->endDay());
      $be = $this
        ->createEvent($sd, $ed);
      return array(
        $be,
      );
    }
    $months = rooms_end_of_month_dates($this
      ->startYear());
    for ($i = $this
      ->startMonth(); $i <= $this
      ->endMonth(); $i++) {
      $sd = new DateTime();
      $ed = new DateTime();
      if ($i == $this
        ->startMonth()) {
        $sd
          ->setDate($this
          ->startYear(), $i, $this
          ->startDay());
        $ed
          ->setDate($this
          ->startYear(), $i, $months[$i]);
        $events[$i] = $this
          ->createEvent($sd, $ed);
      }
      elseif ($i == $this
        ->endMonth()) {
        $sd
          ->setDate($this
          ->startYear(), $i, 1);
        $ed
          ->setDate($this
          ->startYear(), $i, $this
          ->endDay());
        $events[$i] = $this
          ->createEvent($sd, $ed);
      }
      else {
        $sd
          ->setDate($this
          ->startYear(), $i, 1);
        $ed
          ->setDate($this
          ->startYear(), $i, $months[$i]);
        $events[$i] = $this
          ->createEvent($sd, $ed);
      }
    }
    return $events;
  }

  /**
   * Creates a new event
   *
   * @param DateTime $start_date
   *   The new event start date.
   * @param DateTime $end_date
   *   The new event end date.
   *
   * @return RoomsEventInterface
   *   The new event created.
   */
  protected abstract function createEvent(DateTime $start_date, DateTime $end_date);

}

Members

Name	Modifiers	Type	Description	Overrides
RoomsEvent::$end_date	public	property	The end date for the event.
RoomsEvent::$start_date	public	property	The default state for the room if it has no specific booking.
RoomsEvent::$unit_id	public	property	The booking unit the event is relevant to
RoomsEvent::createEvent	abstract protected	function	Creates a new event	2
RoomsEvent::diff	public	function	Returns the date interval between end and start date. Overrides RoomsEventInterface::diff
RoomsEvent::endDay	public	function	Returns the booking end day. Overrides RoomsEventInterface::endDay
RoomsEvent::endMonth	public	function	Returns the booking end month. Overrides RoomsEventInterface::endMonth
RoomsEvent::endYear	public	function	Returns the booking end year. Overrides RoomsEventInterface::endYear
RoomsEvent::sameMonth	public	function	Checks if the event starts and ends in the same month. Overrides RoomsEventInterface::sameMonth
RoomsEvent::sameYear	public	function	Checks if the event starts and ends in the same year. Overrides RoomsEventInterface::sameYear
RoomsEvent::startDay	public	function	Returns the booking start day. Overrides RoomsEventInterface::startDay
RoomsEvent::startMonth	public	function	Returns the booking start month. Overrides RoomsEventInterface::startMonth
RoomsEvent::startYear	public	function	Returns the booking start year. Overrides RoomsEventInterface::startYear
RoomsEvent::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 Overrides RoomsEventInterface::transformToMonthlyEvents
RoomsEvent::transformToYearlyEvents	public	function	Takes an event that spans several years and transforms it to yearly events Overrides RoomsEventInterface::transformToYearlyEvents