Newer
Older
* Primarily Drupal hooks and global API functions to manipulate views.
*
* This is the main module file for Views. The main entry points into
* this module are views_page() and views_block(), where it handles
* incoming page and block requests.
* Implementation of hook_theme(). Register views theming functions.
function views_theme() {
$path = drupal_get_path('module', 'views');
require_once "./$path/theme/theme.inc";
// Some quasi clever array merging here.
// Our extra version of pager from pager.inc
$hooks['views_mini_pager'] = $base + array(
'arguments' => array('tags' => array(), 'limit' => 10, 'element' => 0, 'parameters' => array()),
);
$arguments = array(
'display' => array('view' => NULL),
'style' => array('view' => NULL, 'options' => NULL, 'rows' => NULL),
'row' => array('view' => NULL, 'options' => NULL, 'row' => NULL),
);
// Default view themes
$hooks['views_view_field'] = $base + array(
'pattern' => 'views_view_field__',
'arguments' => array('view' => NULL, 'field' => NULL, 'row' => NULL),
$plugins = views_fetch_plugin_data();
// Register theme functions for all style plugins
foreach ($plugins as $type => $info) {
foreach ($info as $plugin => $def) {
if (isset($def['theme'])) {
$hooks[$def['theme']] = array(
'pattern' => $def['theme'] . '__',
'path' => $def['path'],
'arguments' => $arguments[$type],
);
if (!function_exists('theme_' . $def['theme'])) {
$hooks[$def['theme']]['template'] = views_css_safe($def['theme']);
if (isset($def['additional themes'])) {
foreach ($def['additional themes'] as $theme => $theme_type) {
if (empty($theme_type)) {
$theme = $theme_type;
$theme_type = $type;
}
$hooks[$theme] = array(
'pattern' => $theme . '__',
'file' => $def['file'],
'path' => $def['path'],
'arguments' => $arguments[$theme_type],
);
if (!function_exists('theme_' . $theme)) {
$hooks[$theme]['template'] = views_css_safe($theme);
}
}
}
Earl Miles
committed
Earl Miles
committed
$hooks['views_exposed_form'] = $base + array(
'template' => 'views-exposed-form',
'pattern' => 'views_exposed_form__',
'arguments' => array('form' => NULL),
);
$hooks['views_more'] = $base + array(
'template' => 'views-more',
'pattern' => 'views_more__',
'arguments' => array('more_url' => NULL),
);
Earl Miles
committed
}
/**
* Implementation of hook_help().
*/
function views_help($path, $arg) {
switch ($path) {
case 'admin/help#views':
$output = '<p>'. t('The views module allows administrators and site designers to create, manage, and display lists of content. Each list managed by the views module is known as a "view", and the output of a view is known as a "display". Displays are provided in either block or page form, and a single view may have multiple displays. Optional navigation aids, including a system path and menu item, can be set for each page-based display of a view. By default, views may be created that list content (a <em>Node</em> view type), content revisions (a <em>Node revisions</em> view type) or users (a <em>User</em> view type). A view may be restricted to members of specific user roles, and may be added, edited or deleted at the <a href="@views-administration">views administration page</a>.', array('@views-api' => 'http://drupal.org/handbook/modules/views/api', '@views-administration' => url('admin/build/views'))) .'</p>';
$output .= '<p>'. t('The "building block" design of the views system provides power and flexibility, allowing parameters to be specified only when needed. While an advanced view may use all of available parameters to create complex and highly interactive applications, a simple content listing may specify only a few options. All views rely on a conceptual framework that includes:') .'</p>';
$output .= '<ul>';
$output .= '<li>'. t('<em>fields</em>, or the individual pieces of data being displayed. Adding the fields <em>Node: Title</em>, <em>Node: Type</em>, and <em>Node: Post date</em> to a node view, for example, includes the title, content type and creation date in the displayed results.') .'</li>';
$output .= '<li>'. t('<em>relationships</em>, or information about how data elements relate to one another. If relationship data is available, like that provided by a CCK <em>nodereference</em> field, items from a related node may be included in the view.') .'</li>';
$output .= '<li>'. t('<em>arguments</em>, or additional parameters that dynamically refine the view results, passed as part of the path. Adding an argument of <em>Node: Type</em> to a node view with a path of "content", for example, dynamically filters the displayed items by content type. In this example (shown with Clean URLs enabled), accessing the view through the path "http://www.example.com/content/page" displays all posts of the type "page", the path "http://www.example.com/content/story" displays all posts of the type "story", and "http://www.example.com/content" displays all posts regardless of type.') .'</li>';
$output .= '<li>'. t('<em>sort criteria</em>, which determines the order of items displayed in the view results. Adding the sort criteria <em>Node: Post date</em> (in descending order) to a node <em>view</em>, for example, sorts the displayed posts in descending order by creation date.') .'</li>';
$output .= '<li>'. t('<em>filters</em>, which limit items displayed in the results. Adding the filter <em>Node: Published</em> (and setting it equal to "Published") to a node view, for example, prevents unpublished items from being displayed.') .'</li>';
$output .= '</ul>';
$output .= '<p>'. t('For more information, see the online handbook entry for <a href="@handbook-views">Views</a> or the <a href="@project-views">Views project page</a>.', array('@handbook-views' => 'http://drupal.org/handbook/modules/views', '@project-views' => 'http://drupal.org/project/views')) .'</p>';
return $output;
}
}
Earl Miles
committed
/**
* Implementation of hook_menu().
Earl Miles
committed
*/
function views_menu() {
$items = array();
$items['views/ajax'] = array(
'title' => 'Views',
'page callback' => 'views_ajax',
'access callback' => 'user_access',
'access arguments' => array('access content'),
'description' => 'Ajax callback for view loading.',
'type' => MENU_CALLBACK,
);
Earl Miles
committed
return $items;
}
Earl Miles
committed
/**
* Implementation of hook_menu_alter().
*/
function views_menu_alter(&$callbacks) {
$our_paths = array();
Earl Miles
committed
foreach (views_get_page_views() as $data) {
list($view, $display_id) = $data;
$result = $view->execute_hook_menu($display_id);
if (is_array($result)) {
// The menu system doesn't support having two otherwise
// identical paths with different placeholders. So we
// want to remove the existing items from the menu whose
// paths would conflict with ours.
// First, we must find any existing menu items that may
// conflict. We use a regular expression because we don't
// know what placeholders they might use. Note that we
// first construct the regex itself by replacing %views_arg
// in the display path, then we use this constructed regex
// (which will be something like '#^(foo/%[^/]*/bar)$#') to
// search through the existing paths.
Earl Miles
committed
$regex = '#^('. preg_replace('#%views_arg#', '%[^/]*', implode('|', array_keys($result))) .')$#';
Earl Miles
committed
$matches = preg_grep($regex, array_keys($callbacks));
// Remove any conflicting items that were found.
Earl Miles
committed
foreach ($matches as $path) {
// Don't remove the paths we just added!
if (!isset($our_paths[$path])) {
Earl Miles
committed
unset($callbacks[$path]);
}
}
foreach ($result as $path => $item) {
if (!isset($callbacks[$path])) {
// Add a new item, possibly replacing (and thus effectively
// overriding) one that we removed above.
$callbacks[$path] = $item;
}
else {
// This item already exists, so it must be one that we added.
// We change the various callback arguments to pass an array
// of possible display IDs instead of a single ID.
Earl Miles
committed
$callbacks[$path]['page arguments'][1] = (array)$callbacks[$path]['page arguments'][1];
$callbacks[$path]['page arguments'][1][] = $display_id;
$callbacks[$path]['access arguments'][0][1] = (array)$callbacks[$path]['access arguments'][0][1];
$callbacks[$path]['access arguments'][0][1][] = $display_id;
$callbacks[$path]['load arguments'][1] = (array)$callbacks[$path]['load arguments'][1];
$callbacks[$path]['load arguments'][1][] = $display_id;
}
$our_paths[$path] = TRUE;
Earl Miles
committed
}
}
}
}
Earl Miles
committed
/**
Earl Miles
committed
* Helper function for menu loading. This will automatically be
Earl Miles
committed
* called in order to 'load' a views argument; primarily it
* will be used to perform validation.
*
* @param $value
* The actual value passed.
* @param $name
* The name of the view. This needs to be specified in the 'load function'
* of the menu entry.
* @param $index
Earl Miles
committed
* The menu argument index. This counts from 1.
Earl Miles
committed
*/
function views_arg_load($value, $name, $display_id, $index) {
Earl Miles
committed
if ($view = views_get_view($name)) {
Earl Miles
committed
$view->init_handlers();
$ids = array_keys($view->argument);
$indexes = array();
$path = explode('/', $view->get_url());
foreach ($path as $id => $piece) {
if ($piece == '%' && !empty($ids)) {
$indexes[$id] = array_shift($ids);
}
}
if (isset($indexes[$index])) {
if (isset($view->argument[$indexes[$index]])) {
Earl Miles
committed
return $view->argument[$indexes[$index]]['handler']->validate_argument($value) ? $value : NULL;
Earl Miles
committed
}
}
}
/**
* Page callback entry point; requires a view and a display id, then
* passes control to the display handler.
*/
function views_page() {
$args = func_get_args();
$name = array_shift($args);
$display_id = array_shift($args);
// Load the view
Earl Miles
committed
if ($view = views_get_view($name)) {
Earl Miles
committed
return $view->execute_display($display_id, $args);
}
// Fallback; if we get here no view was found or handler was not valid.
return drupal_not_found();
}
/**
* Implementation of hook_block
*/
function views_block($op = 'list', $delta = 0, $edit = array()) {
switch ($op) {
case 'list':
$items = array();
foreach (views_get_block_views() as $data) {
list($view, $display_id) = $data;
Earl Miles
committed
$result = $view->execute_hook_block($display_id);
if (is_array($result)) {
Earl Miles
committed
}
Earl Miles
committed
}
Earl Miles
committed
// block.module has a delta length limit of 32, but our deltas can
// unfortunately be longer because view names can be 32 and display IDs
// can also be 32. So for very long deltas, change to md5 hashes.
$hashes = array();
// get the keys because we're modifying the array and we don't want to
// confuse PHP too much.
$keys = array_keys($items);
foreach ($keys as $delta) {
if (strlen($delta) >= 32) {
$hash = md5($delta);
$hashes[$hash] = $delta;
$items[$hash] = $items[$delta];
unset($items[$delta]);
}
}
variable_set('views_block_hashes', $hashes);
Earl Miles
committed
return $items;
case 'view':
Earl Miles
committed
// if this is 32, this should be an md5 hash.
if (strlen($delta) == 32) {
$hashes = variable_get('views_block_hashes', array());
if (!empty($hashes[$delta])) {
$delta = $hashes[$delta];
}
}
Earl Miles
committed
list($name, $display_id) = explode('-', $delta);
// Load the view
Earl Miles
committed
if ($view = views_get_view($name)) {
if ($view->access($display_id)) {
return $view->execute_display($display_id);
Earl Miles
committed
}
break;
}
}
* Implementation of hook_flush_caches().
return array('cache_views');
}
/**
* Invalidate the views cache, forcing a rebuild on the next grab of table data.
*/
function views_invalidate_cache() {
cache_clear_all('*', 'cache_views', true);
}
Earl Miles
committed
/**
* Determine if the given user has access to the view + display.
*
* @param $view
* May be a view object, or an array with the view name and the display ID,
* or a string to use as the view name.
* @param $account
* An optional account to use; if left off, the current user will be used.
Earl Miles
committed
*/
function views_access($view, $account = NULL) {
if (is_array($view)) {
list($name, $display_id) = $view;
Earl Miles
committed
$view = views_get_view($name);
if (!$view) {
Earl Miles
committed
}
elseif (is_string($view)) {
Earl Miles
committed
$view = views_get_view($view);
if (!$view) {
Earl Miles
committed
return FALSE;
}
$display_id = 'default';
}
else {
Earl Miles
committed
// Clone the view to prevent problems.
$view = $view->clone_view();
$display_id = isset($view->current_display) ? $view->current_display : 'default';
Earl Miles
committed
}
return $view->access($display_id, $account);
Earl Miles
committed
}
/**
* Menu callback to load a view via AJAX.
*/
function views_ajax() {
if (isset($_REQUEST['view_name']) && isset($_REQUEST['view_display_id'])) {
$name = $_REQUEST['view_name'];
$display_id = $_REQUEST['view_display_id'];
$args = isset($_REQUEST['view_args']) ? explode('/', $_REQUEST['view_args']) : array();
$path = isset($_REQUEST['view_path']) ? $_REQUEST['view_path'] : NULL;
views_include('ajax');
$object = new stdClass();
$object->status = FALSE;
$object->display = '';
// Load the view.
Earl Miles
committed
if ($view = views_get_view($name)) {
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
if ($view->access($display_id)) {
// Fix 'q' for paging.
if (!empty($path)) {
$_GET['q'] = $path;
}
$errors = $view->validate();
if ($errors === TRUE) {
$object->status = TRUE;
$object->title = $view->get_title();
$object->display .= $view->preview($display_id, $args);
}
else {
foreach ($errors as $error) {
drupal_set_message($error, 'error');
}
}
// Register the standard JavaScript callback.
$object->__callbacks = array('Drupal.Views.Ajax.ajaxViewResponse');
// Allow other modules to extend the data returned.
drupal_alter('ajax_data', $object, 'views', $view);
}
}
$messages = theme('status_messages');
$object->messages = $messages ? '<div class="views-messages">'. $messages .'</div>' : '';
views_ajax_render($object);
}
}
Earl Miles
committed
/**
* Set the current 'page view' that is being displayed so that it is easy
* for other modules or the theme to identify.
*/
function &views_set_page_view($view = NULL) {
static $cache = NULL;
if (isset($view)) {
$cache = $view;
}
return $cache;
}
/**
* Find out what, if any, page view is currently in use. Please note that
* this returns a reference, so be careful! You can unintentionally modify the
* $view object.
*/
function &views_get_page_view() {
return views_set_page_view();
}
/**
* Set the current 'current view' that is being built/rendered so that it is
* easy for other modules or items in drupal_eval to identify
*/
Earl Miles
committed
function &views_set_current_view($view = NULL) {
static $cache = NULL;
if (isset($view)) {
Earl Miles
committed
$cache = $view;
}
return $cache;
}
/**
* Find out what, if any, current view is currently in use. Please note that
* this returns a reference, so be careful! You can unintentionally modify the
* $view object.
*/
function &views_get_current_view() {
return views_set_current_view();
}
/**
* Include views .inc files as necessary.
*/
function views_include($file) {
static $used = array();
if (!isset($used[$file])) {
require_once './' . drupal_get_path('module', 'views') . "/includes/$file.inc";
}
$used[$file] = TRUE;
/**
* Load views files on behalf of modules.
*/
function views_module_include($file) {
$views_path = drupal_get_path('module', 'views') . '/modules';
foreach (module_list() as $module) {
$module_path = drupal_get_path('module', $module);
if (file_exists("$module_path/$module.$file")) {
require_once "./$module_path/$module.$file";
}
else if (file_exists("$module_path/includes/$module.$file")) {
require_once "./$module_path/includes/$module.$file";
}
else if (file_exists("$views_path/$module.$file")) {
require_once "./$views_path/$module.$file";
}
}
}
/**
* Include views .css files.
*/
function views_add_css($file) {
drupal_add_css(drupal_get_path('module', 'views') . "/css/$file.css");
}
/**
* Include views .js files.
*/
function views_add_js($file) {
static $base = TRUE;
if ($base) {
drupal_add_js(drupal_get_path('module', 'views') . "/js/base.js");
}
drupal_add_js(drupal_get_path('module', 'views') . "/js/$file.js");
}
/**
* Prepare the specified string for use as a CSS identifier.
*/
function views_css_safe($string) {
return str_replace('_', '-', $string);
}
// -----------------------------------------------------------------------
// Views handler functions
/**
* Load views files on behalf of modules.
*/
function views_include_handlers() {
static $finished = FALSE;
// Ensure this only gets run once.
if ($finished) {
return;
}
views_include('cache');
_views_include_handlers();
/**
* Load default views files on behalf of modules.
*/
function views_include_default_views() {
static $finished = FALSE;
// Ensure this only gets run once.
if ($finished) {
return;
}
// Default views hooks may be in the normal handler file,
// or in a separate views_default file at the discretion of
Earl Miles
committed
// the module author.
views_include_handlers();
Earl Miles
committed
_views_include_default_views();
$finished = TRUE;
}
/**
* Fetch a handler from the data cache.
*/
function views_get_handler($table, $field, $key) {
$data = views_fetch_data($table);
if (isset($data[$field][$key])) {
return _views_prepare_handler($data[$field][$key], $data, $field);
}
// DEBUG -- identify missing handlers
Earl Miles
committed
vpr("Missing handler: $table $field $key");
/**
* Fetch Views' data from the cache
*/
function views_fetch_data($table = NULL) {
views_include('cache');
return _views_fetch_data($table);
Earl Miles
committed
function _views_weight_sort($a, $b) {
if ($a['weight'] != $b['weight']) {
return $a['weight'] < $b['weight'] ? -1 : 1;
}
if ($a['title'] != $b['title']) {
return $a['title'] < $b['title'] ? -1 : 1;
}
return 0;
}
/**
* Fetch a list of all base tables available
*
* @return
* A keyed array of in the form of 'base_table' => 'Description'.
*/
function views_fetch_base_tables() {
static $base_tables = array();
if (empty($base_tables)) {
Earl Miles
committed
$weights = array();
$tables = array();
$data = views_fetch_data();
foreach ($data as $table => $info) {
if (!empty($info['table']['base'])) {
Earl Miles
committed
$tables[$table] = array(
'title' => $info['table']['base']['title'],
'description' => $info['table']['base']['help'],
Earl Miles
committed
'weight' => !empty($info['table']['base']['weight']) ? $info['table']['base']['weight'] : 0,
);
Earl Miles
committed
uasort($tables, '_views_weight_sort');
function _views_sort_types($a, $b) {
if ($a['group'] != $b['group']) {
return $a['group'] < $b['group'] ? -1 : 1;
}
if ($a['title'] != $b['title']) {
return $a['title'] < $b['title'] ? -1 : 1;
}
return 0;
}
Earl Miles
committed
/**
* Fetch a list of all fields available for a given base type.
Earl Miles
committed
*
* @return
* A keyed array of in the form of 'base_table' => 'Description'.
*/
function views_fetch_fields($base, $type) {
Earl Miles
committed
static $fields = array();
if (empty($fields)) {
$data = views_fetch_data();
$start = microtime();
// This constructs this ginormous multi dimensional array to
// collect the important data about fields. In the end,
// the structure looks a bit like this (using nid as an example)
// $strings['nid']['filter']['title'] = 'string'.
//
// This is constructed this way because the above referenced strings
// can appear in different places in the actual data structure so that
// the data doesn't have to be repeated a lot. This essentially lets
// each field have a cheap kind of inheritance.
Earl Miles
committed
foreach ($data as $table => $table_data) {
$bases = array();
$strings = array();
foreach ($table_data as $field => $info) {
// Collect table data from this table
if ($field == 'table') {
// calculate what tables this table can join to.
if (!empty($info['join'])) {
$bases = array_keys($info['join']);
}
// And if this table IS a base table it obviously joins to itself.
if (!empty($info['base'])) {
$bases[] = $table;
}
continue;
}
Earl Miles
committed
foreach (array('field', 'sort', 'filter', 'argument', 'relationship') as $key) {
Earl Miles
committed
if (!empty($info[$key])) {
foreach (array('title', 'group', 'help', 'base') as $string) {
Earl Miles
committed
// First, try the lowest possible level
if (!empty($info[$key][$string])) {
$strings[$field][$key][$string] = $info[$key][$string];
}
// Then try the field level
elseif (!empty($info[$string])) {
$strings[$field][$key][$string] = $info[$string];
}
// Finally, try the table level
elseif (!empty($table_data['table'][$string])) {
$strings[$field][$key][$string] = $table_data['table'][$string];
}
else {
if ($string != 'base') {
$strings[$field][$key][$string] = t("Error: missing @component", array('@component' => $string));
}
Earl Miles
committed
}
}
}
}
}
foreach ($bases as $base_name) {
foreach ($strings as $field => $field_strings) {
foreach ($field_strings as $type_name => $type_strings) {
$fields[$base_name][$type_name]["$table.$field"] = $type_strings;
Earl Miles
committed
}
}
}
}
// vsm('Views UI data build time: ' . (microtime() - $start) * 1000 . ' ms');
}
// If we have an array of base tables available, go through them
// all and add them together. Duplicate keys will be lost and that's
// Just Fine.
if (is_array($base)) {
$strings = array();
foreach ($base as $base_table) {
if (isset($fields[$base_table][$type])) {
$strings += $fields[$base_table][$type];
}
}
uasort($strings, '_views_sort_types');
return $strings;
}
Earl Miles
committed
if (isset($fields[$base][$type])) {
uasort($fields[$base][$type], '_views_sort_types');
Earl Miles
committed
return $fields[$base][$type];
}
return array();
}
// -----------------------------------------------------------------------
// Views plugin functions
/**
* Fetch the plugin data from cache.
*/
function views_fetch_plugin_data($type = NULL, $plugin = NULL) {
views_include('cache');
return _views_fetch_plugin_data($type, $plugin);
* Get a handler for a plugin
function views_get_plugin($type, $plugin) {
$definition = views_fetch_plugin_data($type, $plugin);
if (!empty($definition)) {
return _views_create_handler($definition);
}
* @param $type
* Either 'display', 'style' or 'row'
* @param $key
* For style plugins, this is an optional type to restrict to. May be 'normal',
* 'summary', 'feed' or others based on the neds of the display.
* @param $base
* An array of possible base tables.
* @return
* A keyed array of in the form of 'base_table' => 'Description'.
function views_fetch_plugin_names($type, $key = NULL, $base = array()) {
$data = views_fetch_plugin_data();
$plugins[$type] = array();
foreach ($data[$type] as $id => $plugin) {
// Skip plugins that don't conform to our key.
if ($key && (empty($plugin['type']) || $plugin['type'] != $key)) {
if (empty($plugin['no ui']) && (empty($base) || empty($plugin['base']) || array_intersect($base, $plugin['base']))) {
return $plugins[$type];
}
// fall-through
return array();
Earl Miles
committed
// -----------------------------------------------------------------------
// Views database functions
/**
* Get a view from the default views defined by modules.
Earl Miles
committed
*
* Default views are cached per-language. This function will rescan the
* default_views hook if necessary.
*
* @param $view_name
* The name of the view to load.
* @return
* A view object or NULL if it is not available.
*/
function &views_get_default_view($view_name) {
$cache = views_discover_default_views();
Earl Miles
committed
if (isset($cache[$view_name])) {
return $cache[$view_name];
}
return $null;
}
/**
* Create an empty view to work with.
*
* @return
* A fully formed, empty $view object. This object must be populated before
* it can be successfully saved.
*/
function views_new_view() {
views_include('view');
$view = new view();
$view->vid = 'new';
}
/**
* Scan all modules for default views and rebuild the default views cache.
*
* @return An associative array of all known default views.
*/
function views_discover_default_views() {
Earl Miles
committed
static $cache = array();
Earl Miles
committed
if (empty($cache)) {
views_include('cache');
$cache = _views_discover_default_views();
Earl Miles
committed
}
return $cache;
}
/**
* Get a list of all views and the display plugins that provide
* page support to the Drupal menu system. Since views can appear
* in this list multiple times, the return of this function is an
* array of arrays.
Earl Miles
committed
*
* @return
* @code
* array(
* array($view, $display_id),
* array($view, $display_id),
* );
*/
function views_get_page_views() {
Earl Miles
committed
return views_get_applicable_views('uses hook menu');
}
/**
* Get a list of all views and the display plugins that provide
* themselves to the Drupal block system. Since views can appear
* in this list multiple times, the return of this function is an
* array of arrays.
Earl Miles
committed
*
* @return
* @code
* array(
* array($view, $display_id),
* array($view, $display_id),
* );
*/
function views_get_block_views() {
Earl Miles
committed
return views_get_applicable_views('uses hook block');
Earl Miles
committed
}
/**
* Return a list of all views and display IDs that have a particular
* setting in their display's plugin settings.
Earl Miles
committed
*
* @return
Earl Miles
committed
* @code
Earl Miles
committed
* array(
* array($view, $display_id),
* array($view, $display_id),
* );
Earl Miles
committed
*/
function views_get_applicable_views($type) {
Earl Miles
committed
// @todo: Use a smarter flagging system so that we don't have to
// load every view for this.
$result = array();
$views = views_get_all_views();
Earl Miles
committed
foreach ($views as $view) {
// Skip disabled views.
if (!empty($view->disabled)) {
continue;
}
if (empty($view->display)) {
// Skip this view as it is broken.
vsm(t("Skipping broken view @view", array('@view' => $view->name)));
continue;
}
// Loop on array keys because something seems to muck with $view->display
// a bit in PHP4.
foreach (array_keys($view->display) as $id) {
$plugin = views_fetch_plugin_data('display', $view->display[$id]->display_plugin);
if (!empty($plugin[$type])) {
Earl Miles
committed
// This view uses hook menu. Clone it so that different handlers
// don't trip over each other, and add it to the list.
Earl Miles
committed
$v = $view->clone_view();
if ($v->set_display($id)) {
$result[] = array($v, $id);
Earl Miles
committed
// In PHP 4.4.7 and presumably earlier, if we do not unset $v
// here, we will find that it actually overwrites references
// possibly due to shallow copying issues.
unset($v);
Earl Miles
committed
}
}
}
return $result;
}
/**
* Return an array of all views as fully loaded $view objects.
function views_get_all_views() {
static $views = array();
Earl Miles
committed
if (empty($views)) {
// First, get all applicable views.
views_include('view');
$views = view::load_views();
// Get all default views.
$status = variable_get('views_defaults', array());
foreach (views_discover_default_views() as $view) {
// Determine if default view is enabled or disabled.
if (isset($status[$view->name])) {
$view->disabled = $status[$view->name];
}
// If overridden, also say so.
if (!empty($views[$view->name])) {
$views[$view->name]->type = t('Overridden');
}
else {
$view->type = t('Default');
$views[$view->name] = $view;
}
}
}
return $views;
}
/**
* Get a view from the database or from default views.
*
* This function is just a static wrapper around views::load(). This function
* isn't called 'views_load()' primarily because it might get a view
* from the default views which aren't technically loaded from the database.
*
* @param $name
* The name of the view.
* @param $reset
* If TRUE, reset this entry in the load cache.
* @return $view
* A reference to the $view object. Use $reset if you're sure you want
* a fresh one.
*/
function views_get_view($name, $reset = FALSE) {
views_include('view');
$view = view::load($name, $reset);
$default_view = views_get_default_view($name);
if (empty($view) && empty($default_view)) {
return;
}
elseif (empty($view) && !empty($default_view)) {
$default_view->type = t('Default');
return $default_view->clone_view();
}
elseif (!empty($view) && !empty($default_view)) {
$view->type = t('Overridden');
}
return $view->clone_view();
}
/**
* Basic definition for many views objects
*/
class views_object {
/**
* Views handlers use a special construct function so that we can more
* easily construct them with variable arguments.
*/
function construct() { }
/**
* Let the handler know what its full definition is.
*/
function set_definition($definition) {
$this->definition = $definition;
if (isset($definition['field'])) {
$this->real_field = $definition['field'];
Earl Miles
committed
}
Earl Miles
committed
/**
* Provide debug output for Views. This relies on devel.module
*/
function views_debug($message) {
if (module_exists('devel')) {
drupal_set_content('footer', dpr($message, TRUE));
}
}
/**
* Shortcut to views_debug()
*/
function vpr($message) {
views_debug($message);
}
/**
* Debug messages
*/
function vsm($message) {
if (module_exists('devel')) {
dsm($message);