class EntityBrowserBlock in Entity Browser Block 8

Defines a generic entity browser block type.

Plugin annotation


@Block(
 id = "entity_browser_block",
 admin_label = @Translation("Entity Browser Block"),
 category = @Translation("Entity Browser"),
 deriver = "Drupal\entity_browser_block\Plugin\Derivative\EntityBrowserBlockDeriver"
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
  - class \Drupal\Core\Plugin\ContextAwarePluginBase implements CacheableDependencyInterface, ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
    class \Drupal\Core\Block\BlockBase implements BlockPluginInterface, PluginWithFormsInterface, PreviewFallbackInterface uses BlockPluginTrait, ContextAwarePluginAssignmentTrait
    class \Drupal\entity_browser_block\Plugin\Block\EntityBrowserBlock implements ContainerFactoryPluginInterface

Expanded class hierarchy of EntityBrowserBlock

File

src/Plugin/Block/EntityBrowserBlock.php, line 24

Namespace

Drupal\entity_browser_block\Plugin\Block

View source

class EntityBrowserBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * The entity type manager service.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The entity display repository service.
   *
   * @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface
   */
  protected $entityDisplayRepository;

  /**
   * The number of times this block allows rendering the same entity.
   *
   * @var int
   */
  const RECURSIVE_RENDER_LIMIT = 2;

  /**
   * An array of counters for the recursive rendering protection.
   *
   * @var array
   */
  protected static $recursiveRenderDepth = [];

  /**
   * Constructs a new EntityBrowserBlock.
   *
   * @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 \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager service.
   * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository
   *   The entity display repository.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, EntityDisplayRepositoryInterface $entity_display_repository) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entity_type_manager;
    $this->entityDisplayRepository = $entity_display_repository;
  }

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

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'entity_ids' => [],
      'view_modes' => [],
    ];
  }

  /**
   * Overrides \Drupal\Core\Block\BlockBase::blockForm().
   *
   * Adds body and description fields to the block configuration form.
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form['selection'] = [
      '#type' => 'container',
      '#attributes' => [
        'id' => 'entity-browser-block-form',
      ],
    ];
    $form['selection']['entity_browser'] = [
      '#type' => 'entity_browser',
      '#entity_browser' => $this
        ->getDerivativeId(),
      '#process' => [
        [
          '\\Drupal\\entity_browser\\Element\\EntityBrowserElement',
          'processEntityBrowser',
        ],
        [
          self::class,
          'processEntityBrowser',
        ],
      ],
      '#default_value' => self::loadEntitiesByIDs($this->configuration['entity_ids']),
    ];
    $order_class = 'entity-browser-block-delta-order';
    $form['selection']['table'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Title'),
        $this
          ->t('View mode'),
        $this
          ->t('Operations'),
        $this
          ->t('Order', [], [
          'context' => 'Sort order',
        ]),
      ],
      '#empty' => $this
        ->t('No entities yet'),
      '#tabledrag' => [
        [
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => $order_class,
        ],
      ],
      '#process' => [
        [
          self::class,
          'processTable',
        ],
      ],
      '#default_view_modes' => $this->configuration['view_modes'],
    ];
    return $form;
  }

  /**
   * Render API callback: Processes the table element.
   */
  public static function processTable(&$element, FormStateInterface $form_state, &$complete_form) {
    $parents = array_slice($element['#array_parents'], -3, 2);
    $entity_ids = $form_state
      ->getValue(array_merge($parents, [
      'entity_browser',
      'entity_ids',
    ]), '');
    $entities = empty($entity_ids) ? [] : self::loadEntitiesByIDs(explode(' ', $entity_ids));
    $display_repository = \Drupal::service('entity_display.repository');
    $delta = 0;
    foreach ($entities as $id => $entity) {
      $element[$id] = [
        '#attributes' => [
          'class' => [
            'draggable',
          ],
          'data-entity-id' => $id,
        ],
        'title' => [
          '#markup' => $entity
            ->label(),
        ],
        'view_mode' => [
          '#type' => 'select',
          '#options' => $display_repository
            ->getViewModeOptionsByBundle($entity
            ->getEntityTypeId(), $entity
            ->bundle()),
        ],
        'operations' => [
          'remove' => [
            '#type' => 'button',
            '#value' => t('Remove'),
            '#op' => 'remove',
            '#name' => 'remove_' . $id,
            '#ajax' => [
              'callback' => [
                self::class,
                'updateCallback',
              ],
              'wrapper' => 'entity-browser-block-form',
            ],
          ],
        ],
        '_weight' => [
          '#type' => 'weight',
          '#title' => t('Weight for row @number', [
            '@number' => $delta + 1,
          ]),
          '#title_display' => 'invisible',
          '#delta' => count($entities),
          '#default_value' => $delta,
          '#attributes' => [
            'class' => [
              'entity-browser-block-delta-order',
            ],
          ],
        ],
      ];
      if (isset($element['#default_view_modes'][$id])) {
        $element[$id]['view_mode']['#default_value'] = $element['#default_view_modes'][$id];
      }
      $delta++;
    }
    return $element;
  }

  /**
   * Loads entities based on an ID in the format entity_type:entity_id.
   *
   * @param array $ids
   *   An array of IDs.
   *
   * @return \Drupal\Core\Entity\EntityInterface[]
   *   An array of loaded entities, keyed by an ID.
   */
  public static function loadEntitiesByIDs($ids) {
    $storages = [];
    $entities = [];
    foreach ($ids as $id) {
      list($entity_type_id, $entity_id) = explode(':', $id);
      if (!isset($storages[$entity_type_id])) {
        $storages[$entity_type_id] = \Drupal::entityTypeManager()
          ->getStorage($entity_type_id);
      }
      $entities[$entity_type_id . ':' . $entity_id] = $storages[$entity_type_id]
        ->load($entity_id);
    }
    return $entities;
  }

  /**
   * AJAX callback: Re-renders the Entity Browser button/table.
   */
  public static function updateCallback(array &$form, FormStateInterface $form_state) {
    $trigger = $form_state
      ->getTriggeringElement();
    if (isset($trigger['#op']) && $trigger['#op'] === 'remove') {
      $parents = array_slice($trigger['#array_parents'], 0, -4);
      $selection = NestedArray::getValue($form, $parents);
      $id = str_replace('remove_', '', $trigger['#name']);
      unset($selection['table'][$id]);
      $value = explode(' ', $selection['entity_browser']['entity_ids']['#value']);
      $selection['entity_browser']['entity_ids']['#value'] = array_diff($value, [
        $id,
      ]);
    }
    else {
      $parents = array_slice($trigger['#array_parents'], 0, -2);
      $selection = NestedArray::getValue($form, $parents);
    }
    return $selection;
  }

  /**
   * Render API callback: Processes the entity browser element.
   */
  public static function processEntityBrowser(&$element, FormStateInterface $form_state, &$complete_form) {
    $element['entity_ids']['#ajax'] = [
      'callback' => [
        self::class,
        'updateCallback',
      ],
      'wrapper' => 'entity-browser-block-form',
      'event' => 'entity_browser_value_updated',
    ];
    $element['entity_ids']['#default_value'] = implode(' ', array_keys($element['#default_value']));
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $selection = $form_state
      ->getValue([
      'selection',
      'table',
    ], []);
    uasort($selection, function ($a, $b) {
      return SortArray::sortByKeyInt($a, $b, '_weight');
    });
    $entity_ids = [];
    $view_modes = [];
    foreach ($selection as $id => $values) {
      $entity_ids[] = $id;
      $view_modes[$id] = $values['view_mode'];
    }
    $this->configuration['entity_ids'] = $entity_ids;
    $this->configuration['view_modes'] = $view_modes;
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $build = [];
    $view_builders = [];
    $entities = self::loadEntitiesByIDs($this->configuration['entity_ids']);
    foreach ($entities as $id => $entity) {
      if (empty($entity)) {
        continue;
      }
      $entity_type_id = $entity
        ->getEntityTypeId();
      if (!isset($view_builders[$id])) {
        $view_builders[$id] = $this->entityTypeManager
          ->getViewBuilder($entity_type_id);
      }
      if ($entity && $entity
        ->access('view')) {
        if (isset(static::$recursiveRenderDepth[$id])) {
          static::$recursiveRenderDepth[$id]++;
        }
        else {
          static::$recursiveRenderDepth[$id] = 1;
        }
        if (static::$recursiveRenderDepth[$id] > static::RECURSIVE_RENDER_LIMIT) {
          return $build;
        }
        $build[] = $view_builders[$id]
          ->view($entity, $this->configuration['view_modes'][$id]);
      }
    }
    return $build;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlockPluginInterface::BLOCK_LABEL_VISIBLE		constant	Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$transliteration	protected	property	The transliteration service.
BlockPluginTrait::access	public	function
BlockPluginTrait::baseConfigurationDefaults	protected	function	Returns generic default configuration for block plugins.
BlockPluginTrait::blockAccess	protected	function	Indicates whether the block should be shown.	16
BlockPluginTrait::blockValidate	public	function		3
BlockPluginTrait::buildConfigurationForm	public	function	Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements.	2
BlockPluginTrait::calculateDependencies	public	function
BlockPluginTrait::getConfiguration	public	function		1
BlockPluginTrait::getMachineNameSuggestion	public	function		1
BlockPluginTrait::getPreviewFallbackString	public	function		3
BlockPluginTrait::label	public	function
BlockPluginTrait::setConfiguration	public	function
BlockPluginTrait::setConfigurationValue	public	function
BlockPluginTrait::setTransliteration	public	function	Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm	public	function	Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration	protected	function	Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm	public	function	Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate().	1
ContextAwarePluginAssignmentTrait::addContextAssignmentElement	protected	function	Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler	protected	function	Wraps the context handler.
ContextAwarePluginBase::$context	protected	property	The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated	private	property	Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration	protected	function	Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts	9
ContextAwarePluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge	7
ContextAwarePluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	4
ContextAwarePluginBase::getContext	public	function	This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition	public	function	Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions	public	function	Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping	public	function	Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts	public	function	Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue	public	function	Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues	public	function	Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext	public	function	Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping	public	function	Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue	public	function	Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts	public	function	Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get	public	function	Implements magic __get() method.
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
EntityBrowserBlock::$entityDisplayRepository	protected	property	The entity display repository service.
EntityBrowserBlock::$entityTypeManager	protected	property	The entity type manager service.
EntityBrowserBlock::$recursiveRenderDepth	protected static	property	An array of counters for the recursive rendering protection.
EntityBrowserBlock::blockForm	public	function	Overrides \Drupal\Core\Block\BlockBase::blockForm(). Overrides BlockPluginTrait::blockForm
EntityBrowserBlock::blockSubmit	public	function	Overrides BlockPluginTrait::blockSubmit
EntityBrowserBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
EntityBrowserBlock::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
EntityBrowserBlock::defaultConfiguration	public	function	Overrides BlockPluginTrait::defaultConfiguration
EntityBrowserBlock::loadEntitiesByIDs	public static	function	Loads entities based on an ID in the format entity_type:entity_id.
EntityBrowserBlock::processEntityBrowser	public static	function	Render API callback: Processes the entity browser element.
EntityBrowserBlock::processTable	public static	function	Render API callback: Processes the table element.
EntityBrowserBlock::RECURSIVE_RENDER_LIMIT		constant	The number of times this block allows rendering the same entity.
EntityBrowserBlock::updateCallback	public static	function	AJAX callback: Re-renders the Entity Browser button/table.
EntityBrowserBlock::__construct	public	function	Constructs a new EntityBrowserBlock. Overrides BlockPluginTrait::__construct
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.
PluginWithFormsTrait::getFormClass	public	function
PluginWithFormsTrait::hasFormClass	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.
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager	public	function	Gets the typed data manager.	2
TypedDataTrait::setTypedDataManager	public	function	Sets the typed data manager.	2

You are here

class EntityBrowserBlock in Entity Browser Block 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation