PHPXRef 0.7 : Drupal 6 (gatewave) : Detail view of views_plugin

Class: views_plugin_display - X-Ref

The default display plugin handler. Display plugins handle options and
basic mechanisms for different output methods.

init(&$view, &$display, $options = NULL) X-Ref

No description

destroy() X-Ref

No description

is_default_display() X-Ref

Determine if this display is the 'default' display which contains
fallback settings

uses_exposed() X-Ref

Determine if this display uses exposed filters, so the view
will know whether or not to build them.

displays_exposed() X-Ref

Determine if this display should display the exposed
filters widgets, so the view will know whether or not
to render them.

Regardless of what this function
returns, exposed filters will not be used nor
displayed unless uses_exposed() returns TRUE.

use_ajax() X-Ref

Does the display use AJAX?

use_pager() X-Ref

Does the display have a pager enabled?

render_pager() X-Ref

Does the display render the pager if it has it enabled?

use_more() X-Ref

Does the display have a more link enabled?

use_more_always() X-Ref

Should the enabled display more link be shown when no more items?

use_more_text() X-Ref

Does the display have custom link text?

accept_attachments() X-Ref

Can this display accept attachments?

attach_to($display_id) X-Ref

Allow displays to attach to other views.

defaultable_sections($section = NULL) X-Ref

Static member function to list which sections are defaultable
and what items each section contains.

_set_option_defaults(&$storage, $options, $level = 0) X-Ref

Set default options.

Displays put their options in a different place than everything else; also
displays spread their options out. We don't want to set defaults for
items that are normally defaulted elsewhere.

option_definition() X-Ref

No description

has_path() X-Ref

Check to see if the display has a 'path' field.

This is a pure function and not just a setting on the definition
because some displays (such as a panel pane) may have a path based
upon configuration.

By default, displays do not have a path.

uses_link_display() X-Ref

Check to see if the display has some need to link to another display.

For the most part, displays without a path will use a link display. However,
sometimes displays that have a path might also need to link to another display.
This is true for feeds.

get_link_display() X-Ref

Check to see which display to use when creating links within
a view using this display.

get_path() X-Ref

Return the base path to use for this display.

This can be overridden for displays that do strange things
with the path.

uses_breadcrumb() X-Ref

Check to see if the display needs a breadcrumb

By default, displays do not need breadcrumbs

is_defaulted($option) X-Ref

Determine if a given option is set to use the default display or the
current display

return:

get_option($option) X-Ref

Intelligently get an option either from this display or from the
default display, if directed to do so.

uses_fields() X-Ref

Determine if the display's style uses fields.

get_plugin($type = 'style', $name = NULL) X-Ref

Get the display or row plugin, if it exists.

get_access_plugin($name = NULL) X-Ref

Get the access plugin

get_cache_plugin($name = NULL) X-Ref

Get the cache plugin

get_handler($type, $id) X-Ref

Get the handler object for a single handler.

get_handlers($type) X-Ref

Get a full array of handlers for $type. This caches them.

get_field_labels() X-Ref

Retrieve a list of fields for the current display with the
relationship associated if it exists.

set_option($option, $value) X-Ref

Intelligently set an option either from this display or from the
default display, if directed to do so.

override_option($option, $value) X-Ref

Set an option and force it to be an override.

option_link($text, $section, $class = '', $title = '') X-Ref

Because forms may be split up into sections, this provides
an easy URL to exactly the right section. Don't override this.

options_summary(&$categories, &$options) X-Ref

Provide the default summary for options in the views UI.

This output is returned as an array.

options_form(&$form, &$form_state) X-Ref

Provide the default form for setting options.

format_themes($themes) X-Ref

Format a list of theme templates for output by the theme info helper.

options_validate(&$form, &$form_state) X-Ref

Validate the options form.

options_submit(&$form, &$form_state) X-Ref

Perform any necessary changes to the form values prior to storage.
There is no need for this function to actually store the data.

add_override_button(&$form, &$form_state, $section) X-Ref

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.

options_override($form, &$form_state) X-Ref

If override/revert was clicked, perform the proper toggle.

set_override($section, $new_state = NULL) X-Ref

Flip the override setting for the given section.

query() X-Ref

Inject anything into the query that the display handler needs.

render_filters() X-Ref

Not all display plugins will support filtering

render_more_link() X-Ref

Render the 'more' link

render_textarea($area) X-Ref

Render a text area, using the proper format.

render_header() X-Ref

Render the header of the view.

render_footer() X-Ref

Render the footer of the view.

render_empty() X-Ref

Render the empty text of the view.

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

If this display creates a block, implement one of these.

hook_menu() X-Ref

If this display creates a page with a menu item, implement it here.

render() X-Ref

Render this display.

access($account = NULL) X-Ref

Determine if the user has access to this display of the view.

pre_execute() X-Ref

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.

execute() X-Ref

When used externally, this is how a view gets run and returns
data in the format required.

The base class cannot be executed.

preview() X-Ref

Fully render the display for the purposes of a live preview or
some other AJAXy reason.

get_style_type() X-Ref

Displays can require a certain type of style plugin. By default, they will
be 'normal'.

validate() X-Ref

Make sure the display and all associated handlers are valid.

return:

is_identifier_unique($id, $identifier) X-Ref

Check if the provided identifier is unique.

get_special_blocks() X-Ref

Provide the block system with any exposed widget blocks for this display.

view_special_blocks($type) X-Ref

Render any special blocks provided for this display.

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

PHP Cross Reference of Drupal 6 (gatewave)

/sites/all/modules/views/plugins/ -> views_plugin_display.inc (summary)

Defines 1 class