diff --git a/docs/docs.php b/docs/docs.php new file mode 100644 index 0000000000000000000000000000000000000000..1a4fb668c5bb1c5b264b6b78d918bc77546c041c --- /dev/null +++ b/docs/docs.php @@ -0,0 +1,137 @@ +<?php +// $Id$ +/** + * @file + * This file contains no working PHP code; it exists to provide additional documentation + * for doxygen as well as to document hooks in the standard Drupal manner. + */ + +/** + * @mainpage Views 2 API Manual + * + * This is a stub for the main page. + * + * Topics: + * - @ref view_lifetime + * - @ref views_hooks + * - @ref views_handlers + * - @ref views_plugins + */ + +/** + * @page view_lifetime The life of a view + * + * This page explains the basic cycle of a view and what processes happen. + */ + +/** + * @page views_handlers About Views' handlers + * + * This page explains what views handlers are, how they're written, and what + * the basic conventions are. + * + * - @ref views_field_handlers + * - @ref views_sort_handlers + * - @ref views_filter_handlers + * - @ref views_argument_handlers + * - @ref views_relationship_handlers + */ + +/** + * @page views_plugins About Views' plugins + * + * This page explains what views plugins are, how they're written, and what + * the basic conventions are. + * + * - @ref views_display_plugins + * - @ref views_style_plugins + * - @ref views_row_plugins + */ + +/** + * @defgroup views_hooks Views' hooks + * @{ + * Hooks that can be implemented by other modules in order to implement the + * Views API. + */ + +/** + * Stub hook documentation + * + * This hook should be placed in MODULENAME.views.inc and it will be auto-loaded. + * This must either be in the same directory as the .module file or in a subdirectory + * named 'includes'. + */ +function hook_views_data() { + // example code here +} + +/** + * Stub hook documentation + * + * This hook should be placed in MODULENAME.views.inc and it will be auto-loaded. + * This must either be in the same directory as the .module file or in a subdirectory + * named 'includes'. + */ +function hook_views_plugins() { + // example code here +} + +/** + * Stub hook documentation + * + * This hook should be placed in MODULENAME.views_default.inc and it will be auto-loaded. + * This must either be in the same directory as the .module file or in a subdirectory + * named 'includes'. + */ +function hook_views_default_views() { + // example code here +} + +/** + * Stub hook documentation + * + * This hook should be placed in MODULENAME.views_convert.inc and it will be auto-loaded. + * This must either be in the same directory as the .module file or in a subdirectory + * named 'includes'. + */ +function hook_views_convert() { + // example code here +} + +/** + * Stub hook documentation + */ +function hook_views_query_substitutions() { + // example code here +} + +/** + * Stub hook documentation + * + * This hook should be placed in MODULENAME.views.inc and it will be auto-loaded. + * This must either be in the same directory as the .module file or in a subdirectory + * named 'includes'. + * + * @todo -- this hook is not yet implemented + */ +function hook_views_pre_view() { + // example code here +} + +/** + * Stub hook documentation + * + * This hook should be placed in MODULENAME.views.inc and it will be auto-loaded. + * This must either be in the same directory as the .module file or in a subdirectory + * named 'includes'. + * + * @todo -- this hook is not yet implemented + */ +function hook_views_post_view() { + // example code here +} + +/** + * @} + */ diff --git a/includes/field.handlers.inc b/includes/field.handlers.inc index e38f02e8f8d6f026dd48ca16f305c537db07c643..49fb338b55f2b3e7a4c7fbf710723b2de0eed45b 100644 --- a/includes/field.handlers.inc +++ b/includes/field.handlers.inc @@ -369,8 +369,8 @@ class views_handler_field_prerender_list extends views_handler_field { ); } - function render($value) { - $field = $value->{$this->field_alias}; + function render($values) { + $field = $values->{$this->field_alias}; if (!empty($this->items[$field])) { if ($this->options['type'] == 'separator') { return implode(check_plain($this->options['separator']), $this->items[$field]); diff --git a/includes/filter.handlers.inc b/includes/filter.handlers.inc index d7acb71c7e5bc1f9dfb3fe20116961f3d493e2a0..636017627480127d0cac55d64144aa2ff0ba4c46 100644 --- a/includes/filter.handlers.inc +++ b/includes/filter.handlers.inc @@ -4,11 +4,6 @@ * @file * Views' filter handlers. */ -/** - * @defgroup views_sort_handlers Views' sort handlers - * @{ - * Handlers to tell Views how to sort queries - */ /** * @defgroup views_filter_handlers Views' filter handlers @@ -1292,5 +1287,3 @@ class views_handler_filter_many_to_one extends views_handler_filter_in_operator /** * @} */ - - diff --git a/includes/plugins.inc b/includes/plugins.inc index c51cbd961d9fd204ba2953c9796a2b97d0a48c03..648b8397ad6403cc8241e368c4eecde015fee9ff 100644 --- a/includes/plugins.inc +++ b/includes/plugins.inc @@ -133,7 +133,7 @@ function views_discover_plugins() { } /** - * @defgroup views_plugin_displays Views' display plugins + * @defgroup views_display_plugins Views' display plugins * @{ * Display plugins control how Views interact with the rest of Drupal. * @@ -141,6 +141,8 @@ function views_discover_plugins() { * handle creating Views from a Drupal block hook. They can also * handle creating Views from an external module source, such as * a Panels pane, or an insert view, or a CCK field type. + * + * @see hook_views_plugins */ /** @@ -1681,7 +1683,7 @@ class views_plugin_display_block extends views_plugin_display { */ /** - * @defgroup views_plugin_styles Views' style plugins + * @defgroup views_style_plugins Views' style plugins * @{ * Style plugins control how a view is rendered. For example, they * can choose to display a collection of fields, node_view() output, @@ -1690,6 +1692,8 @@ class views_plugin_display_block extends views_plugin_display { * Many style plugins can have an optional 'row' plugin, that displays * a single record. Not all style plugins can utilize this, so it is * up to the plugin to set this up and call through to the row plugin. + * + * @see hook_views_plugins */ /** @@ -2190,12 +2194,14 @@ class views_plugin_style_summary extends views_plugin_style { */ /** - * @defgroup views_plugin_rows Views' row plugins + * @defgroup views_row_plugins Views' row plugins * @{ * * Row plugins control how Views outputs an individual record. They are * tightly coupled to style plugins, in that a style plugin is what calls * the row plugin. + * + * @see hook_views_plugins */ /** diff --git a/includes/query.inc b/includes/query.inc index b2c95329f11ca87558923520a25384f1b7adeed7..a0915c652e66c7158fd9a07d2b1eff6b9cce7c73 100644 --- a/includes/query.inc +++ b/includes/query.inc @@ -464,9 +464,9 @@ class views_query { /** * Retrieve join data from the larger join data cache. * - * @param + * @param $table * The table to get the join information for. - * @param + * @param $base_table * The path we're following to get this join. * * @return diff --git a/includes/sort.handlers.inc b/includes/sort.handlers.inc index c741b164e2843211adb3da7e555e23d7cb78d267..be46fc5a8aa41f0b35047242cc630a93760ff83b 100644 --- a/includes/sort.handlers.inc +++ b/includes/sort.handlers.inc @@ -5,6 +5,12 @@ * Views' sort handlers. */ +/** + * @defgroup views_sort_handlers Views' sort handlers + * @{ + * Handlers to tell Views how to sort queries + */ + /** * Base sort handler that has no options and performs a simple sort */ diff --git a/modules/profile.views.inc b/modules/profile.views.inc index 73c03927efeb6cc5c27c06eb54c05e4234b9c986..c9e0c6f667fa2f250a9e8451ab02927d02a971ad 100644 --- a/modules/profile.views.inc +++ b/modules/profile.views.inc @@ -6,7 +6,7 @@ */ /** - * @defgroup views_user_module user.module handlers + * @defgroup views_profile_module profile.module handlers * * @{ */ diff --git a/modules/search.views.inc b/modules/search.views.inc index daccfce24166a7a0ec6e505631601dd2e5e52d5a..c5e0d4952132d6d19ffdad92589cf2ead3e700ee 100644 --- a/modules/search.views.inc +++ b/modules/search.views.inc @@ -6,7 +6,7 @@ */ /** - * @defgroup views_node_module node.module handlers + * @defgroup views_search_module search.module handlers * * Includes the tables 'search_index' * @{ diff --git a/modules/taxonomy.views.inc b/modules/taxonomy.views.inc index 5c32b1757536d0aa2d009c5397abc7d4a64b9c29..0bd0ec97596a24572784506e9acdc5766192b2cf 100644 --- a/modules/taxonomy.views.inc +++ b/modules/taxonomy.views.inc @@ -353,10 +353,10 @@ class views_handler_field_term_node_tid extends views_handler_field_prerender_li $this->add_additional_fields(); } - function pre_render($results) { + function pre_render($values) { $this->field_alias = $this->aliases['nid']; $nids = array(); - foreach ($results as $result) { + foreach ($values as $result) { $nids[] = $result->{$this->aliases['nid']}; } diff --git a/modules/upload.views.inc b/modules/upload.views.inc index 7d6f31e0e7e0eb925fa124e9e9754e6d17b251c3..18533141931b8bb67cfd978d679e452546634a65 100644 --- a/modules/upload.views.inc +++ b/modules/upload.views.inc @@ -149,12 +149,12 @@ class views_handler_field_upload_fid extends views_handler_field_prerender_list $this->field_alias = $this->aliases['nid']; } - function pre_render($results) { + function pre_render($values) { $nids = array(); $this->items = array(); $data = array(); - foreach ($results as $result) { + foreach ($values as $result) { $nids[] = $result->{$this->aliases['nid']}; } @@ -207,7 +207,7 @@ class views_handler_field_upload_description extends views_handler_field_prerend ); } - function pre_render($results) { + function pre_render($values) { if (empty($this->options['link_to_file'])) { return; } @@ -216,7 +216,7 @@ class views_handler_field_upload_description extends views_handler_field_prerend $this->items = array(); $data = array(); - foreach ($results as $result) { + foreach ($values as $result) { $fids[] = $result->{$this->aliases['fid']}; } @@ -229,9 +229,8 @@ class views_handler_field_upload_description extends views_handler_field_prerend } } - function render($value) { - return $this->render_link($value->{$this->field_alias}, $value); - + function render($values) { + return $this->render_link($values->{$this->field_alias}, $values); } /** diff --git a/modules/user.views.inc b/modules/user.views.inc index 9d9934a663958e90783f0d31639bec491bb6eb2f..4dbc485b483da8a95ca8e8cd46ca11b42e6bfb82 100644 --- a/modules/user.views.inc +++ b/modules/user.views.inc @@ -496,11 +496,11 @@ class views_handler_field_user_roles extends views_handler_field_prerender_list $this->field_alias = $this->aliases['uid']; } - function pre_render($results) { + function pre_render($values) { $uids = array(); $this->items = array(); - foreach ($results as $result) { + foreach ($values as $result) { $uids[] = $result->{$this->aliases['uid']}; }