Drupal 8  8.0.2
DisplayPluginBase Class Reference
Inheritance diagram for DisplayPluginBase:

Public Member Functions

 __construct (array $configuration, $plugin_id, $plugin_definition)
 
 destroy ()
 
 isDefaultDisplay ()
 
 usesExposed ()
 
 displaysExposed ()
 
 usesAJAX ()
 
 ajaxEnabled ()
 
 isEnabled ()
 
 usesPager ()
 
 isPagerEnabled ()
 
 usesMore ()
 
 isMoreEnabled ()
 
 useGroupBy ()
 
 useMoreAlways ()
 
 useMoreText ()
 
 acceptAttachments ()
 
 usesAttachments ()
 
 usesAreas ()
 
 attachTo (ViewExecutable $view, $display_id, array &$build)
 
 defaultableSections ($section=NULL)
 
 hasPath ()
 
 usesLinkDisplay ()
 
 usesExposedFormInBlock ()
 
 getAttachedDisplays ()
 
 getLinkDisplay ()
 
 getPath ()
 
 getRoutedDisplay ()
 
 getUrl ()
 
 isDefaulted ($option)
 
 getOption ($option)
 
 usesFields ()
 
 getPlugin ($type)
 
getHandler ($type, $id)
 
getHandlers ($type)
 
 calculateDependencies ()
 
 getFieldLabels ($groupable_only=FALSE)
 
 setOption ($option, $value)
 
 overrideOption ($option, $value)
 
 optionLink ($text, $section, $class= '', $title= '')
 
 getArgumentsTokens ()
 
 optionsSummary (&$categories, &$options)
 
 buildOptionsForm (&$form, FormStateInterface $form_state)
 
 validateOptionsForm (&$form, FormStateInterface $form_state)
 
 optionsOverride ($form, FormStateInterface $form_state)
 
 setOverride ($section, $new_state=NULL)
 
 query ()
 
 renderFilters ()
 
 renderPager ()
 
 renderMoreLink ()
 
 render ()
 
 elementPreRender (array $element)
 
 renderArea ($area, $empty=FALSE)
 
 preExecute ()
 
 getCacheMetadata ()
 
 execute ()
 
 buildRenderable (array $args=[], $cache=TRUE)
 
 preview ()
 
 getType ()
 
 validate ()
 
 newDisplay ()
 
 isIdentifierUnique ($id, $identifier)
 
 outputIsEmpty ()
 
 getSpecialBlocks ()
 
 viewExposedFormBlocks ()
 
 getArgumentText ()
 
 getPagerText ()
 
 mergeDefaults ()
 
 remove ()
 
 getExtenders ()
 
- Public Member Functions inherited from PluginBase
 __construct (array $configuration, $plugin_id, $plugin_definition)
 
 init (ViewExecutable $view, DisplayPluginBase $display, array &$options=NULL)
 
 filterByDefinedOptions (array &$storage)
 
 unpackOptions (&$storage, $options, $definition=NULL, $all=TRUE, $check=TRUE)
 
 destroy ()
 
 buildOptionsForm (&$form, FormStateInterface $form_state)
 
 validateOptionsForm (&$form, FormStateInterface $form_state)
 
 submitOptionsForm (&$form, FormStateInterface $form_state)
 
 query ()
 
 themeFunctions ()
 
 validate ()
 
 summaryTitle ()
 
 pluginTitle ()
 
 usesOptions ()
 
 globalTokenReplace ($string= '', array $options=array())
 
 getAvailableGlobalTokens ($prepared=FALSE, array $types=array())
 
 globalTokenForm (&$form, FormStateInterface $form_state)
 
 calculateDependencies ()
 
 getProvider ()
 
- Public Member Functions inherited from PluginInspectionInterface
 getPluginId ()
 
 getPluginDefinition ()
 
- Public Member Functions inherited from DerivativeInspectionInterface
 getBaseId ()
 
 getDerivativeId ()
 
- Public Member Functions inherited from DisplayPluginInterface
 initDisplay (ViewExecutable $view, array &$display, array &$options=NULL)
 
 submitOptionsForm (&$form, FormStateInterface $form_state)
 
 access (AccountInterface $account=NULL)
 
 calculateCacheMetadata ()
 

