BlockPluginTrait.php

<?php

namespace Drupal\Core\Block;

use Drupal\Component\Transliteration\TransliterationInterface;
use Drupal\Component\Utility\NestedArray;
use Drupal\Core\Access\AccessResult;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Language\LanguageInterface;
use Drupal\Core\Messenger\MessengerTrait;
use Drupal\Core\Plugin\PluginWithFormsTrait;
use Drupal\Core\Session\AccountInterface;
use Drupal\Core\StringTranslation\StringTranslationTrait;

/**
 * Provides the base implementation of a block plugin.
 *
 * @internal
 *   This trait is used internally by the block system. Block plugins should
 *   extend \Drupal\Core\Block\BlockBase.
 *
 * @see \Drupal\Core\Block\BlockBase
 * @see \Drupal\Core\Block\BlockPluginInterface
 *
 * @ingroup block_api
 */
trait BlockPluginTrait {
    use StringTranslationTrait;
    use MessengerTrait;
    use PluginWithFormsTrait;
    
    /**
     * Whether the plugin is being rendered in preview mode.
     *
     * @var bool
     */
    protected $inPreview = FALSE;
    
    /**
     * The transliteration service.
     *
     * @var \Drupal\Component\Transliteration\TransliterationInterface
     */
    protected $transliteration;
    
    /**
     * {@inheritdoc}
     */
    public function label() {
        if (!empty($this->configuration['label'])) {
            return $this->configuration['label'];
        }
        $definition = $this->getPluginDefinition();
        // Cast the admin label to a string since it is an object.
        // @see \Drupal\Core\StringTranslation\TranslatableMarkup
        return (string) $definition['admin_label'];
    }
    
    /**
     * {@inheritdoc}
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->setConfiguration($configuration);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConfiguration() {
        return $this->configuration;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setConfiguration(array $configuration) {
        $this->configuration = NestedArray::mergeDeep($this->baseConfigurationDefaults(), $this->defaultConfiguration(), $configuration);
    }
    
    /**
     * Returns generic default configuration for block plugins.
     *
     * @return array
     *   An associative array with the default configuration.
     */
    protected function baseConfigurationDefaults() {
        return [
            'id' => $this->getPluginId(),
            'label' => '',
            'label_display' => BlockPluginInterface::BLOCK_LABEL_VISIBLE,
            'provider' => $this->pluginDefinition['provider'],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public function defaultConfiguration() {
        return [];
    }
    
    /**
     * {@inheritdoc}
     */
    public function setConfigurationValue($key, $value) {
        $this->configuration[$key] = $value;
    }
    
    /**
     * {@inheritdoc}
     */
    public function calculateDependencies() {
        return [];
    }
    
    /**
     * {@inheritdoc}
     */
    public function access(AccountInterface $account, $return_as_object = FALSE) {
        $access = $this->blockAccess($account);
        return $return_as_object ? $access : $access->isAllowed();
    }
    
    /**
     * Indicates whether the block should be shown.
     *
     * Blocks with specific access checking should override this method rather
     * than access(), in order to avoid repeating the handling of the
     * $return_as_object argument.
     *
     * @param \Drupal\Core\Session\AccountInterface $account
     *   The user session for which to check access.
     *
     * @return \Drupal\Core\Access\AccessResultInterface
     *   The access result.
     *
     * @see self::access()
     */
    protected function blockAccess(AccountInterface $account) {
        // By default, the block is visible.
        return AccessResult::allowed();
    }
    
    /**
     * {@inheritdoc}
     *
     * 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.
     *
     * @see \Drupal\Core\Block\BlockBase::blockForm()
     */
    public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
        $definition = $this->getPluginDefinition();
        $form['provider'] = [
            '#type' => 'value',
            '#value' => $definition['provider'],
        ];
        $form['admin_label'] = [
            '#type' => 'item',
            '#title' => $this->t('Block description'),
            '#plain_text' => $definition['admin_label'],
        ];
        $form['label'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Title'),
            '#maxlength' => 255,
            '#default_value' => $this->label(),
            '#required' => TRUE,
        ];
        $form['label_display'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Display title'),
            '#default_value' => $this->configuration['label_display'] === BlockPluginInterface::BLOCK_LABEL_VISIBLE,
            '#return_value' => BlockPluginInterface::BLOCK_LABEL_VISIBLE,
        ];
        // Add plugin-specific settings for this block type.
        $form += $this->blockForm($form, $form_state);
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function blockForm($form, FormStateInterface $form_state) {
        return [];
    }
    
    /**
     * {@inheritdoc}
     *
     * Most block plugins should not override this method. To add validation
     * for a specific block type, override BlockBase::blockValidate().
     *
     * @see \Drupal\Core\Block\BlockBase::blockValidate()
     */
    public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
        // Remove the admin_label form item element value so it will not persist.
        $form_state->unsetValue('admin_label');
        $this->blockValidate($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function blockValidate($form, FormStateInterface $form_state) {
    }
    
    /**
     * {@inheritdoc}
     *
     * Most block plugins should not override this method. To add submission
     * handling for a specific block type, override BlockBase::blockSubmit().
     *
     * @see \Drupal\Core\Block\BlockBase::blockSubmit()
     */
    public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
        // Process the block's submission handling if no errors occurred only.
        if (!$form_state->getErrors()) {
            $this->configuration['label'] = $form_state->getValue('label');
            $this->configuration['label_display'] = $form_state->getValue('label_display');
            $this->configuration['provider'] = $form_state->getValue('provider');
            $this->blockSubmit($form, $form_state);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function blockSubmit($form, FormStateInterface $form_state) {
    }
    
    /**
     * {@inheritdoc}
     */
    public function getMachineNameSuggestion() {
        $definition = $this->getPluginDefinition();
        $admin_label = $definition['admin_label'];
        // @todo This is basically the same as what is done in
        //   \Drupal\system\MachineNameController::transliterate(), so it might make
        //   sense to provide a common service for the two.
        $transliterated = $this->transliteration()
            ->transliterate($admin_label, LanguageInterface::LANGCODE_DEFAULT, '_');
        $transliterated = mb_strtolower($transliterated);
        $transliterated = preg_replace('@[^a-z0-9_.]+@', '', $transliterated);
        return $transliterated;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getPreviewFallbackString() {
        return $this->t('"@block" block', [
            '@block' => $this->label(),
        ]);
    }
    
    /**
     * Wraps the transliteration service.
     *
     * @return \Drupal\Component\Transliteration\TransliterationInterface
     */
    protected function transliteration() {
        if (!$this->transliteration) {
            $this->transliteration = \Drupal::transliteration();
        }
        return $this->transliteration;
    }
    
    /**
     * Sets the transliteration service.
     *
     * @param \Drupal\Component\Transliteration\TransliterationInterface $transliteration
     *   The transliteration service.
     */
    public function setTransliteration(TransliterationInterface $transliteration) {
        $this->transliteration = $transliteration;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setInPreview(bool $in_preview) : void {
        $this->inPreview = $in_preview;
    }

}