Drupal 8  8.0.2
Page Class Reference
Inheritance diagram for Page:

Public Member Functions

 __construct (array $configuration, $plugin_id, $plugin_definition, RouteProviderInterface $route_provider, StateInterface $state, EntityStorageInterface $menu_storage)
 
 execute ()
 
 optionsSummary (&$categories, &$options)
 
 buildOptionsForm (&$form, FormStateInterface $form_state)
 
 validateOptionsForm (&$form, FormStateInterface $form_state)
 
 submitOptionsForm (&$form, FormStateInterface $form_state)
 
 validate ()
 
 getArgumentText ()
 
 getPagerText ()
 
 calculateDependencies ()
 
- Public Member Functions inherited from PathPluginBase
 __construct (array $configuration, $plugin_id, $plugin_definition, RouteProviderInterface $route_provider, StateInterface $state)
 
 hasPath ()
 
 getPath ()
 
 collectRoutes (RouteCollection $collection)
 
 alterRoutes (RouteCollection $collection)
 
 getMenuLinks ()
 
 execute ()
 
 optionsSummary (&$categories, &$options)
 
 buildOptionsForm (&$form, FormStateInterface $form_state)
 
 validateOptionsForm (&$form, FormStateInterface $form_state)
 
 submitOptionsForm (&$form, FormStateInterface $form_state)
 
 validate ()
 
 getUrlInfo ()
 
 getRouteName ()
 
 getAlteredRouteNames ()
 
- 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 ()
 

Static Public Member Functions

static create (ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition)
 
static & setPageRenderArray (array &$element=NULL)
 
static & getPageRenderArray ()
 
static buildBasicRenderable ($view_id, $display_id, array $args=[], Route $route=NULL)
 
- Static Public Member Functions inherited from PathPluginBase
static create (ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition)
 
- 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 ()
 

Protected Member Functions

 defineOptions ()
 
- Protected Member Functions inherited from PathPluginBase
 isDefaultTabPath ()
 
 defineOptions ()
 
 getRoute ($view_id, $display_id)
 
 validatePath ($path)
 
- 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
 
 $menuStorage
 
- Protected Attributes inherited from PathPluginBase
 $routeProvider
 
 $state
 
- 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
 

Static Protected Attributes

static $pageRenderArray
 
- Static Protected Attributes inherited from DisplayPluginBase
static $unpackOptions = array()
 

Additional Inherited Members

- 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
 

Detailed Description

The plugin that handles a full page.

( id = "page", title = ("Page"), help = ("Display the view as a page, with a URL and menu links."), uses_menu_links = TRUE, uses_route = TRUE, contextual_links_locations = {"page"}, theme = "views_view", admin = ("Page") )

Constructor & Destructor Documentation

__construct ( array  $configuration,
  $plugin_id,
  $plugin_definition,
RouteProviderInterface  $route_provider,
StateInterface  $state,
EntityStorageInterface  $menu_storage 
)

Constructs a Page object.

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.
\Drupal\Core\Routing\RouteProviderInterface$route_providerThe route provider.
\Drupal\Core\State\StateInterface$stateThe state key value store.
\Drupal\Core\Entity\EntityStorageInterface$menu_storageThe menu storage.

Member Function Documentation

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

{}

Referenced by PageTest\testBuildBasicRenderable(), and PageTest\testBuildBasicRenderableWithMissingRoute().

Here is the caller graph for this function:

buildOptionsForm ( $form,
FormStateInterface  $form_state 
)

{Provides the default form for setting options.}

Implements DisplayPluginInterface.

References FormStateInterface\get(), DisplayPluginBase\getOption(), Drupal\moduleHandler(), Drupal\service(), 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.

References DisplayPluginBase\getOption().

Here is the call graph for this function:

static create ( ContainerInterface  $container,
array  $configuration,
  $plugin_id,
  $plugin_definition 
)
static

{Creates an instance of the plugin.

Parameters
\Symfony\Component\DependencyInjection\ContainerInterface$containerThe container to pull out services used in the plugin.
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.
Returns
static Returns an instance of this plugin.
}

Implements ContainerFactoryPluginInterface.

defineOptions ( )
protected

{}

execute ( )

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

Implements DisplayPluginInterface.

References Xss\getHtmlTagList().

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

static& getPageRenderArray ( )
static

Gets the current views page render array.

Returns
array The page render array.
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:

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:

static& setPageRenderArray ( array &  $element = NULL)
static

Sets the current page views render array.

Parameters
array$element(optional) A render array. If not specified the previous element is returned.
Returns
array The page render array.
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.

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

Here is the call graph for this function:

validateOptionsForm ( $form,
FormStateInterface  $form_state 
)

{Validates the options form.}

Implements DisplayPluginInterface.

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

Here is the call graph for this function:


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