Static Public Member Functions

static buildBasicRenderable ($view_id, $display_id, array $args=[])
 
- Static Public Member Functions inherited from PluginBase
static create (ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition)
 
static preRenderAddFieldsetMarkup (array $form)
 
static preRenderFlattenData ($form)
 
static queryLanguageSubstitutions ()
 

Data Fields

 $view = NULL
 
 $handlers = []
 
 $output = NULL
 
 $display
 
- Data Fields inherited from PluginBase
const INCLUDE_NEGOTIATED = 16
 
const INCLUDE_ENTITY = 32
 
const VIEWS_QUERY_LANGUAGE_SITE_DEFAULT = '***LANGUAGE_site_default***'
 
 $options = array()
 
 $view = NULL
 
 $displayHandler
 
 $definition
 

Protected Member Functions

 defineOptions ()
 
 getAllHandlers ($only_overrides=FALSE)
 
 getAllPlugins ($only_overrides=FALSE)
 
 mergePlugin ($type)
 
 mergeHandler ($type)
 
 buildRenderingLanguageOptions ()
 
 isBaseTableTranslatable ()
 
- Protected Member Functions inherited from PluginBase
 defineOptions ()
 
 setOptionDefaults (array &$storage, array $options)
 
 doFilterByDefinedOptions (array &$storage, array $options)
 
 viewsTokenReplace ($text, $tokens)
 
 listLanguages ($flags=LanguageInterface::STATE_ALL, array $current_values=NULL)
 
 getRenderer ()
 

Protected Attributes

 $plugins = array()
 
 $extenders = []
 
 $usesOptions = TRUE
 
 $usesAJAX = TRUE
 
 $usesPager = TRUE
 
 $usesMore = TRUE
 
 $usesAttachments = FALSE
 
 $usesAreas = TRUE
 
- Protected Attributes inherited from PluginBase
 $usesOptions = FALSE
 
 $renderer
 

Static Protected Attributes

static $unpackOptions = array()
 

Detailed Description

Base class for views display plugins.

Constructor & Destructor Documentation

__construct ( array  $configuration,
  $plugin_id,
  $plugin_definition 
)

Constructs a new DisplayPluginBase object.

Because DisplayPluginBase::initDisplay() takes the display configuration by reference and handles it differently than usual plugin configuration, pass an empty array of configuration to the parent. This prevents our configuration from being duplicated.

Todo:
Replace DisplayPluginBase::$display with DisplayPluginBase::$configuration to standardize with other plugins.
Parameters
array$configurationA configuration array containing information about the plugin instance.
string$plugin_idThe plugin_id for the plugin instance.
mixed$plugin_definitionThe plugin implementation definition.

Member Function Documentation

acceptAttachments ( )

{Determines whether this display can use attachments.

Returns
bool
}

Implements DisplayPluginInterface.

References DisplayPluginBase\usesAttachments().

Here is the call graph for this function:

ajaxEnabled ( )

{Whether the display is actually using AJAX or not.

Returns
bool
}

Implements DisplayPluginInterface.

References DisplayPluginBase\getOption(), and DisplayPluginBase\usesAJAX().

Referenced by DisplayPluginBase\preExecute(), and Block\usesExposed().

Here is the call graph for this function:

Here is the caller graph for this function:

attachTo ( ViewExecutable  $view,
  $display_id,
array &  $build 
)

{Allows displays to attach to other views.

Parameters
\Drupal\views\ViewExecutable$viewThe views executable.
string$display_idThe display to attach to.
array$buildThe parent view render array.
}

Implements DisplayPluginInterface.

static buildBasicRenderable (   $view_id,
  $display_id,
array  $args = [] 
)
static

{Builds a basic render array which can be properly render cached.In order to be rendered cached, it includes cache keys as well as the data required to load the view on cache misses.

Parameters
string$view_idThe view ID.
string$display_idThe display ID.
array$args(optional) The view arguments.
Returns
array The view render array.
}

Implements DisplayPluginInterface.

buildOptionsForm ( $form,
FormStateInterface  $form_state 
)
buildRenderable ( array  $args = [],
  $cache = TRUE 
)

{Builds a renderable array of the view.Note: This does not yet contain the executed view, but just the loaded view executable.

Parameters
array$args(optional) Arguments of the view.
bool$cache(optional) Specify FALSE in order to opt out of render caching.
Returns
array The render array of a view.
}

Implements DisplayPluginInterface.

buildRenderingLanguageOptions ( )
protected

Returns the available rendering strategies for language-aware entities.

Returns
array An array of available entity row renderers keyed by renderer identifiers.

References DisplayPluginBase\getOption(), PluginBase\INCLUDE_ENTITY, PluginBase\INCLUDE_NEGOTIATED, PluginBase\listLanguages(), LanguageInterface\STATE_CONFIGURABLE, and LanguageInterface\STATE_SITE_DEFAULT.

Referenced by DisplayPluginBase\buildOptionsForm(), and DisplayPluginBase\optionsSummary().

Here is the call graph for this function:

Here is the caller graph for this function:

calculateDependencies ( )

{Calculates dependencies for the configured plugin.Dependencies are saved in the plugin's configuration entity and are used to determine configuration synchronization order. For example, if the plugin integrates with specific user roles, this method should return an array of dependencies listing the specified roles.

Returns
array An array of dependencies grouped by type (config, content, module, theme). For example:
array(
'config' => array('user.role.anonymous', 'user.role.authenticated'),
'content' => array('node:article:f0a189e6-55fb-47fb-8005-5bef81c44d6d'),
'module' => array('node', 'user'),
'theme' => array('seven'),
);
See Also
::getConfigDependencyName()
}

Implements DependentPluginInterface.

References DisplayPluginBase\getAllHandlers(), and DisplayPluginBase\getAllPlugins().

Here is the call graph for this function:

defaultableSections (   $section = NULL)

{Lists the 'defaultable' sections and what items each section contains.}

Implements DisplayPluginInterface.

References DisplayPluginBase\usesPager().

Referenced by DisplayPluginBase\buildOptionsForm(), and DisplayPluginBase\setOverride().

Here is the call graph for this function:

Here is the caller graph for this function:

destroy ( )

{Destroys the display's components and the display itself.}

Implements DisplayPluginInterface.

displaysExposed ( )

{Determines if this display should display the exposed filters widgets.Regardless of what this function returns, exposed filters will not be used nor displayed unless usesExposed() returns TRUE.}

Implements DisplayPluginInterface.

elementPreRender ( array  $element)

{#pre_render callback for view display rendering.

See Also
self::render()
Parameters
array$elementThe element to #pre_render
Returns
array The processed element.
}

Implements DisplayPluginInterface.

References ViewsForm\create(), Drupal\formBuilder(), Drupal\getContainer(), ViewExecutable\hasFormElements(), ViewExecutable\id(), and ViewExecutable\renderPager().

Here is the call graph for this function:

execute ( )

{Executes the view and returns data in the format required.The base class cannot be executed.}

Implements DisplayPluginInterface.

getAllHandlers (   $only_overrides = FALSE)
protected

Gets all the handlers used by the display.

Parameters
bool$only_overridesWhether to include only overridden handlers.
Returns
[]

References DisplayPluginBase\getHandlers(), Views\getHandlerTypes(), and DisplayPluginBase\isDefaulted().

Referenced by DisplayPluginBase\calculateDependencies().

Here is the call graph for this function:

Here is the caller graph for this function:

getAllPlugins (   $only_overrides = FALSE)
protected

Gets all the plugins used by the display.

Parameters
bool$only_overridesWhether to include only overridden plugins.
Returns
[]

References DisplayPluginBase\getPlugin(), Views\getPluginTypes(), and DisplayPluginBase\isDefaulted().

Referenced by DisplayPluginBase\calculateDependencies().

Here is the call graph for this function:

Here is the caller graph for this function:

getArgumentsTokens ( )

{Returns to tokens for arguments.This function is similar to views_handler_field::getRenderTokens() but without fields tokens.}

Implements DisplayPluginInterface.

References Html\decodeEntities().

Referenced by DisplayPluginBase\renderMoreLink().

Here is the call graph for this function:

Here is the caller graph for this function:

getArgumentText ( )

{Provides help text for the arguments.

Returns
array Returns an array which contains text for the argument fieldset:
  • filter value present: The title of the fieldset in the argument where you can configure what should be done with a given argument.
  • filter value not present: The title of the fieldset in the argument where you can configure what should be done if the argument does not exist.
  • description: A description about how arguments are passed to the display. For example blocks can't get arguments from url.
}

Implements DisplayPluginInterface.

References t().

Here is the call graph for this function:

getAttachedDisplays ( )

{Find out all displays which are attached to this display.The method is just using the pure storage object to avoid loading of the sub displays which would kill lazy loading.}

Implements DisplayPluginInterface.

getCacheMetadata ( )

{Gets the cache metadata.

Returns
The cache metadata.
}

Implements DisplayPluginInterface.

References DisplayPluginInterface\calculateCacheMetadata().

Here is the call graph for this function:

getExtenders ( )

{Gets the display extenders.

Returns
[]
}

Implements DisplayPluginInterface.

getFieldLabels (   $groupable_only = FALSE)

{Retrieves a list of fields for the current display.This also takes into account any associated relationships, if they exist.

Parameters
bool$groupable_only(optional) TRUE to only return an array of field labels from handlers that support the useStringGroupBy method, defaults to FALSE.
Returns
array An array of applicable field options, keyed by ID.
}

Implements DisplayPluginInterface.

References DisplayPluginBase\getHandlers().

Here is the call graph for this function:

& getHandler (   $type,
  $id 
)

{Get the handler object for a single handler.}

Implements DisplayPluginInterface.

References DisplayPluginBase\getHandlers().

Referenced by DisplayPluginBase\getHandlers().

Here is the call graph for this function:

Here is the caller graph for this function:

& getHandlers (   $type)

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

Returns
[]
}

