class ContentEmbedBlock in Content Browser 8

Provides the "Content Embed" block.

Plugin annotation


@Block(
  id = "content_embed",
  admin_label = @Translation("Content Embed"),
  category = @Translation("Embed")
)

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\content_browser\Plugin\Block\ContentEmbedBlock

Expanded class hierarchy of ContentEmbedBlock

File

src/Plugin/Block/ContentEmbedBlock.php, line 20

Namespace

Drupal\content_browser\Plugin\Block

View source

class ContentEmbedBlock extends BlockBase {

  /**
   * 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 = [];

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'view_mode' => '',
      'nids' => [],
      'uuids' => [],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {

    // This method receives a sub form state instead of the full form state.
    // There is an ongoing discussion around this which could result in the
    // passed form state going back to a full form state. In order to prevent
    // future breakage because of a core update we'll just check which type of
    // FormStateInterface we've been passed and act accordingly.
    // @See https://www.drupal.org/node/2798261
    if ($form_state instanceof SubformStateInterface) {
      $form_state = $form_state
        ->getCompleteFormState();
    }
    $entities = $form_state
      ->getValue([
      'settings',
      'selection',
      'nids',
      'entities',
    ], []);
    $nids = [];
    foreach ($entities as $entity) {
      $nids[] = $entity
        ->id();
    }
    if (empty($nids)) {
      $nids = $this
        ->getDefaultNids();
    }
    $form['selection'] = $this
      ->browserForm($nids);

    /** @var \Drupal\Core\Entity\EntityDisplayRepository $entity_display_repository */
    $entity_display_repository = \Drupal::service('entity_display.repository');
    $view_mode_options = $entity_display_repository
      ->getViewModeOptions('node');
    $form['view_mode'] = [
      '#type' => 'select',
      '#options' => $view_mode_options,
      '#title' => t('View mode'),
      '#default_value' => $this->configuration['view_mode'],
    ];
    return $form;
  }

  /**
   * Constructs parts of the form needed to use Entity Browser.
   *
   * @param array $nids
   *   An array of Node IDs.
   *
   * @return array
   *   A render array representing Entity Browser components.
   */
  public function browserForm(array $nids) {
    $selection = [
      '#type' => 'container',
      '#attributes' => [
        'id' => 'content-embed-block-browser',
      ],
    ];
    $selection['nids'] = [
      '#type' => 'entity_browser',
      '#entity_browser' => 'browse_content',
      '#entity_browser_validators' => [
        'entity_type' => [
          'type' => 'node',
        ],
      ],
      '#process' => [
        [
          '\\Drupal\\entity_browser\\Element\\EntityBrowserElement',
          'processEntityBrowser',
        ],
        [
          get_called_class(),
          'processEntityBrowser',
        ],
      ],
    ];
    $order_class = 'content-embed-block-delta-order';
    $selection['table'] = [
      '#type' => 'table',
      '#header' => [
        t('Title'),
        t('Type'),
        t('Order', [], [
          'context' => 'Sort order',
        ]),
      ],
      '#empty' => t('No content yet'),
      '#tabledrag' => [
        [
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => $order_class,
        ],
      ],
    ];
    $delta = 0;
    $bundle_info = \Drupal::service('entity_type.bundle.info')
      ->getBundleInfo('node');
    foreach ($nids as $nid) {

      /** @var \Drupal\node\Entity\Node $node */
      $node = Node::load($nid);
      $selection['table'][$nid] = [
        '#attributes' => [
          'class' => [
            'draggable',
          ],
          'data-entity-id' => $node
            ->getEntityTypeId() . ':' . $nid,
        ],
        'title' => [
          '#markup' => $node
            ->label(),
        ],
        'type' => [
          '#markup' => $bundle_info[$node
            ->bundle()]['label'],
        ],
        '_weight' => [
          '#type' => 'weight',
          '#title' => t('Weight for row @number', [
            '@number' => $delta + 1,
          ]),
          '#title_display' => 'invisible',
          '#delta' => count($nids),
          '#default_value' => $delta,
          '#attributes' => [
            'class' => [
              $order_class,
            ],
          ],
        ],
      ];
      $delta++;
    }
    return $selection;
  }

  /**
   * AJAX callback: Re-renders the Entity Browser button/table.
   */
  public static function updateCallback(array &$form, FormStateInterface $form_state) {
    $trigger = $form_state
      ->getTriggeringElement();
    $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' => [
        get_called_class(),
        'updateCallback',
      ],
      'wrapper' => 'content-embed-block-browser',
      'event' => 'entity_browser_value_updated',
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this->configuration['nids'] = [];
    $this->configuration['uuids'] = [];
    foreach ($form_state
      ->getValue([
      'selection',
      'table',
    ], []) as $nid => $settings) {
      $this->configuration['nids'][] = $nid;
    }
    $this->configuration['view_mode'] = $form_state
      ->getValue('view_mode');
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $build = [];
    $view_builder = \Drupal::entityTypeManager()
      ->getViewBuilder('node');
    foreach ($this
      ->getDefaultNids() as $nid) {

      /** @var \Drupal\node\Entity\Node $node */
      $node = Node::load($nid);
      if ($node && $node
        ->access('view')) {
        if (isset(static::$recursiveRenderDepth[$nid])) {
          static::$recursiveRenderDepth[$nid]++;
        }
        else {
          static::$recursiveRenderDepth[$nid] = 1;
        }

        // Protect ourselves from recursive rendering.
        if (static::$recursiveRenderDepth[$nid] > static::RECURSIVE_RENDER_LIMIT) {
          return $build;
        }
        $build[] = $view_builder
          ->view($node, $this->configuration['view_mode']);
      }
    }
    return $build;
  }

  /**
   * Gets the default NIDs for this Block.
   *
   * @return array
   *   An array of Node IDs that are currently set in the Block configuration.
   */
  protected function getDefaultNids() {

    // We optionally support UUIDs being put directly to our configuration, to
    // support profiles providing Content Embed Blocks with default config.
    if (!empty($this->configuration['uuids'])) {
      $nids = \Drupal::entityQuery('node')
        ->condition('uuid', $this->configuration['uuids'], 'IN')
        ->execute();
    }
    else {
      $nids = [];
    }

    // Merge in the normal configuration.
    $nids += $this->configuration['nids'];
    return $nids;
  }

}

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
BlockPluginTrait::__construct	public	function		22
ContentEmbedBlock::$recursiveRenderDepth	protected static	property	An array of counters for the recursive rendering protection.
ContentEmbedBlock::blockForm	public	function	Overrides BlockPluginTrait::blockForm
ContentEmbedBlock::blockSubmit	public	function	Overrides BlockPluginTrait::blockSubmit
ContentEmbedBlock::browserForm	public	function	Constructs parts of the form needed to use Entity Browser.
ContentEmbedBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
ContentEmbedBlock::defaultConfiguration	public	function	Overrides BlockPluginTrait::defaultConfiguration
ContentEmbedBlock::getDefaultNids	protected	function	Gets the default NIDs for this Block.
ContentEmbedBlock::processEntityBrowser	public static	function	Render API callback: Processes the entity browser element.
ContentEmbedBlock::RECURSIVE_RENDER_LIMIT		constant	The number of times this block allows rendering the same entity.
ContentEmbedBlock::updateCallback	public static	function	AJAX callback: Re-renders the Entity Browser button/table.
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
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 ContentEmbedBlock in Content Browser 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation