class date_navigation_plugin_style in Date 7
Same name and namespace in other branches
- 6.2 includes/date_navigation_plugin_style.inc \date_navigation_plugin_style
- 6 date_api.views.inc \date_navigation_plugin_style
Style plugin to create date back/next navigation.
The style plugin passes some argument values to the theme, and ensures that the date argument is present and that the default value is set to the current date.
Hierarchy
- class \views_object
- class \views_plugin
- class \views_plugin_style
- class \date_navigation_plugin_style
- class \views_plugin_style
- class \views_plugin
Expanded class hierarchy of date_navigation_plugin_style
1 string reference to 'date_navigation_plugin_style'
- date_views_views_plugins in date_views/
includes/ date_views.views.inc - Implementation of hook_views_plugins
File
- date_views/
includes/ date_navigation_plugin_style.inc, line 15 - Views navigation style plugin for Date API.
View source
class date_navigation_plugin_style extends views_plugin_style {
/**
* Style validation.
*/
function validate() {
$errors = parent::validate();
$arguments = $this->display->handler
->get_option('arguments');
$count = 0;
$found = FALSE;
foreach ($arguments as $id => $argument) {
if ($argument['field'] == 'date_argument') {
if ($count > 0) {
$errors[] = t('The %style cannot use more than one Date: Date argument.', array(
'%style' => $this->definition['title'],
));
}
elseif ($argument['default_argument_type'] != 'date') {
$errors[] = t('The %style requires the Date: Date argument be set to default to the current date.', array(
'%style' => $this->definition['title'],
));
}
$count++;
$found = TRUE;
}
}
if (!$found) {
$errors[] = t('The %style requires the Date: Date argument.', array(
'%style' => $this->definition['title'],
));
}
return $errors;
}
function query() {
module_load_include('inc', 'date_api', 'date_api_sql');
// Bring the argument information into the view so our theme can access it.
$i = 0;
foreach ($this->view->argument as $id => $argument) {
if ($id == 'date_argument') {
$this->view->date_info->granularity = $argument->granularity;
$this->view->date_info->date_arg = !empty($this->view->args) && count($this->view->args) > $argument->position ? $this->view->args[$argument->position] : '';
$this->view->date_info->date_arg_pos = $i;
$this->view->date_info->year = isset($argument->year) ? $argument->year : NULL;
$this->view->date_info->month = isset($argument->month) ? $argument->month : NULL;
$this->view->date_info->day = isset($argument->day) ? $argument->day : NULL;
$this->view->date_info->week = isset($argument->week) ? $argument->week : NULL;
$this->view->date_info->min_date = $argument->min_date;
$this->view->date_info->max_date = $argument->max_date;
$this->view->date_info->url = $this->view
->get_url();
}
$i++;
}
// bring the node type into the query so we can use it in the theme
$this->view->query
->add_field('node', 'type');
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
date_navigation_plugin_style:: |
function |
Add anything to the query that we might need to. Overrides views_plugin_style:: |
||
date_navigation_plugin_style:: |
function |
Style validation. Overrides views_plugin_style:: |
||
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 | Views handlers use a special construct function. | 4 |
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 | ||
views_plugin:: |
public | property | The current used views display. | |
views_plugin:: |
public | property | The plugin name of this plugin, for example table or full. | |
views_plugin:: |
public | property | The plugin type of this plugin, for example style or query. | |
views_plugin:: |
public | property |
The top object of a view. Overrides views_object:: |
1 |
views_plugin:: |
public | function | Provide a list of additional theme functions for the theme info page. | |
views_plugin:: |
public | function | Handle any special handling on the validate form. | 9 |
views_plugin:: |
public | function | Return the human readable name of the display. | |
views_plugin:: |
public | function | Returns the summary of the settings in the display. | 8 |
views_plugin:: |
public | function | Provide a full list of possible theme templates used by this style. | |
views_plugin_style:: |
public | property | The row plugin, if it's initialized and the style itself supports it. | |
views_plugin_style:: |
public | property | Store all available tokens row rows. | |
views_plugin_style:: |
public | function | Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query. | 1 |
views_plugin_style:: |
public | function | Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view. | 1 |
views_plugin_style:: |
public | function |
Destructor. Overrides views_object:: |
|
views_plugin_style:: |
public | function | Should the output of the style plugin be rendered even if it's empty. | 1 |
views_plugin_style:: |
public | function | Get a rendered field. | |
views_plugin_style:: |
public | function | Get the raw field value. | |
views_plugin_style:: |
public | function | Return the token replaced row class for the specified row. | |
views_plugin_style:: |
public | function | Initialize a style plugin. | |
views_plugin_style:: |
public | function |
Provide a form to edit options for this plugin. Overrides views_plugin:: |
9 |
views_plugin_style:: |
public | function |
Validate the options form. Overrides views_plugin:: |
|
views_plugin_style:: |
public | function |
Information about options for all kinds of purposes will be held here. Overrides views_object:: |
8 |
views_plugin_style:: |
public | function | Allow the style to do stuff before each row is rendered. | |
views_plugin_style:: |
public | function | Render the display in this style. | 5 |
views_plugin_style:: |
public | function | Render all of the fields for a given style and store them on the object. | |
views_plugin_style:: |
public | function | Group records as needed for rendering. | |
views_plugin_style:: |
public | function | Render the grouping sets. | |
views_plugin_style:: |
public | function | Take a value and apply token replacement logic to it. | |
views_plugin_style:: |
public | function | Return TRUE if this style also uses fields. | |
views_plugin_style:: |
public | function | Return TRUE if this style also uses a row plugin. | |
views_plugin_style:: |
public | function | Return TRUE if this style also uses a row plugin. | |
views_plugin_style:: |
public | function | Return TRUE if this style uses tokens. |