Implements DisplayPluginInterface.

References DisplayPluginBase\getHandler(), ViewExecutable\getHandlerTypes(), DisplayPluginBase\getOption(), Views\handlerManager(), and DisplayPluginBase\useGroupBy().

Referenced by DisplayPluginBase\getAllHandlers(), DisplayPluginBase\getFieldLabels(), DisplayPluginBase\getHandler(), DisplayPluginBase\isIdentifierUnique(), DisplayPluginBase\mergeHandler(), DisplayPluginBase\outputIsEmpty(), DisplayPluginBase\renderArea(), and DisplayPluginBase\validate().

Here is the call graph for this function:

Here is the caller graph for this function:

getLinkDisplay ( )

{Returns the ID of the display to use when making links.}

Implements DisplayPluginInterface.

References DisplayPluginBase\getOption().

Referenced by DisplayPluginBase\getPath(), DisplayPluginBase\getRoutedDisplay(), and DisplayPluginBase\optionsSummary().

Here is the call graph for this function:

Here is the caller graph for this function:

getOption (   $option)

{Gets an option, from this display or the default display.}

Implements DisplayPluginInterface.

References DisplayPluginBase\isDefaulted().

Referenced by DisplayPluginBase\ajaxEnabled(), Attachment\attachTo(), Feed\attachTo(), Block\blockForm(), DisplayTest\buildOptionsForm(), Attachment\buildOptionsForm(), Block\buildOptionsForm(), Feed\buildOptionsForm(), Page\buildOptionsForm(), PathPluginBase\buildOptionsForm(), DisplayPluginBase\buildOptionsForm(), DisplayPluginBase\buildRenderingLanguageOptions(), Page\calculateDependencies(), PathPluginBase\collectRoutes(), Block\execute(), DisplayPluginBase\getHandlers(), DisplayPluginBase\getLinkDisplay(), PathPluginBase\getMenuLinks(), PathPluginBase\getPath(), DisplayPluginBase\getPath(), DisplayPluginBase\getPlugin(), PathPluginBase\getRoute(), StylePluginBase\init(), PathPluginBase\isDefaultTabPath(), DisplayPluginBase\isEnabled(), DisplayPluginBase\isMoreEnabled(), DisplayPluginBase\mergeHandler(), DisplayPluginBase\mergePlugin(), Feed\newDisplay(), DisplayTest\optionsSummary(), Attachment\optionsSummary(), Block\optionsSummary(), Feed\optionsSummary(), Page\optionsSummary(), PathPluginBase\optionsSummary(), DisplayPluginBase\optionsSummary(), EntityReference\query(), DisplayPluginBase\renderMoreLink(), Attachment\renderPager(), WizardPluginBase\setDefaultOptions(), DisplayPluginBase\setOverride(), WizardPluginBase\setOverrideOptions(), DisplayPluginBase\useGroupBy(), DisplayPluginBase\useMoreAlways(), DisplayPluginBase\useMoreText(), EntityReference\validate(), PathPluginBase\validate(), Page\validate(), DisplayPluginBase\validate(), Page\validateOptionsForm(), and DisplayPluginBase\viewExposedFormBlocks().

