BlockBase.php in Display Suite 8.3
File
src/Plugin/DsField/BlockBase.php
View source
<?php
namespace Drupal\ds\Plugin\DsField;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Plugin\Context\ContextHandlerInterface;
use Drupal\Core\Plugin\Context\ContextRepositoryInterface;
use Drupal\Core\Plugin\ContextAwarePluginInterface;
use Drupal\Core\Render\Element;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Drupal\Core\Block\BlockManagerInterface;
abstract class BlockBase extends DsFieldBase implements ContainerFactoryPluginInterface {
protected $block;
protected $blockManager;
protected $contextHandler;
protected $contextRepository;
public function __construct($configuration, $plugin_id, $plugin_definition, ContextHandlerInterface $contextHandler, ContextRepositoryInterface $contextRepository, BlockManagerInterface $block_manager) {
$this->blockManager = $block_manager;
$this->contextHandler = $contextHandler;
$this->contextRepository = $contextRepository;
parent::__construct($configuration, $plugin_id, $plugin_definition);
}
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('context.handler'), $container
->get('context.repository'), $container
->get('plugin.manager.block'));
}
public function build() {
$block = $this
->getBlock();
$block_config = $this
->blockConfig();
$block
->setConfiguration($block_config);
$add_wrappers = isset($this
->getFieldConfiguration()['properties']['add_block_wrappers']) ? $this
->getFieldConfiguration()['properties']['add_block_wrappers'] : FALSE;
if ($block
->access(\Drupal::currentUser())) {
if ($block instanceof ContextAwarePluginInterface) {
$contexts = $this->contextRepository
->getRuntimeContexts(array_values($block
->getContextMapping()));
$this->contextHandler
->applyContextMapping($block, $contexts);
}
$block_build = $block
->build();
if ($add_wrappers) {
$render_element = [
'#theme' => 'block',
'#attributes' => [],
'#configuration' => $block
->getConfiguration(),
'#plugin_id' => $block
->getPluginId(),
'#base_plugin_id' => $block
->getBaseId(),
'#derivative_plugin_id' => $block
->getDerivativeId(),
'content' => $block_build,
];
}
else {
$render_element = $block_build;
}
if ($contexts = $block
->getCacheContexts()) {
$render_element['#cache']['contexts'] = [];
if (isset($block_build['#cache']) && isset($block_build['contexts']) && is_array($block_build['#cache']['contexts'])) {
$render_element['#cache']['contexts'] = $block_build['#cache']['contexts'];
}
$render_element['#cache']['contexts'] = array_unique(array_merge($render_element['#cache']['contexts'], $contexts));
}
if ($tags = $block
->getCacheTags()) {
$render_element['#cache']['tags'] = [];
if (isset($block_build['#cache']) && isset($block_build['tags']) && is_array($block_build['#cache']['tags'])) {
$render_element['#cache']['tags'] = $block_build['#cache']['tags'];
}
$render_element['#cache']['tags'] = array_unique(array_merge($render_element['#cache']['tags'], $tags));
}
$render_element['#cache']['tags'][] = 'config:ds.block_base';
$max_age = $block
->getCacheMaxAge();
if (is_numeric($max_age) && !isset($render_element['#cache']['max-age'])) {
$render_element['#cache']['max-age'] = $max_age;
}
return Element::isEmpty($render_element) ? [] : $render_element;
}
return [];
}
protected function blockPluginId() {
return '';
}
protected function blockConfig() {
return [];
}
protected function getBlock() {
if (!$this->block) {
$block_id = $this
->blockPluginId();
$block = $this->blockManager
->createInstance($block_id);
$this->block = $block;
}
return $this->block;
}
}
Classes
Name |
Description |
BlockBase |
The base plugin to create DS block fields. |