[ Index ]

PHP Cross Reference of Drupal 6 (gatewave)

title

Body

[close]

/sites/all/modules/views/ -> views.module (summary)

(no description)

File Size: 1345 lines (39 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 58 functions

  views_api_version()
  views_init()
  views_theme()
  views_preprocess_node()
  views_preprocess_comment()
  views_perm()
  views_menu()
  views_menu_alter()
  views_arg_load()
  views_page()
  views_block()
  views_flush_caches()
  views_invalidate_cache()
  views_import_access()
  views_access()
  views_check_perm()
  views_check_roles()
  views_set_page_view()
  views_get_page_view()
  views_set_current_view()
  views_get_current_view()
  views_include()
  views_module_include()
  views_get_module_apis()
  views_add_css()
  views_add_js()
  views_include_handlers()
  views_include_default_views()
  views_get_handler()
  views_fetch_data()
  views_fetch_plugin_data()
  views_get_plugin()
  views_get_default_view()
  views_new_view()
  views_discover_default_views()
  views_get_applicable_views()
  views_get_all_views()
  views_get_view()
  views_debug()
  vpr()
  vsm()
  views_trace()
  vsm_trace()
  vpr_trace()
  views_exposed_form()
  views_exposed_form_validate()
  views_exposed_form_submit()
  views_exposed_form_cache()
  views_theme_functions()
  drupal_build_form()
  views_views_query_substitutions()
  views_embed_view()
  views_get_view_result()
  views_var_export()
  views_css_safe()
  views_views_exportables()
  views_microtime()
  views_trim_text()

Functions
Functions that are not part of a class:

views_api_version()   X-Ref
Advertise the current views api version


views_init()   X-Ref
Implementation of hook_init().


views_theme()   X-Ref
Implementation of hook_theme(). Register views theming functions.


views_preprocess_node(&$vars)   X-Ref
A theme preprocess function to automatically allow view-based node
templates if called from a view.

The 'modules/node.views.inc' file is a better place for this, but
we haven't got a chance to load that file before Drupal builds the
node portion of the theme registry.

views_preprocess_comment(&$vars)   X-Ref
A theme preprocess function to automatically allow view-based node
templates if called from a view.


views_perm()   X-Ref
No description

views_menu()   X-Ref
Implementation of hook_menu().


views_menu_alter(&$callbacks)   X-Ref
Implementation of hook_menu_alter().


views_arg_load($value, $name, $display_id, $index)   X-Ref
Helper function for menu loading. This will automatically be
called in order to 'load' a views argument; primarily it
will be used to perform validation.

param: $value
param: $name
param: $index

views_page()   X-Ref
Page callback entry point; requires a view and a display id, then
passes control to the display handler.


views_block($op = 'list', $delta = 0, $edit = array()   X-Ref
Implementation of hook_block


views_flush_caches()   X-Ref
Implementation of hook_flush_caches().


views_invalidate_cache()   X-Ref
Invalidate the views cache, forcing a rebuild on the next grab of table data.


views_import_access()   X-Ref
Access callback to determine if the user can import Views.

View imports require an additional access check because they are PHP
code and PHP is more locked down than administer views.

views_access()   X-Ref
Determine if the logged in user has access to a view.

This function should only be called from a menu hook or some other
embedded source. Each argument is the result of a call to
views_plugin_access::get_access_callback() which is then used
to determine if that display is accessible. If *any* argument
is accessible, then the view is accessible.

views_check_perm($perm, $account = NULL)   X-Ref
Access callback for the views_plugin_access_perm access plugin.

Determine if the specified user has access to a view on the basis of
permissions. If the $account argument is omitted, the current user
is used.

views_check_roles($rids, $account = NULL)   X-Ref
Access callback for the views_plugin_access_role access plugin.
Determine if the specified user has access to a view on the basis of any of
the requested roles. If the $account argument is omitted, the current user
is used.


views_set_page_view($view = NULL)   X-Ref
Set the current 'page view' that is being displayed so that it is easy
for other modules or the theme to identify.


views_get_page_view()   X-Ref
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.


views_set_current_view($view = NULL)   X-Ref
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


views_get_current_view()   X-Ref
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.


views_include($file)   X-Ref
Include views .inc files as necessary.


views_module_include($file)   X-Ref
Load views files on behalf of modules.


views_get_module_apis()   X-Ref
Get a list of modules that support the current views API.


views_add_css($file)   X-Ref
Include views .css files.


views_add_js($file)   X-Ref
Include views .js files.


views_include_handlers()   X-Ref
Load views files on behalf of modules.


views_include_default_views()   X-Ref
Load default views files on behalf of modules.


views_get_handler($table, $field, $key)   X-Ref
Fetch a handler from the data cache.

param: $table
param: $field
param: $key
return:

views_fetch_data($table = NULL)   X-Ref
Fetch Views' data from the cache


views_fetch_plugin_data($type = NULL, $plugin = NULL)   X-Ref
Fetch the plugin data from cache.


views_get_plugin($type, $plugin)   X-Ref
Get a handler for a plugin


views_get_default_view($view_name)   X-Ref
Get a view from the default views defined by modules.

Default views are cached per-language.  This function will rescan the
default_views hook if necessary.

param: $view_name
return:

views_new_view()   X-Ref
Create an empty view to work with.

return:

views_discover_default_views()   X-Ref
Scan all modules for default views and rebuild the default views cache.

return: An associative array of all known default views.

views_get_applicable_views($type)   X-Ref
Return a list of all views and display IDs that have a particular
setting in their display's plugin settings.

return:

views_get_all_views($reset = FALSE)   X-Ref
Return an array of all views as fully loaded $view objects.

param: $reset

views_get_view($name, $reset = FALSE)   X-Ref
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
param: $reset
return: $view

views_debug($message)   X-Ref
Provide debug output for Views. This relies on devel.module


vpr($message)   X-Ref
Shortcut to views_debug()


vsm($message)   X-Ref
Debug messages


views_trace()   X-Ref
No description

vsm_trace()   X-Ref
No description

vpr_trace()   X-Ref
No description

views_exposed_form(&$form_state)   X-Ref
Form builder for the exposed widgets form.

Be sure that $view and $display are references.

views_exposed_form_validate(&$form, &$form_state)   X-Ref
Validate handler for exposed filters


views_exposed_form_submit(&$form, &$form_state)   X-Ref
Submit handler for exposed filters


views_exposed_form_cache($views_name, $display_name, $form_output = NULL)   X-Ref
Save the Views exposed form for later use.

param: $views_name
param: $display_name
param: $form_output
return:

views_theme_functions($hook, $view, $display = NULL)   X-Ref
Build a list of theme function names for use most everywhere.


drupal_build_form($form_id, &$form_state)   X-Ref
Views' replacement for drupal_get_form so that we can do more with
less.

Items that can be set on the form_state include:
- input: The source of input. If unset this will be $_POST.
- no_redirect: Absolutely do not redirect the form even if instructed
to do so.
- rerender: If no_redirect is set and the form was successfully submitted,
rerender the form. Otherwise it will just return.


views_views_query_substitutions($view)   X-Ref
Substitute current time; this works with cached queries.


views_embed_view($name, $display_id = 'default')   X-Ref
Embed a view using a PHP snippet.

This function is meant to be called from PHP snippets, should one wish to
embed a view in a node or something. It's meant to provide the simplest
solution and doesn't really offer a lot of options, but breaking the function
apart is pretty easy, and this provides a worthwhile guide to doing so.

Note that this function does NOT display the title of the view. If you want
to do that, you will need to do what this function does manually, by
loading the view, getting the preview and then getting $view->get_title().

param: $name
param: $display_id
param: ...

views_get_view_result($name, $display_id = NULL)   X-Ref
Get the result of a view.

param: string $name
param: string $display_id
param: ...
return:

views_var_export($var, $prefix = '', $init = TRUE)   X-Ref
Export a field.


views_css_safe($string)   X-Ref
Prepare the specified string for use as a CSS identifier.


views_views_exportables($op = 'list', $views = NULL, $name = 'foo')   X-Ref
Implementation of hook_views_exportables().


views_microtime()   X-Ref
Microtime helper function to return a float time value (php4 & php5 safe).


views_trim_text($alter, $value)   X-Ref
Trim the field down to the specified length.

param: $alter



Generated: Thu Mar 24 11:18:33 2011 Cross-referenced by PHPXref 0.7