Here is the call graph for this function:

getPagerText ( )

{Provides help text for pagers.

Returns
array Returns an array which contains text for the items_per_page form element:
  • items per page title: The title text for the items_per_page form element.
  • items per page description: The description text for the items_per_page form element.
}

Implements DisplayPluginInterface.

References t().

Here is the call graph for this function:

getPath ( )

{Returns the base path to use for this display.This can be overridden for displays that do strange things with the path.}

Implements DisplayPluginInterface.

References DisplayPluginBase\getLinkDisplay(), DisplayPluginBase\getOption(), and DisplayPluginBase\hasPath().

Here is the call graph for this function:

getPlugin (   $type)

{Get the instance of a plugin, for example style or row.

Parameters
string$typeThe type of the plugin.
Returns
}

Implements DisplayPluginInterface.

References DisplayPluginBase\getOption(), Views\pluginManager(), and Views\viewsData().

Referenced by Block\blockForm(), DisplayPluginBase\buildOptionsForm(), RestExport\collectRoutes(), DisplayPluginBase\getAllPlugins(), PathPluginBase\getRoute(), StylePluginBase\init(), DisplayPluginBase\isPagerEnabled(), DisplayPluginBase\mergePlugin(), DisplayPluginBase\optionsSummary(), DisplayPluginBase\preExecute(), DisplayPluginBase\usesExposed(), DisplayPluginBase\usesFields(), DisplayPluginBase\validate(), DisplayPluginBase\validateOptionsForm(), and DisplayPluginBase\viewExposedFormBlocks().

Here is the call graph for this function:

Here is the caller graph for this function:

getRoutedDisplay ( )

{Points to the display which can be linked by this display.If the display has route information, the display itself is returned. Otherwise, the configured linked display is returned. For example, if a block display links to a page display, the page display will be returned in both cases.

Returns
|NULL
}

Implements DisplayPluginInterface.

References DisplayPluginBase\getLinkDisplay().

Referenced by DisplayPluginBase\validate().

Here is the call graph for this function:

Here is the caller graph for this function:

getSpecialBlocks ( )

{Provides the block system with any exposed widget blocks for this display.}

Implements DisplayPluginInterface.

References t(), and DisplayPluginBase\usesExposedFormInBlock().

Here is the call graph for this function:

getType ( )

{Returns the display type that this display requires.This can be used for filtering views plugins. E.g. if a plugin category of 'foo' is specified, only plugins with no 'types' declared or 'types' containing 'foo'. If you have a type of bar, this plugin will not be used. This is applicable for style, row, access, cache, and exposed_form plugins.

Returns
string The required display type. Defaults to 'normal'.
See Also
::fetchPluginNames()
}

Implements DisplayPluginInterface.

Referenced by DisplayPluginBase\buildOptionsForm().

Here is the caller graph for this function:

getUrl ( )

{Returns a URL to $this display or its configured linked display.

Returns
|null
}

Implements DisplayPluginInterface.

hasPath ( )

{Checks 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.}

Implements DisplayPluginInterface.

Referenced by DisplayPluginBase\getPath(), DisplayPluginBase\usesExposedFormInBlock(), DisplayPluginBase\usesLinkDisplay(), and DisplayPluginBase\validate().

Here is the caller graph for this function:

isBaseTableTranslatable ( )
protected

Returns whether the base table is of a translatable entity type.

Returns
bool TRUE if the base table is of a translatable entity type, FALSE otherwise.

References Views\viewsData().

Referenced by DisplayPluginBase\buildOptionsForm(), and DisplayPluginBase\optionsSummary().

