You are here

Home » API reference » Entity Extra Field 2.0.x » ExtraFieldBlockPlugin.php

class ExtraFieldBlockPlugin in Entity Extra Field 2.0.x

Same name and namespace in other branches
  1. 8 src/Plugin/ExtraFieldType/ExtraFieldBlockPlugin.php \Drupal\entity_extra_field\Plugin\ExtraFieldType\ExtraFieldBlockPlugin

Define extra field block type.

Plugin annotation


@ExtraFieldType(
  id = "block",
  label = @Translation("Block")
)

Hierarchy

Expanded class hierarchy of ExtraFieldBlockPlugin

File

src/Plugin/ExtraFieldType/ExtraFieldBlockPlugin.php, line 35

Namespace

Drupal\entity_extra_field\Plugin\ExtraFieldType
View source 
class ExtraFieldBlockPlugin extends ExtraFieldTypePluginBase {
  use EntityExtraFieldContextTrait;

  /**
   * @var \Drupal\Core\Session\AccountInterface
   */
  private $currentUser;

  /**
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $blockManager;

  /**
   * Extra field block plugin constructor.
   *
   * @param array $configuration
   *   The plugin configuration.
   * @param string $plugin_id
   *   The plugin identifier.
   * @param array $plugin_definition
   *   The plugin definition.
   * @param \Drupal\Core\Utility\Token $token
   *   The token service.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler service.
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   The current logged in user object.
   * @param \Drupal\Core\Routing\RouteMatchInterface $current_route_match
   *   The current route match service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager service.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
   *   The entity field manager service.
   * @param \Drupal\Core\Block\BlockManagerInterface $block_manager
   *   The block manager service.
   */
  public function __construct(array $configuration, string $plugin_id, array $plugin_definition, Token $token, ModuleHandlerInterface $module_handler, AccountInterface $current_user, RouteMatchInterface $current_route_match, EntityTypeManagerInterface $entity_type_manager, EntityFieldManagerInterface $entity_field_manager, BlockManagerInterface $block_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $token, $module_handler, $current_route_match, $entity_type_manager, $entity_field_manager);
    $this->currentUser = $current_user;
    $this->blockManager = $block_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('token'), $container
      ->get('module_handler'), $container
      ->get('current_user'), $container
      ->get('current_route_match'), $container
      ->get('entity_type.manager'), $container
      ->get('entity_field.manager'), $container
      ->get('plugin.manager.block'), $container
      ->get('context.handler'), $container
      ->get('context.repository'));
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() : array {
    return [
      'block_type' => NULL,
      'block_config' => [],
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) : array {
    $form = parent::buildConfigurationForm($form, $form_state);

    /** @var \Drupal\Core\Entity\EntityFormInterface $form_object */
    $form_object = $form_state
      ->getFormObject();
    $entity = $form_object
      ->getEntity();
    $form_state
      ->setTemporaryValue('gathered_contexts', [
      'entity_extra_field.target_entity' => $entity
        ->getBaseEntityContext(),
    ] + $this
      ->getContextRepository()
      ->getAvailableContexts());
    $block_type = $this
      ->getPluginFormStateValue('block_type', $form_state);
    $form['block_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Block Type'),
      '#required' => TRUE,
      '#options' => $this
        ->getBlockTypeOptions(),
      '#empty_option' => $this
        ->t('- Select -'),
      '#ajax' => [
        'event' => 'change',
        'method' => 'replace',
      ] + $this
        ->extraFieldPluginAjax(),
      '#default_value' => $block_type,
    ];
    if (isset($block_type) && !empty($block_type) && $this->blockManager
      ->hasDefinition($block_type)) {
      $block_config = $this
        ->getPluginFormStateValue('block_config', $form_state, []);
      $block_instance = $this->blockManager
        ->createInstance($block_type, $block_config);
      if ($block_instance instanceof PluginFormInterface) {
        $form['block_config'] = [
          '#type' => 'fieldset',
          '#title' => $this
            ->t('Block Configuration'),
          '#tree' => TRUE,
        ];
        $subform = [
          '#parents' => array_merge($form['#parents'], [
            'block_config',
          ]),
        ];
        $form['block_config'] += $block_instance
          ->buildConfigurationForm($subform, SubformState::createForSubform($subform, $form, $form_state));
      }
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) : void {
    parent::validateConfigurationForm($form, $form_state);
    $block_instance = $this
      ->getBlockTypeInstance();
    if ($block_instance instanceof PluginFormInterface) {
      $subform = [
        '#parents' => array_merge($form['#parents'], [
          'block_config',
        ]),
      ];
      $block_instance
        ->validateConfigurationForm($subform, SubformState::createForSubform($subform, $form, $form_state));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) : void {
    parent::submitConfigurationForm($form, $form_state);
    $block_instance = $this
      ->getBlockTypeInstance();
    if ($block_instance instanceof PluginFormInterface) {
      $subform = [
        '#parents' => array_merge($form['#parents'], [
          'block_config',
        ]),
      ];
      $block_instance
        ->submitConfigurationForm($subform, SubformState::createForSubform($subform, $form, $form_state));
      $form_state
        ->setValue([
        'block_config',
      ], $block_instance
        ->getConfiguration());
    }
  }

  /**
   * {@inheritdoc}
   */
  public function build(EntityInterface $entity, EntityDisplayInterface $display) : array {
    $block = $this
      ->getBlockTypeInstance();
    if (!$block instanceof BlockPluginInterface) {
      return [];
    }
    $element = [];
    if ($block instanceof ContextAwarePluginInterface) {
      try {
        $this
          ->applyPluginRuntimeContexts($block, [
          'display' => EntityContext::fromEntity($display),
          'view_mode' => new Context(ContextDefinition::create('string'), $display
            ->getMode()),
          'entity_extra_field.target_entity' => EntityContext::fromEntity($entity),
        ]);
      } catch (\Exception $exception) {
        watchdog_exception('entity_extra_field', $exception);
      }
    }
    if ($block
      ->access($this->currentUser) && ($build = $block
      ->build())) {
      $element = [
        '#theme' => 'block',
        '#attributes' => [],
        '#configuration' => $block
          ->getConfiguration(),
        '#plugin_id' => $block
          ->getPluginId(),
        '#base_plugin_id' => $block
          ->getBaseId(),
        '#derivative_plugin_id' => $block
          ->getDerivativeId(),
        '#id' => str_replace(':', '-', $block
          ->getPluginId()),
        'content' => $build,
      ];
      CacheableMetadata::createFromRenderArray($element)
        ->merge(CacheableMetadata::createFromRenderArray($element['content']))
        ->addCacheableDependency($block)
        ->applyTo($element);
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() : array {
    if ($block_type_instance = $this
      ->getBlockTypeInstance()) {
      $this
        ->calculatePluginDependencies($block_type_instance);
    }
    return parent::calculateDependencies();
  }

  /**
   * Get block type instance.
   *
   * @return \Drupal\Core\Block\BlockPluginInterface
   *   The block instance; otherwise FALSE if type is not defined.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   */
  protected function getBlockTypeInstance() : BlockPluginInterface {
    $config = $this
      ->getConfiguration();
    return $this->blockManager
      ->createInstance($config['block_type'], $config['block_config']);
  }

  /**
   * Get block type options.
   *
   * @param array $excluded_ids
   *   An array of block ids to exclude.
   *
   * @return array
   *   An array of block type options.
   */
  protected function getBlockTypeOptions(array $excluded_ids = []) : array {
    $options = [];

    // There are a couple block ids that are excluded by default as either
    // they're not really needed, or they are causing problems when selected.
    $excluded_ids = [
      'broken',
      'system_branding_block',
    ] + $excluded_ids;
    foreach ($this->blockManager
      ->getDefinitions() as $block_id => $definition) {
      if (!isset($definition['admin_label']) || in_array($block_id, $excluded_ids, TRUE)) {
        continue;
      }
      $category = $definition['category'] ?? $this
        ->t('Undefined');
      $options[(string) $category][$block_id] = $definition['admin_label'];
    }
    return $options;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
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.
EntityExtraFieldContextTrait::applyPluginRuntimeContexts protected function Apply the plugin runtime contexts.
EntityExtraFieldContextTrait::getContextHandler protected function Get the context handler service.
EntityExtraFieldContextTrait::getContextRepository protected function Get the context repository service.
ExtraFieldBlockPlugin::$blockManager protected property
ExtraFieldBlockPlugin::$currentUser private property
ExtraFieldBlockPlugin::build public function Build the render array of the extra field type contents. Overrides ExtraFieldTypePluginInterface::build
ExtraFieldBlockPlugin::buildConfigurationForm public function Form constructor. Overrides ExtraFieldTypePluginBase::buildConfigurationForm
ExtraFieldBlockPlugin::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides ExtraFieldTypePluginBase::calculateDependencies
ExtraFieldBlockPlugin::create public static function Creates an instance of the plugin. Overrides ExtraFieldTypePluginBase::create
ExtraFieldBlockPlugin::defaultConfiguration public function Gets default configuration for this plugin. Overrides ExtraFieldTypePluginBase::defaultConfiguration
ExtraFieldBlockPlugin::getBlockTypeInstance protected function Get block type instance.
ExtraFieldBlockPlugin::getBlockTypeOptions protected function Get block type options.
ExtraFieldBlockPlugin::submitConfigurationForm public function Form submission handler. Overrides ExtraFieldTypePluginBase::submitConfigurationForm
ExtraFieldBlockPlugin::validateConfigurationForm public function Form validation handler. Overrides ExtraFieldTypePluginBase::validateConfigurationForm
ExtraFieldBlockPlugin::__construct public function Extra field block plugin constructor. Overrides ExtraFieldTypePluginBase::__construct
ExtraFieldTypePluginBase::$currentRouteMatch protected property
ExtraFieldTypePluginBase::$entityFieldManager protected property
ExtraFieldTypePluginBase::$entityTypeManager protected property
ExtraFieldTypePluginBase::$moduleHandler protected property
ExtraFieldTypePluginBase::$token protected property
ExtraFieldTypePluginBase::extraFieldPluginAjax protected function Get extra field plugin ajax properties.
ExtraFieldTypePluginBase::extraFieldPluginAjaxCallback public function Get extra field plugin ajax.
ExtraFieldTypePluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ExtraFieldTypePluginBase::getEntityFieldReferenceTypes protected function Get entity field reference types.
ExtraFieldTypePluginBase::getEntityTokenData protected function Get entity token data.
ExtraFieldTypePluginBase::getEntityTokenTypes protected function Get entity token types.
ExtraFieldTypePluginBase::getPluginFormStateValue protected function Get plugin form state value.
ExtraFieldTypePluginBase::getTargetEntityTypeBundle protected function Get target entity type bundle.
ExtraFieldTypePluginBase::getTargetEntityTypeDefinition protected function Get target entity type definition.
ExtraFieldTypePluginBase::getTargetEntityTypeId protected function Get target entity type identifier.
ExtraFieldTypePluginBase::label public function Display the extra field plugin label. Overrides ExtraFieldTypePluginInterface::label
ExtraFieldTypePluginBase::processEntityToken protected function Process the entity token text.
ExtraFieldTypePluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
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 2
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
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.