Newer
Older
/**
* @file theme.inc
*
* An array of preprocessors to fill variables for templates and helper
* functions to make theming easier.
*/
/**
* Provide a full array of possible themes to try for a given hook.
*
* @param $hook
* The hook to use. This is the base theme/template name.
* @param $view
* The view being rendered.
* @param $display
* The display being rendered, if applicable.
*/
Earl Miles
committed
function _views_theme_functions($hook, $view, $display = NULL) {
$themes = array();
if ($display) {
Earl Miles
committed
$themes[] = $hook . '__' . $view->name . '__' . $display->id;
Earl Miles
committed
$themes[] = $hook . '__' . $display->id;
if ($display->id != $display->display_plugin) {
Earl Miles
committed
$themes[] = $hook . '__' . $view->name . '__' . $display->display_plugin;
Earl Miles
committed
$themes[] = $hook . '__' . $display->display_plugin;
}
}
$themes[] = $hook . '__' . $view->name;
$themes[] = $hook;
return $themes;
}
/**
* Preprocess the primary theme implementation for a view.
*/
function template_preprocess_views_view(&$vars) {
$view = $vars['view'];
$vars['rows'] = $view->style_handler->render($view->result);
$vars['css_name'] = views_css_safe($view->name);
$vars['name'] = $view->name;
$vars['display_id'] = $view->current_display;
if (!$vars['rows']) {
$vars['empty'] = $view->display_handler->render_empty();
Earl Miles
committed
if (!$view->display_handler->get_option('header_empty')) {
$vars['header'] = '';
}
if (!$view->display_handler->get_option('footer_empty')) {
$vars['footer'] = '';
}
}
else {
$vars['empty'] = '';
Earl Miles
committed
$header = TRUE;
$vars['exposed'] = !empty($view->exposed_widgets) ? $view->exposed_widgets : '';
Earl Miles
committed
if (!isset($vars['header'])) {
$vars['header'] = $view->display_handler->render_header();
}
if (!isset($vars['footer'])) {
$vars['footer'] = $view->display_handler->render_footer();
}
$vars['more'] = $view->display_handler->render_more_link();
$vars['feed_icon'] = !empty($view->feed_icon) ? $view->feed_icon : '';
$vars['attachment_before'] = !empty($view->attachment_before) ? $view->attachment_before : '';
$vars['attachment_after'] = !empty($view->attachment_after) ? $view->attachment_after : '';
$pager_type = $view->pager['use_pager'] == 'mini' ? 'views_mini_pager' : 'pager';
$vars['pager'] = theme($pager_type, $view->exposed_input, $view->pager['items_per_page'], $view->pager['element']);
// if administrator, add some links. These used to be tabs, but this is better.
if (user_access('administer views')) {
$vars['admin_links_raw'] = array(
array(
'title' => t('Edit'),
'alt' => t("Edit this view"),
'href' => "admin/build/views/edit/$view->name",
'fragment' => 'views-tab-' . $view->current_display,
'query' => drupal_get_destination(),
),
array(
'title' => t('Export'),
'alt' => t("Export this view"),
'href' => "admin/build/views/export/$view->name",
),
array(
'title' => t('Clone'),
'alt' => t("Create a copy of this view"),
'href' => "admin/build/views/clone/$view->name",
),
);
$vars['admin_links'] = theme('links', $vars['admin_links_raw']);
}
else {
$vars['admin_links'] = '';
$vars['admin_links_raw'] = array();
}
// If using AJAX, send identifying data about this view.
if ($view->use_ajax) {
$settings = array(
'views' => array(
'ajax_path' => url('views/ajax'),
'ajaxViews' => array(
array(
'view_name' => $view->name,
'view_display_id' => $view->current_display,
'view_args' => implode('/', $view->args),
'view_path' => $_GET['q'],
),
),
),
);
drupal_add_js($settings, 'setting');
views_add_js('ajax_view');
}
}
/**
* Preprocess theme function to print a single record from a row, with fields
*/
function template_preprocess_views_view_fields(&$vars) {
$view = $vars['view'];
// Loop through the fields for this view.
foreach ($view->field as $id => $field) {
if (!empty($field['handler']) && is_object($field['handler'])) {
$object = new stdClass();
Earl Miles
committed
$object->content = $field['handler']->theme($vars['row']);
if (isset($field['handler']->field_alias) && isset($vars['row']->{$field['handler']->field_alias})) {
$object->raw = $vars['row']->{$field['handler']->field_alias};
}
else {
$object->raw = NULL; // make sure it exists to reduce NOTICE
}
$object->handler = $field['handler'];
$object->class = views_css_safe($id);
$object->label = check_plain($field['handler']->label());
$vars['fields'][$id] = $object;
}
/**
* Display a single views field.
*
* Interesting bits of info:
* $field->field_alias says what the raw value in $row will be. Reach it like
* this: @code { $row->{$field->field_alias} @endcode
*/
function theme_views_view_field($view, $field, $row) {
Earl Miles
committed
return $field->render($row);
Earl Miles
committed
/**
* Preprocess theme function to print a single record from a row, with fields
*/
function template_preprocess_views_view_summary(&$vars) {
Earl Miles
committed
$view = $vars['view'];
$argument = $view->argument[$view->build_info['summary_level']]['handler'];
Earl Miles
committed
foreach ($vars['rows'] as $id => $row) {
$vars['rows'][$id]->link = $argument->summary_name($row);
$vars['rows'][$id]->url = $argument->summary_link($row, $view->get_url());
$vars['rows'][$id]->count = intval($row->{$argument->count_alias});
}
Earl Miles
committed
}
/**
* Display a view as a table style.
*/
function template_preprocess_views_view_table(&$vars) {
$view = $vars['view'];
$result = $view->result;
$options = $view->style_handler->options;
$handler = $view->style_handler;
$fields = $view->field;
$columns = $handler->sanitize_columns($options['columns'], $fields);
$active = !empty($handler->active) ? $handler->active : '';
$order = !empty($handler->order) ? $handler->order : 'asc';
$query = tablesort_get_querystring();
if ($query) {
$query = '&' . $query;
}
foreach ($columns as $field => $column) {
// render the header labels
if ($field == $column) {
$label = check_plain(!empty($fields[$field]['handler']) ? $fields[$field]['handler']->label() : '');
if (empty($options['info'][$field]['sortable'])) {
$vars['header'][$field] = $label;
}
else {
// @todo -- make this a setting
$initial = 'asc';
if ($active == $field && $order == 'asc') {
$initial = 'desc';
}
$image = theme('tablesort_indicator', $initial);
$title = t('sort by @s', array('@s' => $label));
$link_options = array(
'html' => true,
'attributes' => array('title' => $title),
'query' => 'order=' . urlencode($field) . '&sort=' . $initial . $query,
$vars['header'][$field] = l($label . $image, $_GET['q'], $link_options);
}
}
// Create a second variable so we can easily find what fields we have and what the
// CSS classes should be.
$vars['fields'][$field] = views_css_safe($field);
if ($active == $field) {
$vars['fields'][$field] .= ' active';
}
// Render each field into its appropriate column.
foreach ($result as $num => $row) {
if (!empty($fields[$field]['handler']) && is_object($fields[$field]['handler'])) {
$handler = &$fields[$field]['handler'];
Earl Miles
committed
$field_output = $handler->theme($row);
// Don't bother with separators and stuff if the field does not show up.
if (!$field_output) {
continue;
}
Earl Miles
committed
// Place the field into the column, along with an optional separator.
if (isset($vars['rows'][$num][$column])) {
if (!empty($options['info'][$column]['separator'])) {
$vars['rows'][$num][$column] .= $options['info'][$column]['separator'];
}
}
else {
$vars['rows'][$num][$column] = '';
}
Earl Miles
committed
$vars['rows'][$num][$column] .= $field_output;
}
}
}
}
Earl Miles
committed
/**
* Display a view as a grid style.
*/
function template_preprocess_views_view_grid(&$vars) {
$view = $vars['view'];
$result = $view->result;
$options = $view->style_handler->options;
$handler = $view->style_handler;
$columns = $options['columns'];
$rows = array();
if ($options['alignment'] == 'horizontal') {
$row = array();
foreach ($vars['rows'] as $count => $item) {
$row[] = $item;
if (($count + 1) % $columns == 0) {
$rows[] = $row;
$row = array();
}
}
if ($row) {
Earl Miles
committed
$rows[] = $row;
}
}
else {
$num_rows = floor(count($vars['rows']) / $columns);
// The remainders are the 'odd' columns that are slightly longer.
$remainders = count($vars['rows']) % $columns;
$row = 0;
$col = 0;
foreach ($vars['rows'] as $count => $item) {
$rows[$row][$col] = $item;
$row++;
if (!$remainders && $row == $num_rows) {
$row = 0;
$col++;
}
else if ($remainders && $row == $num_rows + 1) {
$row = 0;
$col++;
$remainders--;
}
Earl Miles
committed
}
}
$vars['rows'] = $rows;
}
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
/**
* Preprocess an RSS feed
*/
function template_preprocess_views_view_rss(&$vars) {
global $base_url;
global $language;
$view = &$vars['view'];
$options = &$vars['options'];
$items = &$vars['rows'];
$style = &$view->style_handler;
if (!empty($options['mission_description'])) {
$description = variable_get('site_mission', '');
}
else {
$description = $options['description'];
}
// Figure out which display which has a path we're using for this feed. If there isn't
// one, use the global $base_url
$link_display = $view->display_handler->get_link_display();
// Compare the link to the default home page; if it's the default home page, just use $base_url.
if (empty($vars['link'])) {
$vars['link'] = $base_url;
}
$vars['namespaces'] = drupal_attributes($style->namespaces);
$vars['channel'] = format_rss_channel($view->get_title(), $vars['link'], $description, $items, $language->language);
drupal_set_header('Content-Type: application/rss+xml; charset=utf-8');
}
Earl Miles
committed
/**
* Default theme function for all filter forms.
*/
function template_preprocess_views_exposed_form(&$vars) {
views_add_css('views');
$form = &$vars['form'];
// Put all single checkboxes together in the last spot.
$checkboxes = '';
if (!empty($form['q'])) {
$vars['q'] = drupal_render($form['q']);
}
Earl Miles
committed
$vars['widgets'] = array();
foreach ($form['#info'] as $id => $info) {
// Set aside checkboxes.
Earl Miles
committed
if (isset($form[$info['value']]['#type']) && $form[$info['value']]['#type'] == 'checkbox') {
Earl Miles
committed
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
$checkboxes .= drupal_render($form[$info['value']]);
continue;
}
$widget = new stdClass;
// set up defaults so that there's always something there.
$widget->label = $widget->operator = $widget->widget = NULL;
if (!empty($info['label'])) {
$widget->label = $info['label'];
}
if (!empty($info['operator'])) {
$widget->operator = drupal_render($form[$info['operator']]);
}
$widget->widget = drupal_render($form[$info['value']]);
$vars['widgets'][$id] = $widget;
}
// Wrap up all the checkboxes we set aside into a widget.
if ($checkboxes) {
$widget = new stdClass;
// set up defaults so that there's always something there.
$widget->label = $widget->operator = $widget->widget = NULL;
$widget->widget = $checkboxes;
$vars['widgets']['checkboxes'] = $widget;
}
// Don't render these:
unset($form['form_id']);
unset($form['form_build_id']);
unset($form['form_token']);
// This includes the submit button.
$vars['button'] = drupal_render($form);
}
function theme_views_mini_pager($tags = array(), $limit = 10, $element = 0, $parameters = array(), $quantity = 9) {
global $pager_page_array, $pager_total;
// Calculate various markers within this pager piece:
// Middle is used to "center" pages around the current page.
$pager_middle = ceil($quantity / 2);
// current is the page we are currently paged to
$pager_current = $pager_page_array[$element] + 1;
// max is the maximum page number
$pager_max = $pager_total[$element];
// End of marker calculations.
$li_previous = theme('pager_previous', (isset($tags[1]) ? $tags[1] : t('‹‹')), $limit, $element, 1, $parameters);
$li_next = theme('pager_next', (isset($tags[3]) ? $tags[3] : t('››')), $limit, $element, 1, $parameters);
if ($pager_total[$element] > 1) {
$items[] = array(
'class' => 'pager-previous',
'data' => $li_previous,
);
$items[] = array(
'class' => 'pager-current',
'data' => t('@current of @max', array('@current' => $pager_current, '@max' => $pager_max)),
);
$items[] = array(
'class' => 'pager-next',
'data' => $li_next,
);
return theme('item_list', $items, NULL, 'ul', array('class' => 'pager'));
}
}
/**
* @defgroup views_templates Views' template files
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
* @{
* All views templates can be overridden with a variety of names, using
* the view, the display ID of the view, the display type of the view,
* or some combination thereof.
*
* For each view, there will be a minimum of two templates used. The first
* is used for all views: views-view.tpl.php.
*
* The second template is determined by the style selected for the view. Note
* that certain aspects of the view can also change which style is used; for
* example, arguments which provide a summary view might change the style to
* one of the special summary styles.
*
* The default style for all views is views-view-unformatted.tpl.php
*
* Many styles will then farm out the actual display of each row to a row
* style; the default row style is views-view-fields.tpl.php.
*
* Here is an example of all the templates that will be tried in the following
* case:
*
* View, named foobar. Style: unformatted. Row style: Fields. Display: Page.
*
* - views-view--page--foobar.tpl.php
* - views-view--page.tpl.php
* - views-view--foobar.tpl.php
* - views-view.tpl.php
*
* - views-view-unformatted--page--foobar.tpl.php
* - views-view-unformatted--page.tpl.php
* - views-view-unformatted--foobar.tpl.php
* - views-view-unformatted.tpl.php
*
* - views-view-fields--page--foobar.tpl.php
* - views-view-fields--page.tpl.php
* - views-view-fields--foobar.tpl.php
* - views-view-fields.tpl.php
*
* Important! When adding a new template to your theme, be sure to flush the
* theme registry cache! Simply visit admin/build/themes.
*
* @see _views_theme_functions
* @}