Here is the call graph for this function:

Here is the caller graph for this function:

isDefaultDisplay ( )

{Determines if this display is the 'default' display.'Default' display contains fallback settings.}

Implements DisplayPluginInterface.

Referenced by DisplayPluginBase\isDefaulted().

Here is the caller graph for this function:

isDefaulted (   $option)

{Determines if an option is set to use the default or current display.

Returns
TRUE for the default display.
}

Implements DisplayPluginInterface.

References DisplayPluginBase\isDefaultDisplay().

Referenced by DisplayPluginBase\getAllHandlers(), DisplayPluginBase\getAllPlugins(), DisplayPluginBase\getOption(), and DisplayPluginBase\setOption().

Here is the call graph for this function:

Here is the caller graph for this function:

isEnabled ( )

{Whether the display is enabled.

Returns
bool Returns TRUE if the display is marked as enabled, else FALSE.
}

Implements DisplayPluginInterface.

References DisplayPluginBase\getOption().

Here is the call graph for this function:

isIdentifierUnique (   $id,
  $identifier 
)

{Checks if the provided identifier is unique.

Parameters
string$idThe id of the handler which is checked.
string$identifierThe actual get identifier configured in the exposed settings.
Returns
bool Returns whether the identifier is unique on all handlers.
}

Implements DisplayPluginInterface.

References DisplayPluginBase\getHandlers(), and ViewExecutable\getHandlerTypes().

Here is the call graph for this function:

isMoreEnabled ( )

{Whether the display is using the 'more' link or not.

Returns
bool
}

Implements DisplayPluginInterface.

References DisplayPluginBase\getOption(), and DisplayPluginBase\usesMore().

Referenced by DisplayPluginBase\preExecute(), DisplayPluginBase\renderMoreLink(), and DisplayPluginBase\validate().

Here is the call graph for this function:

Here is the caller graph for this function:

isPagerEnabled ( )

{Whether the display is using a pager or not.

Returns
bool
}

Implements DisplayPluginInterface.

References DisplayPluginBase\getPlugin(), and DisplayPluginBase\usesPager().

Here is the call graph for this function:

mergeDefaults ( )

{Merges default values for all plugin types.}

Implements DisplayPluginInterface.

References ViewExecutable\getHandlerTypes().

Here is the call graph for this function:

mergeHandler (   $type)
protected

Merges handlers default values.

Parameters
string$typeThe name of the handler type option.

References DisplayPluginBase\getHandlers(), ViewExecutable\getHandlerTypes(), DisplayPluginBase\getOption(), and DisplayPluginBase\setOption().

Here is the call graph for this function:

mergePlugin (   $type)
protected

Merges plugins default values.

Parameters
string$typeThe name of the plugin type option.

References DisplayPluginBase\getOption(), DisplayPluginBase\getPlugin(), and DisplayPluginBase\setOption().

Here is the call graph for this function:

newDisplay ( )

{Reacts on adding a display.

See Also
::newDisplay()
}

Implements DisplayPluginInterface.

optionLink (   $text,
  $section,
  $class = '',
  $title = '' 
)

