Drupal 8  8.0.2
DisplayTest Class Reference
Inheritance diagram for DisplayTest:

Public Member Functions

 getType ()
 
 optionsSummary (&$categories, &$options)
 
 buildOptionsForm (&$form, FormStateInterface $form_state)
 
 validateOptionsForm (&$form, FormStateInterface $form_state)
 
 submitOptionsForm (&$form, FormStateInterface $form_state)
 
 execute ()
 
 preview ()
 
 calculateDependencies ()
 
 validate ()
 
- Public Member Functions inherited from DisplayPluginBase
 __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)
 
 access (AccountInterface $account=NULL)
 
 calculateCacheMetadata ()
 

Protected Member Functions

 defineOptions ()
 
- Protected Member Functions inherited from DisplayPluginBase
 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

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

Additional Inherited Members

- Static Public Member Functions inherited from DisplayPluginBase
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 inherited from DisplayPluginBase
 $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
 
- Static Protected Attributes inherited from DisplayPluginBase
static $unpackOptions = array()
 

Detailed Description

Defines a Display test plugin.

( id = "display_test", title = ("Display test"), help = ("Defines a display test plugin."), theme = "views_view", register_theme = FALSE, contextual_links_locations = {"view"} )

Member Function Documentation

buildOptionsForm ( $form,
FormStateInterface  $form_state 
)

{Provides the default form for setting options.}

Implements DisplayPluginInterface.

References FormStateInterface\get(), DisplayPluginBase\getOption(), and t().

Here is the call 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.

defineOptions ( )
protected

{}

execute ( )

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

Implements DisplayPluginInterface.

References Xss\filterAdmin().

Referenced by DisplayTest\preview().

Here is the call graph for this function:

Here is the caller 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.

optionsSummary ( $categories,
$options 
)

{Provides the default summary for options in the views UI.This output is returned as an array.}

Implements DisplayPluginInterface.

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

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.

References DisplayTest\execute().

Here is the call graph for this function:

submitOptionsForm ( $form,
FormStateInterface  $form_state 
)

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

Implements DisplayPluginInterface.

References FormStateInterface\get(), FormStateInterface\getValue(), and DisplayPluginBase\setOption().

Here is the call 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.

validateOptionsForm ( $form,
FormStateInterface  $form_state 
)

{Validates the options form.}

Implements DisplayPluginInterface.

References FormStateInterface\get(), FormStateInterface\getValue(), Drupal\logger(), FormStateInterface\setError(), and t().

Here is the call graph for this function:


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