class SimplePageVariant
Provides a page display variant that simply renders the main content.
Attributes
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase- class \Drupal\Core\Plugin\ConfigurablePluginBase implements \Drupal\Component\Plugin\ConfigurableInterface uses \Drupal\Core\Plugin\ConfigurableTrait extends \Drupal\Core\Plugin\PluginBase- class \Drupal\Core\Display\VariantBase implements \Drupal\Core\Display\VariantInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Cache\RefinableCacheableDependencyTrait extends \Drupal\Core\Plugin\ConfigurablePluginBase- class \Drupal\Core\Render\Plugin\DisplayVariant\SimplePageVariant implements \Drupal\Core\Display\PageVariantInterface extends \Drupal\Core\Display\VariantBase
 
 
- class \Drupal\Core\Display\VariantBase implements \Drupal\Core\Display\VariantInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Cache\RefinableCacheableDependencyTrait extends \Drupal\Core\Plugin\ConfigurablePluginBase
 
- class \Drupal\Core\Plugin\ConfigurablePluginBase implements \Drupal\Component\Plugin\ConfigurableInterface uses \Drupal\Core\Plugin\ConfigurableTrait extends \Drupal\Core\Plugin\PluginBase
 
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \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 | 
|---|---|---|---|---|---|---|
| AutowiredInstanceTrait::createInstanceAutowired | public static | function | Instantiates a new instance of the implementing class using autowiring. | |||
| 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 | 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 | 2 | |||
| DependencySerializationTrait::__wakeup | public | function | 2 | |||
| 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::create | public static | function | Instantiates a new instance of the implementing class using autowiring. | 163 | ||
| PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | ||||
| PluginBase::getBaseId | public | function | Overrides DerivativeInspectionInterface::getBaseId | |||
| PluginBase::getDerivativeId | public | function | Overrides DerivativeInspectionInterface::getDerivativeId | |||
| PluginBase::getPluginDefinition | public | function | Overrides PluginInspectionInterface::getPluginDefinition | 2 | ||
| PluginBase::getPluginId | public | function | 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 | Overrides VariantInterface::build | |||
| SimplePageVariant::setMainContent | public | function | Overrides PageVariantInterface::setMainContent | |||
| SimplePageVariant::setTitle | public | function | 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 | Overrides VariantInterface::access | |||
| VariantBase::adminLabel | public | function | Overrides VariantInterface::adminLabel | |||
| VariantBase::buildConfigurationForm | public | function | Overrides PluginFormInterface::buildConfigurationForm | |||
| VariantBase::calculateDependencies | public | function | Overrides DependentPluginInterface::calculateDependencies | |||
| VariantBase::defaultConfiguration | public | function | Overrides ConfigurableTrait::defaultConfiguration | |||
| VariantBase::getConfiguration | public | function | Overrides ConfigurableTrait::getConfiguration | |||
| VariantBase::getWeight | public | function | Overrides VariantInterface::getWeight | |||
| VariantBase::id | public | function | Overrides VariantInterface::id | |||
| VariantBase::label | public | function | Overrides VariantInterface::label | |||
| VariantBase::setWeight | public | function | Overrides VariantInterface::setWeight | |||
| VariantBase::submitConfigurationForm | public | function | Overrides PluginFormInterface::submitConfigurationForm | |||
| VariantBase::validateConfigurationForm | public | function | Overrides PluginFormInterface::validateConfigurationForm | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
