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

@file A pricing event represent a price over a set of continuous dates. As soon as the price changes that is a different pricing event

Hierarchy

• interface \RoomsEventInterface
  • interface \PricingEventInterface

File

modules/rooms_pricing/includes/rooms_pricing.pricing_event_interface.inc, line 9

A pricing event represent a price over a set of continuous dates. As soon as the price changes that is a different pricing event

interface PricingEventInterface extends RoomsEventInterface {

  /**
   * Applies an operation against a Price event.
   *
   * @param int $amount
   *   The operation amount.
   * @param string $operation
   *   The operation type.
   * @param int $days
   *   The number of days the event lasts.
   */
  public function applyOperation($amount, $operation);

  /**
   * Returns event in a format amenable to FullCalendar display or generally
   * sensible json.
   *
   * @return array
   *   The processed event, in JSON ready format.
   */
  public function formatJson();

}

Members

Name	Modifiers	Type	Description	Overrides
PricingEventInterface::applyOperation	public	function	Applies an operation against a Price event.	1
PricingEventInterface::formatJson	public	function	Returns event in a format amenable to FullCalendar display or generally sensible json.	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