class availability_calendar_handler_argument_availability in Availability Calendars 7.4
Same name and namespace in other branches
- 7.5 views/availability_calendar_handler_argument_availability.inc \availability_calendar_handler_argument_availability
Defines a contextual filter to filter on availability.
Hierarchy
- class \views_object
Expanded class hierarchy of availability_calendar_handler_argument_availability
1 string reference to 'availability_calendar_handler_argument_availability'
File
- views/
availability_calendar_handler_argument_availability.inc, line 5
View source
class availability_calendar_handler_argument_availability extends views_handler_argument_date {
/** @var date_sql_handler Only used if date api module is enabled. */
protected $date_handler;
/** @var string[] */
protected $date_parts;
/** @var DateTime */
protected $min_date;
/** @var DateTime */
protected $max_date;
public function init(&$view, &$options) {
parent::init($view, $options);
// Add a date handler.
if (module_exists('date_api')) {
module_load_include('inc', 'date_api', 'date_api_sql');
$this->date_handler = new date_sql_handler(DATE_UNIX);
}
}
public function option_definition() {
$options = parent::option_definition();
$options['end_date_exclusive'] = array(
'default' => $this->definition['allocation_type'] == AC_ALLOCATION_TYPE_OVERNIGHT,
'bool' => TRUE,
);
return $options;
}
public function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form['end_date_exclusive'] = array(
'#type' => 'checkbox',
'#title' => t('Exclude end date'),
'#description' => t('If selected, the end date itself will not be taken into account when filtering on availability, typical for overnight rental. This setting will be ignored if only a single date is passed in.'),
'#default_value' => !empty($this->options['end_date_exclusive']),
);
}
/**
* Inject a test for valid date range before the regular query.
* Override the parent query to be able to control the $group.
*/
public function query($group_by = FALSE) {
if (empty($this->argument)) {
return;
}
if (module_exists('date_api')) {
$this->date_parts = $this->date_handler
->arg_parts($this->argument);
$this->min_date = new DateTime($this->date_handler
->complete_date($this->date_parts[0]['date'], 'min'));
$this->max_date = count($this->date_parts) > 1 ? new DateTime($this->date_handler
->complete_date($this->date_parts[1]['date'], 'min')) : clone $this->min_date;
}
else {
$this->date_parts = explode('--', $this->argument);
$this->min_date = availability_calendar_parse_iso_date($this->date_parts[0]);
$this->max_date = count($this->date_parts) > 1 ? availability_calendar_parse_iso_date($this->date_parts[1]) : clone $this->min_date;
}
// Adjust end date if it is not inclusive and differs from the start date.
if (!empty($this->options['end_date_exclusive']) && $this->min_date < $this->max_date) {
$this->max_date
->modify('-1 day');
}
$this
->ensure_my_table();
module_load_include('inc', 'availability_calendar', 'availability_calendar');
availability_calendar_query_available($this->query, $this->table_alias, $this->real_field, $this->min_date, $this->max_date, $this->definition['default_state']);
}
public function get_sort_name() {
return t('Numeric', array(), array(
'context' => 'Sort order',
));
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
availability_calendar_handler_argument_availability:: |
protected | property | @var date_sql_handler Only used if date api module is enabled. | |
availability_calendar_handler_argument_availability:: |
protected | property | @var string[] | |
availability_calendar_handler_argument_availability:: |
protected | property | @var DateTime | |
availability_calendar_handler_argument_availability:: |
protected | property | @var DateTime | |
availability_calendar_handler_argument_availability:: |
public | function |
Return a description of how the argument would normally be sorted. Overrides views_handler_argument_date:: |
|
availability_calendar_handler_argument_availability:: |
public | function |
Init the handler with necessary data. Overrides views_handler_argument:: |
|
availability_calendar_handler_argument_availability:: |
public | function |
Build the options form. Overrides views_handler_argument:: |
|
availability_calendar_handler_argument_availability:: |
public | function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_argument:: |
|
availability_calendar_handler_argument_availability:: |
public | function |
Inject a test for valid date range before the regular query.
Override the parent query to be able to control the $group. Overrides views_handler_argument_formula:: |
|
views_handler:: |
public | property | The type of the handler, for example filter/footer/field. | |
views_handler:: |
public | property | Where the $query object will reside:. | 1 |
views_handler:: |
public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. | |
views_handler:: |
public | property | The relationship used for this field. | |
views_handler:: |
public | property | The alias of the table of this handler which is used in the query. | |
views_handler:: |
public | property |
The top object of a view. Overrides views_object:: |
|
views_handler:: |
public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 |
views_handler:: |
public | function | Check whether current user has access to this handler. | 10 |
views_handler:: |
public | function | Provide text for the administrative summary. | 4 |
views_handler:: |
public | function | Determine if the handler is considered 'broken'. | 6 |
views_handler:: |
public | function | Determine if a handler can be exposed. | 2 |
views_handler:: |
public | function | Transform a string by a certain method. | |
views_handler:: |
public | function | Ensure the main table for this handler is in the query. This is used a lot. | 8 |
views_handler:: |
public | function | Render our chunk of the exposed handler form when selecting. | 1 |
views_handler:: |
public | function | Get information about the exposed form for the form renderer. | 1 |
views_handler:: |
public | function | Submit the exposed handler form. | |
views_handler:: |
public | function | Validate the exposed handler form. | 4 |
views_handler:: |
public | function | Form for exposed handler options. | 2 |
views_handler:: |
public | function | Set new exposed option defaults when exposed setting is flipped on. | 2 |
views_handler:: |
public | function | Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data. | |
views_handler:: |
public | function | Validate the options form. | 1 |
views_handler:: |
public | function | Provide defaults for the handler. | |
views_handler:: |
public | function | Provide a form for setting options. | 1 |
views_handler:: |
public | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | |
views_handler:: |
public | function | Validate the options form. | |
views_handler:: |
public | function | Shortcut to get a handler's raw field value. | |
views_handler:: |
public | function | Get the join object that should be used for this handler. | |
views_handler:: |
public | function | Provide a form for aggregation settings. | 1 |
views_handler:: |
public | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | 1 |
views_handler:: |
public | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 |
views_handler:: |
public | function | Returns TRUE if the exposed filter works like a grouped filter. | 1 |
views_handler:: |
public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
public | function | Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. | 1 |
views_handler:: |
public | function | Provides a unique placeholders for handlers. | |
views_handler:: |
public | function | Run after the view is executed, before the result is cached. | 1 |
views_handler:: |
public | function | Run before the view is built. | 1 |
views_handler:: |
public | function | Sanitize the value for output. | |
views_handler:: |
public | function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
public | function | Shortcut to display the expose/hide button. | 2 |
views_handler:: |
public | function | Shortcut to display the exposed options form. | |
views_handler:: |
public | function | If set to remember exposed input in the session, store it there. | 1 |
views_handler:: |
public | function | Return a string representing this handler's name in the UI. | 9 |
views_handler:: |
public | function | Provides the handler some groupby. | 2 |
views_handler:: |
public | function | Validates the handler against the complete View. | 1 |
views_handler_argument:: |
public | property | ||
views_handler_argument:: |
public | property | The field to use for the name to use in the summary. | |
views_handler_argument:: |
public | property | The table to use for the name, if not the same table as the argument. | |
views_handler_argument:: |
public | property | ||
views_handler_argument:: |
public | property | 1 | |
views_handler_argument:: |
public | function | Default action: access denied. | |
views_handler_argument:: |
public | function | Handle the default action, which means our argument wasn't present. | |
views_handler_argument:: |
public | function | List of default behaviors for this argument if the argument is not present. | 4 |
views_handler_argument:: |
public | function | This just returns true. | |
views_handler_argument:: |
public | function | Default action: empty. | |
views_handler_argument:: |
public | function | Default action: ignore. | |
views_handler_argument:: |
public | function | Default action: not found. | |
views_handler_argument:: |
public | function | Default action: summary. | |
views_handler_argument:: |
public | function | Form for selecting further summary options. | |
views_handler_argument:: |
public | function | Work out which title to use. | |
views_handler_argument:: |
public | function | Export handler for summary export. | |
views_handler_argument:: |
public | function | Export handler for validation export. | |
views_handler_argument:: |
public | function | Get the display or row plugin, if it exists. | |
views_handler_argument:: |
public | function | Called by the view object to get the title. | |
views_handler_argument:: |
public | function | Get the value of this argument. | |
views_handler_argument:: |
public | function | Determine if the argument is set to provide a default argument. | |
views_handler_argument:: |
public | function | ||
views_handler_argument:: |
public | function |
Determine if the argument needs a style plugin. Overrides views_handler:: |
|
views_handler_argument:: |
public | function |
Perform any necessary changes to the form values prior to storage.
There is no need for this function to actually store the data. Overrides views_handler:: |
|
views_handler_argument:: |
public | function |
Validate the options form. Overrides views_handler:: |
|
views_handler_argument:: |
public | function | Process the summary arguments for display. | |
views_handler_argument:: |
public | function | Set the input for this argument. | |
views_handler_argument:: |
public | function | Give an argument the opportunity to modify the breadcrumb, if it wants. | 3 |
views_handler_argument:: |
public | function | Provide the argument to use to link from the summary to the next level. | 4 |
views_handler_argument:: |
public | function | Some basic summary behavior. | |
views_handler_argument:: |
public | function | Provides the name to use for the summary. | 10 |
views_handler_argument:: |
public | function | Add the name field, which is the field displayed in summary queries. | |
views_handler_argument:: |
public | function | Sorts the summary based upon the user's selection. | |
views_handler_argument:: |
public | function | Get the title this argument will assign the view, given the argument. | 13 |
views_handler_argument:: |
public | function | Determine if the argument can generate a breadcrumb. | |
views_handler_argument:: |
public | function | Validate that this argument works. By default, all arguments are valid. | |
views_handler_argument:: |
public | function | Called by the menu system to validate an argument. | |
views_handler_argument:: |
public | function | Provide a basic argument validation. | 1 |
views_handler_argument:: |
public | function | How to act if validation fails. | |
views_handler_argument_date:: |
public | property | ||
views_handler_argument_date:: |
public | property | ||
views_handler_argument_date:: |
public | function |
Add an option to set the default value to the current date. Overrides views_handler_argument:: |
|
views_handler_argument_date:: |
public | function |
Adapt the export mechanism. Overrides views_handler_argument:: |
|
views_handler_argument_date:: |
public | function |
Set the empty argument value to the current date. Overrides views_handler_argument:: |
|
views_handler_argument_formula:: |
public | property | ||
views_handler_argument_formula:: |
public | function |
Views handlers use a special construct function. Overrides views_handler_argument:: |
6 |
views_handler_argument_formula:: |
public | function | ||
views_handler_argument_formula:: |
public | function |
Build the summary query based on a formula Overrides views_handler_argument:: |
|
views_object:: |
public | property | Handler's definition. | |
views_object:: |
public | property | Except for displays, options for the object will be held here. | 1 |
views_object:: |
function | Collect this handler's option definition and alter them, ready for use. | ||
views_object:: |
public | function | Destructor. | 2 |
views_object:: |
public | function | 1 | |
views_object:: |
public | function | ||
views_object:: |
public | function | Always exports the option, regardless of the default value. | |
views_object:: |
public | function | Set default options on this object. | 1 |
views_object:: |
public | function | Set default options. | |
views_object:: |
public | function | Let the handler know what its full definition is. | |
views_object:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
public | function | Unpack a single option definition. | |
views_object:: |
public | function | Unpacks each handler to store translatable texts. | |
views_object:: |
public | function |