class SimplePageVariant
Same name and namespace in other branches
- 9 core/lib/Drupal/Core/Render/Plugin/DisplayVariant/SimplePageVariant.php \Drupal\Core\Render\Plugin\DisplayVariant\SimplePageVariant
- 8.9.x core/lib/Drupal/Core/Render/Plugin/DisplayVariant/SimplePageVariant.php \Drupal\Core\Render\Plugin\DisplayVariant\SimplePageVariant
- 10 core/lib/Drupal/Core/Render/Plugin/DisplayVariant/SimplePageVariant.php \Drupal\Core\Render\Plugin\DisplayVariant\SimplePageVariant
Provides a page display variant that simply renders the main content.
Attributes
Hierarchy
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Plugin\ConfigurablePluginBase extends \Drupal\Component\Plugin\ConfigurableInterface uses \Drupal\Core\Plugin\ConfigurableTrait implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Display\VariantBase extends \Drupal\Core\Display\VariantInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Cache\RefinableCacheableDependencyTrait implements \Drupal\Core\Plugin\ConfigurablePluginBase
- class \Drupal\Core\Render\Plugin\DisplayVariant\SimplePageVariant extends \Drupal\Core\Display\PageVariantInterface implements \Drupal\Core\Display\VariantBase
- class \Drupal\Core\Display\VariantBase extends \Drupal\Core\Display\VariantInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Cache\RefinableCacheableDependencyTrait implements \Drupal\Core\Plugin\ConfigurablePluginBase
- class \Drupal\Core\Plugin\ConfigurablePluginBase extends \Drupal\Component\Plugin\ConfigurableInterface uses \Drupal\Core\Plugin\ConfigurableTrait implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of SimplePageVariant
File
-
core/
lib/ Drupal/ Core/ Render/ Plugin/ DisplayVariant/ SimplePageVariant.php, line 13
Namespace
Drupal\Core\Render\Plugin\DisplayVariantView source
class SimplePageVariant extends VariantBase implements PageVariantInterface {
/**
* The render array representing the main content.
*
* @var array
*/
protected $mainContent;
/**
* The page title: a string (plain title) or a render array (formatted title).
*
* @var string|array
*/
protected $title = '';
/**
* {@inheritdoc}
*/
public function setMainContent(array $main_content) {
$this->mainContent = $main_content;
return $this;
}
/**
* {@inheritdoc}
*/
public function setTitle($title) {
$this->title = $title;
return $this;
}
/**
* {@inheritdoc}
*/
public function build() {
$build = [
'content' => [
'messages' => [
'#type' => 'status_messages',
'#weight' => -1000,
'#include_fallback' => TRUE,
],
'page_title' => [
'#type' => 'page_title',
'#title' => $this->title,
'#weight' => -900,
],
'main_content' => [
'#weight' => -800,
] + $this->mainContent,
],
];
return $build;
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
CacheableDependencyTrait::$cacheContexts | protected | property | Cache contexts. | |||
CacheableDependencyTrait::$cacheMaxAge | protected | property | Cache max-age. | |||
CacheableDependencyTrait::$cacheTags | protected | property | Cache tags. | |||
CacheableDependencyTrait::getCacheContexts | public | function | 4 | |||
CacheableDependencyTrait::getCacheMaxAge | public | function | 4 | |||
CacheableDependencyTrait::getCacheTags | public | function | 4 | |||
CacheableDependencyTrait::setCacheability | protected | function | Sets cacheability; useful for value object constructors. | |||
ConfigurablePluginBase::__construct | public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | Overrides PluginBase::__construct | 5 | |
ConfigurableTrait::$configuration | protected | property | Configuration information passed into the plugin. | |||
ConfigurableTrait::setConfiguration | public | function | Sets the configuration for this plugin instance. | 2 | ||
DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
DependencySerializationTrait::__sleep | public | function | 3 | |||
DependencySerializationTrait::__wakeup | public | function | 3 | |||
DependencyTrait::$dependencies | protected | property | The object's dependencies. | |||
DependencyTrait::addDependencies | protected | function | Adds multiple dependencies. | |||
DependencyTrait::addDependency | protected | function | Adds a dependency. | |||
MessengerTrait::$messenger | protected | property | The messenger. | 25 | ||
MessengerTrait::messenger | public | function | Gets the messenger. | 25 | ||
MessengerTrait::setMessenger | public | function | Sets the messenger. | |||
PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | ||
PluginBase::$pluginId | protected | property | The plugin ID. | |||
PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | ||||
PluginBase::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | Overrides DerivativeInspectionInterface::getBaseId | ||
PluginBase::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | Overrides DerivativeInspectionInterface::getDerivativeId | ||
PluginBase::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | Overrides PluginInspectionInterface::getPluginDefinition | 2 | |
PluginBase::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | ||
PluginBase::isConfigurable | Deprecated | public | function | Determines if the plugin is configurable. | ||
PluginDependencyTrait::calculatePluginDependencies | protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 | ||
PluginDependencyTrait::getPluginDependencies | protected | function | Calculates and returns dependencies of a specific plugin instance. | |||
PluginDependencyTrait::moduleHandler | protected | function | Wraps the module handler. | 1 | ||
PluginDependencyTrait::themeHandler | protected | function | Wraps the theme handler. | 1 | ||
RefinableCacheableDependencyTrait::addCacheableDependency | public | function | 1 | |||
RefinableCacheableDependencyTrait::addCacheContexts | public | function | ||||
RefinableCacheableDependencyTrait::addCacheTags | public | function | ||||
RefinableCacheableDependencyTrait::mergeCacheMaxAge | public | function | ||||
SimplePageVariant::$mainContent | protected | property | The render array representing the main content. | |||
SimplePageVariant::$title | protected | property | The page title: a string (plain title) or a render array (formatted title). | |||
SimplePageVariant::build | public | function | Builds and returns the renderable array for the display variant. | Overrides VariantInterface::build | ||
SimplePageVariant::setMainContent | public | function | Sets the main content for the page being rendered. | Overrides PageVariantInterface::setMainContent | ||
SimplePageVariant::setTitle | public | function | Sets the title for the page being rendered. | Overrides PageVariantInterface::setTitle | ||
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | ||
StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | |||
StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | |||
StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | |||
StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | ||
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | 1 | ||
VariantBase::access | public | function | Determines if this display variant is accessible. | Overrides VariantInterface::access | ||
VariantBase::adminLabel | public | function | Returns the admin-facing display variant label. | Overrides VariantInterface::adminLabel | ||
VariantBase::buildConfigurationForm | public | function | Form constructor. | Overrides PluginFormInterface::buildConfigurationForm | ||
VariantBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | ||
VariantBase::defaultConfiguration | public | function | Gets default configuration for this plugin. | Overrides ConfigurableTrait::defaultConfiguration | ||
VariantBase::getConfiguration | public | function | Gets this plugin's configuration. | Overrides ConfigurableTrait::getConfiguration | ||
VariantBase::getWeight | public | function | Returns the weight of the display variant. | Overrides VariantInterface::getWeight | ||
VariantBase::id | public | function | Returns the unique ID for the display variant. | Overrides VariantInterface::id | ||
VariantBase::label | public | function | Returns the user-facing display variant label. | Overrides VariantInterface::label | ||
VariantBase::setWeight | public | function | Sets the weight of the display variant. | Overrides VariantInterface::setWeight | ||
VariantBase::submitConfigurationForm | public | function | Form submission handler. | Overrides PluginFormInterface::submitConfigurationForm | ||
VariantBase::validateConfigurationForm | public | function | Form validation handler. | Overrides PluginFormInterface::validateConfigurationForm |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.