class ContextBlockPageVariant in Context 8

Same name and namespace in other branches

8.4 src/Plugin/DisplayVariant/ContextBlockPageVariant.php \Drupal\context\Plugin\DisplayVariant\ContextBlockPageVariant
8.0 src/Plugin/DisplayVariant/ContextBlockPageVariant.php \Drupal\context\Plugin\DisplayVariant\ContextBlockPageVariant

Provides a page display variant that decorates the main content with blocks.

Plugin annotation


@PageDisplayVariant(
  id = "context_block_page",
  admin_label = @Translation("Page with blocks")
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Display\VariantBase implements VariantInterface uses RefinableCacheableDependencyTrait, PluginDependencyTrait
    class \Drupal\context\Plugin\DisplayVariant\ContextBlockPageVariant implements PageVariantInterface, ContainerFactoryPluginInterface

Expanded class hierarchy of ContextBlockPageVariant

File

src/Plugin/DisplayVariant/ContextBlockPageVariant.php, line 24

Namespace

Drupal\context\Plugin\DisplayVariant

View source

class ContextBlockPageVariant extends VariantBase implements PageVariantInterface, ContainerFactoryPluginInterface {

  /**
   * @var ContextManager
   */
  protected $contextManager;

  /**
   * The render array representing the main page content.
   *
   * @var array
   */
  protected $mainContent = [];

  /**
   * The page title: a string (plain title) or a render array (formatted title).
   *
   * @var string|array
   */
  protected $title = '';

  /**
   * Constructs a new ContextBlockPageVariant.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   *
   * @param string $plugin_id
   *   The plugin ID for the plugin instance.
   *
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   *
   * @param ContextManager $contextManager
   *   The context module manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ContextManager $contextManager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->contextManager = $contextManager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('context.manager'));
  }

  /**
   * {@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 = [
      '#cache' => [
        'tags' => [
          'context_block_page',
          $this
            ->getPluginId(),
        ],
      ],
    ];

    // Place main content block, it will be removed by the reactions if a main
    // content block has been manually placed.
    $build['content']['system_main'] = $this->mainContent;

    // Execute each block reaction and let them modify the page build.
    foreach ($this->contextManager
      ->getActiveReactions('blocks') as $reaction) {
      $build = $reaction
        ->execute($build, $this->title, $this->mainContent);
    }

    // Execute each block reaction and check if default block should be included in page build.
    foreach ($this->contextManager
      ->getActiveReactions('blocks') as $reaction) {
      if ($reaction
        ->includeDefaultBlocks()) {
        $build = NestedArray::mergeDeep($this
          ->getBuildFromBlockLayout(), $build);
        return $build;
      }
    }
    return $build;
  }

  /**
   * Get build from Block layout.
   */
  private function getBuildFromBlockLayout() {
    $plugin_manager = \Drupal::service('plugin.manager.display_variant');
    $display_variant = $plugin_manager
      ->createInstance('block_page', $plugin_manager
      ->getDefinition('block_page'));
    $display_variant
      ->setTitle($this->title);
    return $display_variant
      ->build();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
CacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
CacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
CacheableDependencyTrait::getCacheContexts	public	function		3
CacheableDependencyTrait::getCacheMaxAge	public	function		3
CacheableDependencyTrait::getCacheTags	public	function		3
CacheableDependencyTrait::setCacheability	protected	function	Sets cacheability; useful for value object constructors.
ContextBlockPageVariant::$contextManager	protected	property
ContextBlockPageVariant::$mainContent	protected	property	The render array representing the main page content.
ContextBlockPageVariant::$title	protected	property	The page title: a string (plain title) or a render array (formatted title).
ContextBlockPageVariant::build	public	function	Builds and returns the renderable array for the display variant. Overrides VariantInterface::build
ContextBlockPageVariant::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ContextBlockPageVariant::getBuildFromBlockLayout	private	function	Get build from Block layout.
ContextBlockPageVariant::setMainContent	public	function	Sets the main content for the page being rendered. Overrides PageVariantInterface::setMainContent
ContextBlockPageVariant::setTitle	public	function	Sets the title for the page being rendered. Overrides PageVariantInterface::setTitle
ContextBlockPageVariant::__construct	public	function	Constructs a new ContextBlockPageVariant. Overrides VariantBase::__construct
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		1
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.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
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	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	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
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.
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

You are here

class ContextBlockPageVariant in Context 8

Plugin annotation

Hierarchy

See also

File

Namespace

Members

API Navigation