The plugin that handles a block.
Hierarchy
- class views_object
- class views_plugin
- class views_plugin_display
- class views_plugin
Expanded class hierarchy of views_plugin_display_block
Related topics
File
- core/
modules/ views/ plugins/ views_plugin_display_block.inc, line 12 - Contains the block display plugin.
Members
Name | Modifiers | Type | Description |
---|---|---|---|
views_plugin_display_block:: |
protected | property | Whether this display has custom settings that override the view options. |
views_object:: |
function | Views handlers use a special construct function so that we can more easily construct them with variable arguments. | |
views_plugin_display:: |
function |
Validate the options form. Overrides views_plugin:: |
|
views_object:: |
public | function | Unpacks each handler to store translatable texts. |
views_object:: |
function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
public | function | Unpack a single option definition. |
views_plugin_display_block:: |
function |
The display block handler returns the structure necessary for a block. Overrides views_plugin_display:: |
|
views_plugin_display:: |
function | Static member function to list which sections are defaultable and what items each section contains. | |
views_plugin_display:: |
public | function | Special method to unpack items that have handlers. |
views_plugin_display:: |
public | function | Special handling for plugins when extracting translatables. |
views_plugin_display:: |
function | Should the enabled display more link be shown when no more items? | |
views_plugin_display:: |
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_block:: |
function | Set the options that should be overridden within this display. | |
views_object:: |
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:: |
function | Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. | |
views_plugin_display:: |
function | Set an option and force it to be an override. | |
views_plugin_display:: |
function | Returns to tokens for arguments. | |
views_plugin:: |
function | Returns the summary of the settings in the display. | |
views_plugin:: |
function | Return the human readable name of the display. | |
views_plugin_display_block:: |
function |
Return the base path to use for this display. Overrides views_plugin_display:: |
|
views_plugin_display_block:: |
function | Return a list of blocks provided by this display plugin. | |
views_plugin_display:: |
function | Retrieve a list of fields for the current display with the relationship associated if it exists. | |
views_plugin_display:: |
function | Render this display. | |
views_plugin_display:: |
function | Render the header of the view. | |
views_plugin_display:: |
function | Render the footer of the view. | |
views_plugin_display:: |
function | Render the 'more' link | |
views_plugin_display:: |
function | Render any special blocks provided for this display. | |
views_plugin_display_block:: |
function |
Provide the summary for page options in the views UI. Overrides views_plugin_display:: |
|
views_plugin_display_block:: |
function |
Provide the default form for setting options. Overrides views_plugin_display:: |
|
views_plugin_display:: |
function | Provide the block system with any exposed widget blocks for this display. | |
views_plugin_display:: |
function | Provide some helpful text for the arguments. The result should contain of an array with | |
views_plugin_display:: |
function | Provide some helpful text for pagers. | |
views_plugin_display_block:: |
function | Provide a single method to figure caching type, keeping a sensible default for when it's unset. | |
views_plugin_display_block:: |
function | Provide a list of core's block caching modes. | |
views_plugin:: |
function | Provide a list of additional theme functions for the theme information page | |
views_plugin:: |
function | Provide a full list of possible theme templates used by this style. | |
views_plugin_display_block:: |
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_display:: |
|
views_plugin_display:: |
function | Not all display plugins will support pager rendering. | |
views_plugin_display:: |
function | Not all display plugins will support filtering | |
views_plugin_display:: |
function |
Make sure the display and all associated handlers are valid. Overrides views_plugin:: |
|
views_object:: |
function | Let the handler know what its full definition is. | |
views_plugin_display:: |
function | Intelligently set an option either from this display or from the default display, if directed to do so. | |
views_plugin_display:: |
function | Intelligently get an option either from this display or from the default display, if directed to do so. | |
views_plugin_display:: |
function |
Inject anything into the query that the display handler needs. Overrides views_plugin:: |
|
views_plugin_display_block:: |
function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides views_plugin_display:: |
|
views_plugin_display:: |
function | If this display creates a page with a menu item, implement it here. | |
views_plugin_display:: |
function | If this display creates a block, implement one of these. | |
views_plugin_display:: |
function | If override/revert was clicked, perform the proper toggle. | |
views_plugin_display:: |
function | Get the instance of a plugin, for example style or row. | |
views_plugin_display:: |
function | Get the handler object for a single handler. | |
views_plugin_display:: |
function | Get a full array of handlers for $type. This caches them. | |
views_plugin_display:: |
function | Fully render the display for the purposes of a live preview or some other AJAXy reason. | |
views_plugin_display:: |
function | Format a list of theme templates for output by the theme info helper. | |
views_plugin_display:: |
function | Flip the override setting for the given section. | |
views_plugin_display:: |
public | function | Extract translatables from views styles. |
views_plugin_display:: |
function | Does the display use AJAX? | |
views_plugin_display:: |
function | Does the display have groupby enabled? | |
views_plugin_display:: |
function | Does the display have custom link text? | |
views_plugin_display:: |
function | Does the display have a pager enabled? | |
views_plugin_display_block:: |
function |
Does the display have a more link enabled? Overrides views_plugin_display:: |
|
views_plugin_display:: |
function | Displays can require a certain type of style plugin. By default, they will be 'normal'. | |
views_plugin_display:: |
function | Determine if this display uses exposed filters, so the view will know whether or not to build them. | |
views_plugin_display_block:: |
function |
Determine if this display should display the exposed filters widgets, so
the view will know whether to render them. Overrides views_plugin_display:: |
|
views_plugin_display:: |
function | Determine if this display is the 'default' display which contains fallback settings | |
views_plugin_display:: |
function | Determine if the user has access to this display of the view. | |
views_plugin_display:: |
function | Determine if the display's style uses fields. | |
views_plugin_display:: |
function | Determine if a given option is set to use the default display or the current display | |
views_plugin_display:: |
function | Check to see which display to use when creating links within a view using this display. | |
views_plugin_display:: |
function | Check to see if the display needs a breadcrumb | |
views_plugin_display:: |
function | Check to see if the display has some need to link to another display. | |
views_plugin_display:: |
function | Check to see if the display has a 'path' field. | |
views_plugin_display_block:: |
function |
Check to see if the display can put the exposed form in a block. Overrides views_plugin_display:: |
|
views_plugin_display:: |
function | Check if the provided identifier is unique. | |
views_plugin_display:: |
function | Can this display accept attachments? | |
views_plugin_display:: |
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:: |
function | Allow displays to attach to other views. | |
views_plugin_display_block:: |
function | Adjust the array of argument input to match the current list of arguments available for this display. This ensures that changing the arguments doesn't cause the argument input field to just break. | |
views_plugin_display_block:: |
function | Accessor to check if any override options have been set. | |
views_plugin_display_block:: |
function |
Overrides views_plugin_display:: |
|
views_plugin_display:: |
function | ||
views_plugin_display:: |
function |
Overrides views_object:: |
|
views_plugin_display:: |
function | ||
views_plugin_display:: |
function | ||
views_object:: |
function |