class SimplePageVariant

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Render/Plugin/DisplayVariant/SimplePageVariant.php \Drupal\Core\Render\Plugin\DisplayVariant\SimplePageVariant
  2. 10 core/lib/Drupal/Core/Render/Plugin/DisplayVariant/SimplePageVariant.php \Drupal\Core\Render\Plugin\DisplayVariant\SimplePageVariant
  3. 11.x 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.

Plugin annotation


@PageDisplayVariant(
  id = "simple_page",
  admin_label = @Translation("Simple page")
)

Hierarchy

Expanded class hierarchy of SimplePageVariant

File

core/lib/Drupal/Core/Render/Plugin/DisplayVariant/SimplePageVariant.php, line 16

Namespace

Drupal\Core\Render\Plugin\DisplayVariant
View 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 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.
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
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
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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
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 ConfigurableInterface::defaultConfiguration
VariantBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::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::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
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
VariantBase::__construct public function 1

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.