{Returns a link to a section of a form.Because forms may be split up into sections, this provides an easy URL to exactly the right section. Don't override this.}

Implements DisplayPluginInterface.

References SafeMarkup\format(), Html\getUniqueId(), and t().

Referenced by DisplayPluginBase\buildOptionsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

optionsOverride (   $form,
FormStateInterface  $form_state 
)

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

Implements DisplayPluginInterface.

References FormStateInterface\get(), and DisplayPluginBase\setOverride().

Here is the call graph for this function:

optionsSummary ( $categories,
$options 
)
outputIsEmpty ( )

{Is the output of the view empty.If a view has no result and neither the empty, nor the footer nor the header does show anything return FALSE.

Returns
bool Returns TRUE if the output is empty, else FALSE.
}

Implements DisplayPluginInterface.

References DisplayPluginBase\getHandlers().

Referenced by Block\execute().

Here is the call graph for this function:

Here is the caller graph for this function:

overrideOption (   $option,
  $value 
)

{Set an option and force it to be an override.}

Implements DisplayPluginInterface.

References DisplayPluginBase\setOption(), and DisplayPluginBase\setOverride().

Referenced by WizardPluginBase\setOverrideOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

preExecute ( )

{Sets 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.}

Implements DisplayPluginInterface.

References DisplayPluginBase\ajaxEnabled(), DisplayPluginBase\getPlugin(), DisplayPluginBase\isMoreEnabled(), DisplayPluginBase\useMoreAlways(), and DisplayPluginBase\usesExposed().

Here is the call graph for this function:

preview ( )

{Renders the display for the purposes of a live preview.Also might be used for some other AJAXy reason.}

Implements DisplayPluginInterface.

query ( )

{Injects anything into the query that the display handler needs.}

Implements DisplayPluginInterface.

remove ( )

{Reacts on deleting a display.}

Implements DisplayPluginInterface.

render ( )

{Renders this display.}

Implements DisplayPluginInterface.

References PluginBase\themeFunctions().

Here is the call graph for this function:

renderArea (   $area,
  $empty = FALSE 
)

{Renders one of the available areas.

Parameters
string$areaIdentifier of the specific area to render.
bool$empty(optional) Indicator whether or not the view result is empty. Defaults to FALSE
Returns
array A render array for the given area.
}

Implements DisplayPluginInterface.

References DisplayPluginBase\getHandlers().

Here is the call graph for this function:

renderFilters ( )

{Does nothing (obsolete function).

Todo:
This function no longer seems to be used.
}

Implements DisplayPluginInterface.

renderMoreLink ( )

{Renders the 'more' link.}

Implements DisplayPluginInterface.

References Url\fromUserInput(), DisplayPluginBase\getArgumentsTokens(), DisplayPluginBase\getOption(), DisplayPluginBase\isMoreEnabled(), DisplayPluginBase\useMoreAlways(), DisplayPluginBase\useMoreText(), and PluginBase\viewsTokenReplace().

Here is the call graph for this function:

renderPager ( )

{Checks to see if the display plugins support pager rendering.}

Implements DisplayPluginInterface.

setOption (   $option,
  $value 
)

{Sets an option, on this display or the default display.}

Implements DisplayPluginInterface.

References DisplayPluginBase\isDefaulted().

Referenced by DisplayPluginBase\mergeHandler(), DisplayPluginBase\mergePlugin(), Feed\newDisplay(), DisplayPluginBase\overrideOption(), WizardPluginBase\setDefaultOptions(), WizardPluginBase\setOverrideOptions(), DisplayTest\submitOptionsForm(), Attachment\submitOptionsForm(), Block\submitOptionsForm(), Feed\submitOptionsForm(), PathPluginBase\submitOptionsForm(), and Page\submitOptionsForm().

Here is the call graph for this function:

Here is the caller graph for this function:

setOverride (   $section,
  $new_state = NULL 
)

{Flip the override setting for the given section.

Parameters
string$sectionWhich option should be marked as overridden, for example "filters".
bool$new_stateSelect the new state of the option:
  • TRUE: Revert new state option to default.
  • FALSE: Mark it as overridden.
}

Implements DisplayPluginInterface.

References DisplayPluginBase\defaultableSections(), and DisplayPluginBase\getOption().

Referenced by DisplayPluginBase\optionsOverride(), and DisplayPluginBase\overrideOption().

Here is the call graph for this function:

Here is the caller graph for this function:

useGroupBy ( )

{Does the display have groupby enabled?}

Implements DisplayPluginInterface.

References DisplayPluginBase\getOption().

Referenced by DisplayPluginBase\getHandlers().

Here is the call graph for this function:

Here is the caller graph for this function:

useMoreAlways ( )

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

Implements DisplayPluginInterface.

References DisplayPluginBase\getOption(), and DisplayPluginBase\usesMore().

Referenced by DisplayPluginBase\preExecute(), and DisplayPluginBase\renderMoreLink().

Here is the call graph for this function:

Here is the caller graph for this function:

useMoreText ( )

{Does the display have custom link text?}

Implements DisplayPluginInterface.

References DisplayPluginBase\getOption(), and DisplayPluginBase\usesMore().

Referenced by DisplayPluginBase\renderMoreLink().

Here is the call graph for this function:

Here is the caller graph for this function:

usesAJAX ( )

{Whether the display allows the use of AJAX or not.

Returns
bool
}

Implements DisplayPluginInterface.

Referenced by DisplayPluginBase\ajaxEnabled(), and DisplayPluginBase\optionsSummary().

Here is the caller graph for this function:

usesAreas ( )

{Returns whether the display can use areas.

Returns
bool TRUE if the display can use areas, or FALSE otherwise.
}

Implements DisplayPluginInterface.

usesAttachments ( )

{Returns whether the display can use attachments.

Returns
bool
}

Implements DisplayPluginInterface.

Referenced by DisplayPluginBase\acceptAttachments(), and DisplayPluginBase\optionsSummary().

Here is the caller graph for this function:

usesExposed ( )

{Determines if this display uses exposed filters.}

Implements DisplayPluginInterface.

References DisplayPluginBase\getPlugin().

Referenced by DisplayPluginBase\preExecute(), and DisplayPluginBase\viewExposedFormBlocks().

Here is the call graph for this function:

Here is the caller graph for this function:

usesExposedFormInBlock ( )

{Checks to see if the display can put the exposed form in a block.By default, displays that do not have a path cannot disconnect the exposed form and put it in a block, because the form has no place to go and Views really wants the forms to go to a specific page.}

Implements DisplayPluginInterface.

References DisplayPluginBase\hasPath().

Referenced by DisplayPluginBase\getSpecialBlocks(), and DisplayPluginBase\optionsSummary().

Here is the call graph for this function:

Here is the caller graph for this function:

usesFields ( )

{Determines if the display's style uses fields.

Returns
bool
}

Implements DisplayPluginInterface.

References DisplayPluginBase\getPlugin().

Referenced by DisplayPluginBase\validate().

Here is the call graph for this function:

Here is the caller graph for this function:

usesLinkDisplay ( )

{Checks 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.}

Implements DisplayPluginInterface.

References DisplayPluginBase\hasPath().

Referenced by DisplayPluginBase\optionsSummary().

Here is the call graph for this function:

Here is the caller graph for this function:

usesMore ( )

{Whether the display allows the use of a 'more' link or not.

Returns
bool
}

Implements DisplayPluginInterface.

Referenced by DisplayPluginBase\isMoreEnabled(), DisplayPluginBase\optionsSummary(), DisplayPluginBase\useMoreAlways(), and DisplayPluginBase\useMoreText().

Here is the caller graph for this function:

usesPager ( )

{Whether the display allows the use of a pager or not.

Returns
bool
}

Implements DisplayPluginInterface.

Referenced by DisplayPluginBase\buildOptionsForm(), DisplayPluginBase\defaultableSections(), DisplayPluginBase\isPagerEnabled(), DisplayPluginBase\optionsSummary(), and Attachment\renderPager().

Here is the caller graph for this function:

validate ( )

{Make sure the display and all associated handlers are valid.

Returns
Empty array if the display is valid; an array of error strings if it is not.
}

Implements DisplayPluginInterface.

References DisplayPluginBase\getHandlers(), ViewExecutable\getHandlerTypes(), DisplayPluginBase\getOption(), DisplayPluginBase\getPlugin(), DisplayPluginBase\getRoutedDisplay(), DisplayPluginBase\hasPath(), DisplayPluginBase\isMoreEnabled(), t(), and DisplayPluginBase\usesFields().

Here is the call graph for this function:

validateOptionsForm ( $form,
FormStateInterface  $form_state 
)

{Validates the options form.}

Implements DisplayPluginInterface.

References FormStateInterface\get(), DisplayPluginBase\getPlugin(), FormStateInterface\getValue(), FormStateInterface\isValueEmpty(), FormStateInterface\setError(), and t().

Here is the call graph for this function:

viewExposedFormBlocks ( )

{Renders the exposed form as block.

Returns
string|null The rendered exposed form as string or NULL otherwise.
}

Implements DisplayPluginInterface.

References DisplayPluginBase\getOption(), DisplayPluginBase\getPlugin(), Drupal\routeMatch(), and DisplayPluginBase\usesExposed().

Here is the call graph for this function:

Field Documentation

$usesOptions = TRUE
protected

{}


The documentation for this class was generated from the following file: