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

An availability agent filter receives a set of units and applies a filter to them returning the remainder.

Hierarchy

• interface \AvailabilityAgentFilterInterface

File

modules/rooms_booking/includes/rooms_booking.availability_agent_filter.inc, line 12

Rooms Booking agent filter interfaces and base implementations.

interface AvailabilityAgentFilterInterface {

  /**
   * Applies the filter operation to the units in the filter.
   *
   * @return array|int
   *   Rooms remaining after the filter, error code otherwise.
   */
  public function applyFilter();

  /**
   * Returns a list of parameters to add to the search array.
   *
   * @return array
   *   List of parameters provided by this filter.
   */
  public static function availabilitySearchParameters();

  /**
   * Adds necessary form elements to Availability search form.
   *
   * @param array $form
   *   The Availability search form array.
   * @param array $form_state
   *   The Availability search form state array.
   */
  public static function availabilitySearchForm(&$form, &$form_state);

  /**
   * Specific validation callback for Availability search form.
   *
   * @param array $form
   *   The Availability search form array.
   * @param array $form_state
   *   The Availability search form state array.
   */
  public static function availabilitySearchFormValidate(&$form, &$form_state);

  /**
   * Adds necessary form elements to Change availability search form.
   *
   * @param array $form
   *   The Change availability search form array.
   * @param array $form_state
   *   The Change availability search form state array.
   */
  public static function availabilityChangeSearchForm(&$form, &$form_state);

  /**
   * Specific validation callback for Change availability search form.
   *
   * @param array $form
   *   The Change availability search form array.
   * @param array $form_state
   *   The Change availability search form state array.
   */
  public static function availabilityChangeSearchFormValidate(&$form, &$form_state);

}

Members

Name	Modifiers	Type	Description	Overrides
AvailabilityAgentFilterInterface::applyFilter	public	function	Applies the filter operation to the units in the filter.	4
AvailabilityAgentFilterInterface::availabilityChangeSearchForm	public static	function	Adds necessary form elements to Change availability search form.	1
AvailabilityAgentFilterInterface::availabilityChangeSearchFormValidate	public static	function	Specific validation callback for Change availability search form.	1
AvailabilityAgentFilterInterface::availabilitySearchForm	public static	function	Adds necessary form elements to Availability search form.	1
AvailabilityAgentFilterInterface::availabilitySearchFormValidate	public static	function	Specific validation callback for Availability search form.	1
AvailabilityAgentFilterInterface::availabilitySearchParameters	public static	function	Returns a list of parameters to add to the search array.	1