class QuickNodeBlock in Quick Node Block 8

Provides a Node Block with his display.

Plugin annotation


@Block(
  id = "quick_node_block",
  admin_label = @Translation("Quick Node Block"),
  category = @Translation("Quick Node Block"),
)

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\quick_node_block\Plugin\Block\QuickNodeBlock implements ContainerFactoryPluginInterface

Expanded class hierarchy of QuickNodeBlock

File

src/Plugin/Block/QuickNodeBlock.php, line 23

Namespace

Drupal\quick_node_block\Plugin\Block

View source

class QuickNodeBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * The route match service.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

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

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

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

  /**
   * This function construct a block.
   *
   * @param array $configuration
   *   The plugin configuration, i.e. an array with configuration values keyed
   *   by configuration option name. The special key 'context' may be used to
   *   initialize the defined contexts by setting it to an array of context
   *   values keyed by context names.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Routing\RouteMatchInterface $routeMatch
   *   The The route match service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   *   The entity manager service.
   * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entityDisplay
   *   The entity display repository.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, RouteMatchInterface $routeMatch, EntityTypeManagerInterface $entityTypeManager, EntityDisplayRepositoryInterface $entityDisplay) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->routeMatch = $routeMatch;
    $this->entityTypeManager = $entityTypeManager;
    $this->entityDisplay = $entityDisplay;
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form = parent::blockForm($form, $form_state);
    $config = $this
      ->getConfiguration();
    $form['quick_node'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Node'),
      '#description' => $this
        ->t('What node do you want to show? You can write a node number or node title.'),
      '#required' => TRUE,
      '#autocomplete_route_name' => 'quick_node_block.autocomplete',
      '#default_value' => $config['quick_node'] ?? '',
      '#ajax' => [
        'wrapper' => 'quick-ajax-wrapper',
        'callback' => [
          $this,
          'ajaxCallback',
        ],
        'disable-refocus' => TRUE,
      ],
    ];

    // Get node from the url.
    $nid_add = $this->routeMatch
      ->getParameter('node');

    // Check if there is a node selected.
    $element = $form_state
      ->getTriggeringElement();
    if (!empty($element['#value'])) {
      $node_title = $element['#value'];
    }
    elseif (!empty($nid_add)) {

      // Default value when creating the block from the node.
      $node = $this->entityTypeManager
        ->getStorage('node')
        ->load($nid_add);
      $node_title = $node
        ->getTitle() . ' (' . $nid_add . ')';
      $form['quick_node']['#default_value'] = $node_title;
      $form['quick_node']['#attributes']['disabled'] = TRUE;
    }
    else {
      $node_title = $config['quick_node'] ?? '';
    }

    // Get nid.
    preg_match("/.+\\s\\(([^\\)]+)\\)/", $node_title, $matches);
    $nid = $matches[1] ?? '';
    if (empty($nid)) {
      $quick_display = $this
        ->getQuickDisplays();
    }
    else {

      // Get bundle.
      $storage = $this->entityTypeManager
        ->getStorage('node');
      $node = $storage
        ->load($nid);
      $content_type = $node
        ->getType();

      // Get view mode.
      $quick_display = $this->entityDisplay
        ->getViewModeOptionsByBundle('node', $content_type);
    }
    $form['quick_display'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Display'),
      '#description' => $this
        ->t('How do you want the node to be displayed?. You must first choose a node.'),
      '#required' => TRUE,
      '#options' => $quick_display,
      '#default_value' => $config['quick_display'] ?? '',
      '#prefix' => '<div id="quick-ajax-wrapper">',
      '#suffix' => '</div>',
      // Hide field if quick_node is empty.
      '#states' => [
        'visible' => [
          ':input[name$="[quick_node]"]' => [
            [
              'empty' => FALSE,
            ],
          ],
        ],
      ],
    ];
    return $form;
  }

  /**
   * Updates the options of a select list.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return array
   *   The updated form element.
   */
  public function ajaxCallback(array $form, FormStateInterface $form_state) {

    // Get the currently selected node.
    $element = $form_state
      ->getTriggeringElement();
    $node_title = $element['#value'];

    // Get nid.
    preg_match("/.+\\s\\(([^\\)]+)\\)/", $node_title, $matches);
    $nid = $matches[1];

    // Get bundle.
    $storage = $this->entityTypeManager
      ->getStorage('node');
    $node = $storage
      ->load($nid);
    $content_type = $node
      ->getType();

    // Get view mode.
    $view_mode = $this->entityDisplay
      ->getViewModeOptionsByBundle('node', $content_type);
    $form['settings']['quick_display']['#options'] = $view_mode;
    return $form['settings']['quick_display'];
  }

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

    // Get quick_node value.
    $node_title = $form_state
      ->getValue('quick_node');

    // Get nid.
    preg_match("/.+\\s\\(([^\\)]+)\\)/", $node_title, $matches);
    $nid = $matches[1];

    // Check if the node exists.
    $query = $this->entityTypeManager
      ->getStorage('node')
      ->getQuery();
    $values = $query
      ->condition('nid', $nid)
      ->execute();
    if (empty($values)) {
      $form_state
        ->setErrorByName('quick_node', $this
        ->t('The chosen node does not exist. Choose another one please.'));
    }
    return $form_state;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    parent::blockSubmit($form, $form_state);
    $values = $form_state
      ->getValues();

    // @todo: Don't save the node as a string (title + nid) but rather as nid.
    $this->configuration['quick_node'] = $values['quick_node'];
    $this->configuration['quick_display'] = $values['quick_display'];
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $build = [];
    $config = $this
      ->getConfiguration();
    if (preg_match("/.+\\s\\(([^\\)]+)\\)/", $config['quick_node'], $matches)) {
      $nid = $matches[1];
      $view_mode = $config['quick_display'];
      $entity_type = 'node';
      $view_builder = $this->entityTypeManager
        ->getViewBuilder($entity_type);
      $storage = $this->entityTypeManager
        ->getStorage($entity_type);
      if ($node = $storage
        ->load($nid)) {
        $build = $view_builder
          ->view($node, $view_mode);
      }
    }
    return $build;
  }

  /**
   * Show all display modes of content.
   */
  protected function getQuickDisplays() {
    return $this->entityDisplay
      ->getViewModeOptions('node');
  }

  /**
   * Cache block.
   */
  public function getCacheTags() {
    $config = $this
      ->getConfiguration();
    if (isset($config['quick_node'])) {
      preg_match("/.+\\s\\(([^\\)]+)\\)/", $config['quick_node'], $matches);
      $nid = $matches[1];
      return Cache::mergeTags(parent::getCacheTags(), [
        "node:{$nid}",
      ]);
    }
    return parent::getCacheTags();
  }

}

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::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::defaultConfiguration	public	function		19
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::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
QuickNodeBlock::$entityDisplay	protected	property	The entity display repository.
QuickNodeBlock::$entityTypeManager	protected	property	The entity manager type service.
QuickNodeBlock::$routeMatch	protected	property	The route match service.
QuickNodeBlock::ajaxCallback	public	function	Updates the options of a select list.
QuickNodeBlock::blockForm	public	function	Overrides BlockPluginTrait::blockForm
QuickNodeBlock::blockSubmit	public	function	Overrides BlockPluginTrait::blockSubmit
QuickNodeBlock::blockValidate	public	function	Overrides BlockPluginTrait::blockValidate
QuickNodeBlock::build	public	function	Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
QuickNodeBlock::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
QuickNodeBlock::getCacheTags	public	function	Cache block. Overrides ContextAwarePluginBase::getCacheTags
QuickNodeBlock::getQuickDisplays	protected	function	Show all display modes of content.
QuickNodeBlock::__construct	public	function	This function construct a block. Overrides BlockPluginTrait::__construct
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 QuickNodeBlock in Quick Node Block 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation