class ContentItemBlock in Panopoly Widgets 8.2

Block that displays a node.

Plugin annotation


@Block(
  id = "panopoly_widgets_content_item",
  admin_label = @Translation("Content item"),
  category = @Translation("Content")
)

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\panopoly_widgets\Plugin\Block\ContentItemBlock implements ContainerFactoryPluginInterface

Expanded class hierarchy of ContentItemBlock

File

src/Plugin/Block/ContentItemBlock.php, line 26

Namespace

Drupal\panopoly_widgets\Plugin\Block

View source

class ContentItemBlock extends BlockBase implements ContainerFactoryPluginInterface {

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

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

  /**
   * Constructs a new EntityView.
   *
   * @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.
   * @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 [
      'nid' => NULL,
      'view_mode' => 'default',
    ];
  }

  /**
   * Load the configured entity.
   *
   * @return \Drupal\Core\Entity\EntityInterface|null
   *   The entity or NULL if it doesn't exist or configuration is empty.
   */
  protected function loadEntity() {
    if (!empty($this->configuration['nid'])) {
      $storage = $this->entityTypeManager
        ->getStorage('node');
      return $storage
        ->load($this->configuration['nid']);
    }
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $entity = $this
      ->loadEntity();
    $content_types = $this
      ->getContentTypes();
    $form['#attached'] = [
      'library' => [
        'panopoly_widgets/content-item',
      ],
    ];
    $form['content_type'] = [
      '#type' => 'select',
      '#options' => array_merge([
        'all' => 'Any',
      ], $content_types),
      '#title' => $this
        ->t('Content type'),
      '#default_value' => $entity ? $entity
        ->bundle() : 'all',
      '#ajax' => [
        'callback' => [
          $this,
          'autocompleteGetNodes',
        ],
      ],
    ];
    $form['node'] = [
      '#prefix' => '<div id="node-selector-wrapper">',
      '#type' => 'entity_autocomplete',
      '#title' => $this
        ->t('Piece of content'),
      '#target_type' => 'node',
      '#default_value' => $entity,
      '#required' => TRUE,
      // @todo Properly update this to any AJAX value for `content_type`.
      //   There are some complications as $form_state->getValues() breaks due
      //   to Layout Builder leveraging subform states. This requires us to
      //   use a #process callback, but that does not seem to effect the
      //   selection settings passed to the autocomplete, since AJAX was
      //   triggered by a regular element and not a button. Without a button
      //   triggering the rebuild, these changes are not respected.
      //
      //   This element needs to be rebuild with a new selection settings key in
      //   its autocomplete-path property.
      '#selection_settings' => [
        'target_bundles' => array_keys($content_types),
      ],
      '#suffix' => '</div>',
      '#attributes' => [
        'class' => [
          'js-panopoly-widgets-content-item-autocomplete',
        ],
      ],
    ];
    $form['view_mode'] = [
      '#type' => 'radios',
      '#options' => $this->entityDisplayRepository
        ->getViewModeOptions('node'),
      '#title' => $this
        ->t('View mode'),
      '#default_value' => $this->configuration['view_mode'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['label']['#attributes'] = [
      'class' => [
        'js-panopoly-widgets-content-item-label',
      ],
    ];
    return $form;
  }

  /**
   * Gets content type options.
   *
   * @return array
   *   An associative array of content types, with the machine names as the keys
   *   and human-readable names as the values.
   */
  private function getContentTypes() {
    $node_types = NodeType::loadMultiple();
    $options = [];
    foreach ($node_types as $node_type) {
      $options[$node_type
        ->id()] = $node_type
        ->label();
    }
    return $options;
  }

  /**
   * Gets AJAX response for node autocomplete.
   *
   * @return \Drupal\Core\Ajax\AjaxResponse
   *   The AJAX response.
   */
  public function autocompleteGetNodes(array &$form, FormStateInterface $form_state) {
    $response = new AjaxResponse();
    $response
      ->addCommand(new InvokeCommand(NULL, 'panopolyWidgetsCleanNodeAutoComplete', []));
    return $response;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    $this->configuration['nid'] = $form_state
      ->getValue('node');
    $this->configuration['view_mode'] = $form_state
      ->getValue('view_mode');
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $view_builder = $this->entityTypeManager
      ->getViewBuilder('node');
    $build = [];
    if ($entity = $this
      ->loadEntity()) {

      // Hide the node title because we're putting it in the block title.
      $entity->title = '';
      $build = $view_builder
        ->view($entity, $this->configuration['view_mode']);
      CacheableMetadata::createFromObject($entity)
        ->applyTo($build);
      $build['#title'] = Link::fromTextAndUrl($this->configuration['label'], $entity
        ->toUrl());
    }
    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::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
ContentItemBlock::$entityDisplayRepository	protected	property	The entity display repository.
ContentItemBlock::$entityTypeManager	protected	property	The entity type manager.
ContentItemBlock::autocompleteGetNodes	public	function	Gets AJAX response for node autocomplete.
ContentItemBlock::blockForm	public	function	Overrides BlockPluginTrait::blockForm
ContentItemBlock::blockSubmit	public	function	Overrides BlockPluginTrait::blockSubmit
ContentItemBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
ContentItemBlock::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. Overrides BlockPluginTrait::buildConfigurationForm
ContentItemBlock::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ContentItemBlock::defaultConfiguration	public	function	Overrides BlockPluginTrait::defaultConfiguration
ContentItemBlock::getContentTypes	private	function	Gets content type options.
ContentItemBlock::loadEntity	protected	function	Load the configured entity.
ContentItemBlock::__construct	public	function	Constructs a new EntityView. Overrides BlockPluginTrait::__construct
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 ContentItemBlock in Panopoly Widgets 8.2

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation