You are here

Home » API reference » Entityblock 8 » EntityBlockBlock.php

class EntityBlockBlock in Entityblock 8

Provides an entityblock block.

Plugin annotation


@Block(
 id = "entityblock_block",
 admin_label = @Translation("EntityBlock"),
 deriver = "Drupal\entityblock\Plugin\Derivative\EntityBlockContent"
)

Hierarchy

Expanded class hierarchy of EntityBlockBlock

File

src/Plugin/Block/EntityBlockBlock.php, line 30
Contains \Drupal\entityblock\Plugin\Block\EntityBlockBlock.

Namespace

Drupal\entityblock\Plugin\Block
View source 
class EntityBlockBlock extends BlockBase implements ContainerFactoryPluginInterface {

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

  /**
   * The Drupal account to use for checking for access to block.
   *
   * @var \Drupal\Core\Session\AccountInterface.
   */
  protected $account;

  /**
   * The entity repository.
   *
   * @var \Drupal\Core\Entity\EntityRepositoryInterface
   */
  protected $entityRepository;

  /**
   * Constructs a new BlockContentBlock.
   *
   * @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\EntityRepositoryInterface $entity_repository
   *   The entity repository.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, AccountInterface $account, EntityRepositoryInterface $entity_repository) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entity_type_manager;
    $this->account = $account;
    $this->entityRepository = $entity_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('current_user'), $container
      ->get('entity.repository'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $block_form = [];
    $block_form['label_override'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Override block title'),
      '#default_value' => $this->configuration['label_override'],
      '#description' => $this
        ->t('Selecting this will allow you to override the block title that is set in the EntityBlock.'),
    ];
    return $block_form;
  }

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

  /**
   * {@inheritdoc}
   */
  public function label() {
    $field_value = $this
      ->loadFieldValue();
    if ($field_value && (!isset($this->configuration['label_override']) || !$this->configuration['label_override'])) {
      $title = $field_value->title;
      $entity = $this
        ->loadEntity();
      return \Drupal::token()
        ->replace($title, [
        $entity
          ->getEntityTypeId() => $entity,
      ]);
    }
    return parent::label();
  }

  /**
   * {@inheritdoc}
   */
  public function getMachineNameSuggestion() {
    $transliterated = $this
      ->transliteration()
      ->transliterate($this
      ->label(), LanguageInterface::LANGCODE_DEFAULT, '_');
    $transliterated = Unicode::strtolower($transliterated);
    $transliterated = preg_replace('@[^a-z0-9_.]+@', '', $transliterated);
    return $transliterated;
  }

  /**
   * Helper function to load the entity of this entityblock.
   */
  private function loadEntity() {
    $key = $this
      ->getDerivativeId();
    list($field_uuid, $entity_uuid, $delta) = explode('|', $key);
    if ($field = $this
      ->loadField()) {
      return $this->entityRepository
        ->loadEntityByUuid($field
        ->getTargetEntityTypeId(), $entity_uuid);
    }
  }

  /**
   * Helper function to load the field of this entityblock.
   */
  private function loadField() {
    $key = $this
      ->getDerivativeId();
    list($field_uuid, $entity_uuid, $delta) = explode('|', $key);
    return $this->entityRepository
      ->loadEntityByUuid('field_storage_config', $field_uuid);
  }

  /**
   * Helper function to load the field value for this entityblock.
   */
  private function loadFieldValue() {
    $key = $this
      ->getDerivativeId();
    list($field_uuid, $entity_uuid, $delta) = explode('|', $key);
    $entity = $this
      ->loadEntity();
    $field = $this
      ->loadField();
    return $entity ? $entity->{$field
      ->getName()}
      ->get($delta) : NULL;
  }

  /**
   * Implements \Drupal\block\BlockBase::blockBuild().
   */
  public function build() {
    $entity = $this
      ->loadEntity();
    $field_value = $this
      ->loadFieldValue();
    if ($entity) {
      if ($field_value) {
        $content = $this->entityTypeManager
          ->getViewBuilder($entity
          ->getEntityTypeId())
          ->view($entity, $field_value->view_mode);
        $content['#title'] = $this
          ->label();
        $content['#entityblock'] = TRUE;
        return $content;
      }
      else {
        return [
          '#markup' => $this
            ->t('EntityBlock has been disabled for this <a href=":url">entity</a>.', [
            ':url' => $entity
              ->toUrl()
              ->toString(),
          ]),
          '#access' => $this->account
            ->hasPermission('administer blocks'),
        ];
      }
    }
    return [
      '#markup' => $this
        ->t('Block with key %key does not exist.', [
        '%key' => $this
          ->getDerivativeId(),
      ]),
      '#access' => $this->account
        ->hasPermission('administer blocks'),
    ];
  }

  /**
   * Implements \Drupal\block\BlockBase::access().
   */
  public function blockAccess(AccountInterface $account) {
    if ($account
      ->hasPermission('access content')) {
      $entity = $this
        ->loadEntity();
      if ($entity) {
        return $entity
          ->access('view', $account, TRUE);
      }
      return AccessResult::forbidden();
    }
  }

}

Members

Namesort descending 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::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::getPreviewFallbackString public function 3
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
EntityBlockBlock::$account protected property The Drupal account to use for checking for access to block.
EntityBlockBlock::$entityRepository protected property The entity repository.
EntityBlockBlock::$entityTypeManager protected property The entity type manager.
EntityBlockBlock::blockAccess public function Implements \Drupal\block\BlockBase::access(). Overrides BlockPluginTrait::blockAccess
EntityBlockBlock::blockForm public function Overrides BlockPluginTrait::blockForm
EntityBlockBlock::blockSubmit public function Overrides BlockPluginTrait::blockSubmit
EntityBlockBlock::build public function Implements \Drupal\block\BlockBase::blockBuild(). Overrides BlockPluginInterface::build
EntityBlockBlock::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
EntityBlockBlock::defaultConfiguration public function Overrides BlockPluginTrait::defaultConfiguration
EntityBlockBlock::getMachineNameSuggestion public function Overrides BlockPluginTrait::getMachineNameSuggestion
EntityBlockBlock::label public function Overrides BlockPluginTrait::label
EntityBlockBlock::loadEntity private function Helper function to load the entity of this entityblock.
EntityBlockBlock::loadField private function Helper function to load the field of this entityblock.
EntityBlockBlock::loadFieldValue private function Helper function to load the field value for this entityblock.
EntityBlockBlock::__construct public function Constructs a new BlockContentBlock. 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