function availability_calendar_query_available in Availability Calendars 7.5

Same name and namespace in other branches

1. 7.3 availability_calendar.inc \availability_calendar_query_available()
2. 7.4 availability_calendar.inc \availability_calendar_query_available()

Adds a where clauses to the given query to filter on availability.

Notes:

• The to date is inclusive and should thus not be the departure date in case of overnight bookings, but the last full day of the stay.
• If a field has multiple values, an entity may be returned multiple times. However this function cannot filter on duplicates as it does not know whether just calendars should be returned, or fields or entities, and whether duplicates are expected or not.

Parameters

QueryConditionInterface|views_plugin_query_default $query: The query to add the clause to. This may be a default Drupal or a Views specific query object.

string $field_table: The name of the (field data) table to join on.

string $cid_field: The name of the field in the table (to join on) that contains the cid.

DateTime $from: The date to start searching for availability.

int|DateTime $to_or_duration: Either the last (full) day (DateTime) or the duration of the stay (int).

int $default_state: The sid of the state to use for dates without availability assigned.

2 calls to availability_calendar_query_available()

availability_calendar_handler_argument_availability::build_query in views/availability_calendar_handler_argument_availability.inc

Helper method for the query method that actually builds the query. Extracted to allow it to be overridden.

availability_calendar_handler_filter_availability::build_query in views/availability_calendar_handler_filter_availability.inc

Helper method for the op_... methods that builds the query.

File

./availability_calendar.inc, line 795

Code

function availability_calendar_query_available($query, $field_table, $cid_field, $from, $to_or_duration, $default_state) {

  // Process parameters.
  $info = availability_calendar_get_period_information($from, $to_or_duration);
  if (!$info) {
    return;
  }

  // Determine whether default availability state is to be treated as available.
  $states = availability_calendar_get_states();
  if (isset($states[$default_state])) {
    $default_state = $states[$default_state];
    $default_is_available = $default_state['is_available'] == 1;
  }
  else {

    // I have to make a choice :( (I could try to find out if there is only 1
    // calendar field or if the default is always the same or if the defaults
    // are always to be treated as either available or not available.)
    $default_is_available = FALSE;
  }
  $sids = array_keys(availability_calendar_get_states(!$default_is_available));
  $sub_query = db_select('availability_calendar_availability', 'availability_calendar_availability')
    ->where("availability_calendar_availability.cid = {$field_table}.{$cid_field}")
    ->condition('availability_calendar_availability.date', array(
    $info['from']
      ->format(AC_ISODATE),
    $info['to']
      ->format(AC_ISODATE),
  ), 'BETWEEN')
    ->condition('availability_calendar_availability.sid', $sids, 'IN');
  if ($default_is_available) {

    // Default status = available: so no single day may be marked as non
    // available. Check by doing a check on the existence of a non available day
    // in the given period.
    $sub_query
      ->addExpression('1');
    if (is_a($query, 'views_plugin_query_default')) {
      $query
        ->add_where(0, '', $sub_query, 'NOT EXISTS');
    }
    else {
      $query
        ->notExists($sub_query);
    }
  }
  else {

    // Default status = not available: so all days must be marked as available.
    // Check by doing a count on the available days in the given period which
    // should equal the total number of days.
    $sub_query
      ->addExpression('count(*)');
    if (is_a($query, 'views_plugin_query')) {
      $query
        ->add_where(0, $info['duration'], $sub_query, 'IN');
    }
    else {
      $query
        ->condition($info['duration'], $sub_query, 'IN');
    }
  }
}