class views_plugin_display_default
Same name in other branches
- 7.x-3.x plugins/views_plugin_display_default.inc \views_plugin_display_default
A plugin to handle defaults on a view.
Hierarchy
- class \views_object
- class \views_plugin extends \views_object
- class \views_plugin_display extends \views_plugin
- class \views_plugin_display_default extends \views_plugin_display
- class \views_plugin_display extends \views_plugin
- class \views_plugin extends \views_object
Expanded class hierarchy of views_plugin_display_default
Related topics
1 string reference to 'views_plugin_display_default'
- views_views_plugins in includes/
plugins.inc - Implementation of hook_views_plugins
File
-
plugins/
views_plugin_display_default.inc, line 12
View source
class views_plugin_display_default extends views_plugin_display {
/**
* Determine if this display is the 'default' display which contains
* fallback settings
*/
function is_default_display() {
return TRUE;
}
/**
* The default execute handler fully renders the view.
*
* For the simplest use:
* @code
* $output = $view->execute_display('default', $args);
* @endcode
*
* For more complex usages, a view can be partially built:
* @code
* $view->set_arguments($args);
* $view->build('default'); // Build the query
* $view->execute(); // Run the query
* $output = $view->render(); // Render the view
* @endcode
*
* If short circuited at any point, look in $view->build_info for
* information about the query. After execute, look in $view->result
* for the array of objects returned from db_query.
*
* You can also do:
* @code
* $view->set_arguments($args);
* $output = $view->render('default'); // Render the view
* @endcode
*
* This illustrates that render is smart enough to call build and execute
* if these items have not already been accomplished.
*
* Note that execute also must accomplish other tasks, such
* as setting page titles, breadcrumbs, and generating exposed filter
* data if necessary.
*/
function execute() {
return $this->view
->render($this->display->id);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
views_object::$definition | property | Handler's definition | |||
views_object::$options | property | Except for displays, options for the object will be held here. | 1 | ||
views_object::export_options | function | ||||
views_object::options | function | Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. |
1 | ||
views_object::set_default_options | function | Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point. |
|||
views_object::set_definition | function | Let the handler know what its full definition is. | |||
views_object::unpack_options | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. |
|||
views_object::unpack_translatable | function | Unpack a single option definition. | |||
views_object::unpack_translatables | function | Unpacks each handler to store translatable texts. | |||
views_object::_set_option_defaults | function | ||||
views_plugin::$display | property | The current used views display. | |||
views_plugin::$plugin_type | property | The plugin type of this plugin, for example style or query. | |||
views_plugin::additional_theme_functions | function | Provide a list of additional theme functions for the theme information page | |||
views_plugin::theme_functions | function | Provide a full list of possible theme templates used by this style. | |||
views_plugin_display::$extender | property | Stores all availible display extenders. | |||
views_plugin_display::$handlers | property | ||||
views_plugin_display::$view | property | The top object of a view. | Overrides views_plugin::$view | ||
views_plugin_display::accept_attachments | function | Can this display accept attachments? | |||
views_plugin_display::access | function | Determine if the user has access to this display of the view. | |||
views_plugin_display::add_override_button | function | Add an override button for a given section, allowing the user to change whether this info is stored on the default display or on the current display. |
|||
views_plugin_display::attach_to | function | Allow displays to attach to other views. | 2 | ||
views_plugin_display::construct | function | Views handlers use a special construct function so that we can more easily construct them with variable arguments. |
Overrides views_object::construct | ||
views_plugin_display::defaultable_sections | function | Static member function to list which sections are defaultable and what items each section contains. |
1 | ||
views_plugin_display::destroy | function | Overrides views_object::destroy | |||
views_plugin_display::displays_exposed | function | Determine if this display should display the exposed filters widgets, so the view will know whether or not to render them. |
1 | ||
views_plugin_display::export_handler | function | Special method to export items that have handlers. | |||
views_plugin_display::export_option | function | Override of export_option() | Overrides views_object::export_option | ||
views_plugin_display::export_plugin | function | Special handling for plugin export | |||
views_plugin_display::export_style | function | Special handling for the style export. | |||
views_plugin_display::format_themes | function | Format a list of theme templates for output by the theme info helper. | |||
views_plugin_display::get_arguments_tokens | function | Returns to tokens for arguments. | |||
views_plugin_display::get_field_labels | function | Retrieve a list of fields for the current display with the relationship associated if it exists. |
|||
views_plugin_display::get_handler | function | Get the handler object for a single handler. | |||
views_plugin_display::get_handlers | function | Get a full array of handlers for $type. This caches them. | |||
views_plugin_display::get_link_display | function | Check to see which display to use when creating links within a view using this display. |
|||
views_plugin_display::get_option | function | Intelligently get an option either from this display or from the default display, if directed to do so. |
|||
views_plugin_display::get_path | function | Return the base path to use for this display. | |||
views_plugin_display::get_plugin | function | Get the instance of a plugin, for example style or row. | |||
views_plugin_display::get_special_blocks | function | Provide the block system with any exposed widget blocks for this display. | |||
views_plugin_display::get_style_type | function | Displays can require a certain type of style plugin. By default, they will be 'normal'. |
1 | ||
views_plugin_display::has_path | function | Check to see if the display has a 'path' field. | 1 | ||
views_plugin_display::hook_block | function | If this display creates a block, implement one of these. | |||
views_plugin_display::hook_menu | function | If this display creates a page with a menu item, implement it here. | |||
views_plugin_display::init | function | ||||
views_plugin_display::is_defaulted | function | Determine if a given option is set to use the default display or the current display |
|||
views_plugin_display::is_identifier_unique | function | Check if the provided identifier is unique. | |||
views_plugin_display::options_form | function | Provide the default form for setting options. | Overrides views_plugin::options_form | 3 | |
views_plugin_display::options_override | function | If override/revert was clicked, perform the proper toggle. | |||
views_plugin_display::options_submit | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. |
Overrides views_plugin::options_submit | 3 | |
views_plugin_display::options_summary | function | Provide the default summary for options in the views UI. | 3 | ||
views_plugin_display::options_validate | function | Validate the options form. | Overrides views_plugin::options_validate | 1 | |
views_plugin_display::option_definition | function | Information about options for all kinds of purposes will be held here. | Overrides views_object::option_definition | 3 | |
views_plugin_display::option_link | function | Because forms may be split up into sections, this provides an easy URL to exactly the right section. Don't override this. |
|||
views_plugin_display::override_option | function | Set an option and force it to be an override. | |||
views_plugin_display::preview | function | Fully render the display for the purposes of a live preview or some other AJAXy reason. |
1 | ||
views_plugin_display::pre_execute | function | Set up any variables on the view prior to execution. These are separated from execute because they are extremely common and unlikely to be overridden on an individual display. |
|||
views_plugin_display::query | function | Inject anything into the query that the display handler needs. | Overrides views_plugin::query | ||
views_plugin_display::render | function | Render this display. | 1 | ||
views_plugin_display::render_area | function | ||||
views_plugin_display::render_empty | function | ||||
views_plugin_display::render_filters | function | Not all display plugins will support filtering | |||
views_plugin_display::render_footer | function | ||||
views_plugin_display::render_header | function | Legacy functions. | |||
views_plugin_display::render_more_link | function | Render the 'more' link | |||
views_plugin_display::render_pager | function | Not all display plugins will suppert pager rendering. | 1 | ||
views_plugin_display::set_option | function | Intelligently set an option either from this display or from the default display, if directed to do so. |
|||
views_plugin_display::set_override | function | Flip the override setting for the given section. | |||
views_plugin_display::unpack_handler | function | Special method to unpack items that have handlers. | |||
views_plugin_display::unpack_plugin | function | Special handling for plugin unpacking. | |||
views_plugin_display::unpack_style | function | ||||
views_plugin_display::uses_breadcrumb | function | Check to see if the display needs a breadcrumb | 1 | ||
views_plugin_display::uses_exposed | function | Determine if this display uses exposed filters, so the view will know whether or not to build them. |
2 | ||
views_plugin_display::uses_exposed_form_in_block | function | Check to see if the display can put the exposed formin a block. | |||
views_plugin_display::uses_fields | function | Determine if the display's style uses fields. | |||
views_plugin_display::uses_link_display | function | Check to see if the display has some need to link to another display. | 1 | ||
views_plugin_display::use_ajax | function | Does the display use AJAX? | |||
views_plugin_display::use_group_by | function | Does the display have groupby enabled? | |||
views_plugin_display::use_more | function | Does the display have a more link enabled? | |||
views_plugin_display::use_more_always | function | Should the enabled display more link be shown when no more items? | |||
views_plugin_display::use_more_text | function | Does the display have custom link text? | |||
views_plugin_display::use_pager | function | Does the display have a pager enabled? | 1 | ||
views_plugin_display::validate | function | Make sure the display and all associated handlers are valid. | Overrides views_plugin::validate | 1 | |
views_plugin_display::view_special_blocks | function | Render any special blocks provided for this display. | |||
views_plugin_display_default::execute | function | The default execute handler fully renders the view. | Overrides views_plugin_display::execute | ||
views_plugin_display_default::is_default_display | function | Determine if this display is the 'default' display which contains fallback settings |
Overrides views_plugin_display::is_default_display |