You are here

Home » API reference » Zircon Profile 8 » BlockContentBlock.php

class BlockContentBlock in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/block_content/src/Plugin/Block/BlockContentBlock.php \Drupal\block_content\Plugin\Block\BlockContentBlock

Defines a generic custom block type.

Plugin annotation


@Block(
 id = "block_content",
 admin_label = @Translation("Custom block"),
 category = @Translation("Custom"),
 deriver = "Drupal\block_content\Plugin\Derivative\BlockContent"
)

Hierarchy

Expanded class hierarchy of BlockContentBlock

File

core/modules/block_content/src/Plugin/Block/BlockContentBlock.php, line 30
Contains \Drupal\block_content\Plugin\Block\BlockContentBlock.

Namespace

Drupal\block_content\Plugin\Block
View source 
class BlockContentBlock extends BlockBase implements ContainerFactoryPluginInterface {

  /**
   * The Plugin Block Manager.
   *
   * @var \Drupal\Core\Block\BlockManagerInterface.
   */
  protected $blockManager;

  /**
   * The entity manager service.
   *
   * @var \Drupal\Core\Entity\EntityManagerInterface
   */
  protected $entityManager;

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

  /**
   * The block content entity.
   *
   * @var \Drupal\block_content\BlockContentInterface
   */
  protected $blockContent;

  /**
   * The URL generator.
   *
   * @var \Drupal\Core\Routing\UrlGeneratorInterface
   */
  protected $urlGenerator;

  /**
   * 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\Block\BlockManagerInterface $block_manager
   *   The Plugin Block Manager.
   * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
   *   The entity manager service.
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The account for which view access should be checked.
   * @param \Drupal\Core\Routing\UrlGeneratorInterface $url_generator
   *   The URL generator.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, BlockManagerInterface $block_manager, EntityManagerInterface $entity_manager, AccountInterface $account, UrlGeneratorInterface $url_generator) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->blockManager = $block_manager;
    $this->entityManager = $entity_manager;
    $this->account = $account;
    $this->urlGenerator = $url_generator;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('plugin.manager.block'), $container
      ->get('entity.manager'), $container
      ->get('current_user'), $container
      ->get('url_generator'));
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return array(
      'status' => TRUE,
      'info' => '',
      'view_mode' => 'full',
    );
  }

  /**
   * Overrides \Drupal\Core\Block\BlockBase::blockForm().
   *
   * Adds body and description fields to the block configuration form.
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $uuid = $this
      ->getDerivativeId();
    $block = $this->entityManager
      ->loadEntityByUuid('block_content', $uuid);
    $options = $this->entityManager
      ->getViewModeOptionsByBundle('block_content', $block
      ->bundle());
    $form['view_mode'] = array(
      '#type' => 'select',
      '#options' => $options,
      '#title' => $this
        ->t('View mode'),
      '#description' => $this
        ->t('Output the block in this view mode.'),
      '#default_value' => $this->configuration['view_mode'],
      '#access' => count($options) > 1,
    );
    $form['title']['#description'] = $this
      ->t('The title of the block as shown to the user.');
    return $form;
  }

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

    // Invalidate the block cache to update custom block-based derivatives.
    $this->configuration['view_mode'] = $form_state
      ->getValue('view_mode');
    $this->blockManager
      ->clearCachedDefinitions();
  }

  /**
   * {@inheritdoc}
   */
  protected function blockAccess(AccountInterface $account) {
    if ($this
      ->getEntity()) {
      return $this
        ->getEntity()
        ->access('view', $account, TRUE);
    }
    return AccessResult::forbidden();
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    if ($block = $this
      ->getEntity()) {
      return $this->entityManager
        ->getViewBuilder($block
        ->getEntityTypeId())
        ->view($block, $this->configuration['view_mode']);
    }
    else {
      return array(
        '#markup' => $this
          ->t('Block with uuid %uuid does not exist. <a href=":url">Add custom block</a>.', array(
          '%uuid' => $this
            ->getDerivativeId(),
          ':url' => $this->urlGenerator
            ->generate('block_content.add_page'),
        )),
        '#access' => $this->account
          ->hasPermission('administer blocks'),
      );
    }
  }

  /**
   * Loads the block content entity of the block.
   *
   * @return \Drupal\block_content\BlockContentInterface|null
   *   The block content entity.
   */
  protected function getEntity() {
    $uuid = $this
      ->getDerivativeId();
    if (!isset($this->blockContent)) {
      $this->blockContent = $this->entityManager
        ->loadEntityByUuid('block_content', $uuid);
    }
    return $this->blockContent;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockBase::$transliteration protected property The transliteration service.
BlockBase::access public function Indicates whether the block should be shown. Overrides BlockPluginInterface::access
BlockBase::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockBase::blockValidate public function Adds block type-specific validation for the block form. Overrides BlockPluginInterface::blockValidate 1
BlockBase::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 PluginFormInterface::buildConfigurationForm 1
BlockBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
BlockBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurablePluginInterface::getConfiguration 1
BlockBase::getMachineNameSuggestion public function Suggests a machine name to identify an instance of this block. Overrides BlockPluginInterface::getMachineNameSuggestion 1
BlockBase::label public function Returns the user-facing block label. Overrides BlockPluginInterface::label
BlockBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface::setConfiguration
BlockBase::setConfigurationValue public function Sets a particular value in the block settings. Overrides BlockPluginInterface::setConfigurationValue
BlockBase::setTransliteration public function Sets the transliteration service.
BlockBase::submitConfigurationForm public function Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit(). Overrides PluginFormInterface::submitConfigurationForm
BlockBase::transliteration protected function Wraps the transliteration service.
BlockBase::validateConfigurationForm public function Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate(). Overrides PluginFormInterface::validateConfigurationForm
BlockContentBlock::$account protected property The Drupal account to use for checking for access to block.
BlockContentBlock::$blockContent protected property The block content entity.
BlockContentBlock::$blockManager protected property The Plugin Block Manager.
BlockContentBlock::$entityManager protected property The entity manager service.
BlockContentBlock::$urlGenerator protected property The URL generator.
BlockContentBlock::blockAccess protected function Indicates whether the block should be shown. Overrides BlockBase::blockAccess
BlockContentBlock::blockForm public function Overrides \Drupal\Core\Block\BlockBase::blockForm(). Overrides BlockBase::blockForm
BlockContentBlock::blockSubmit public function Adds block type-specific submission handling for the block form. Overrides BlockBase::blockSubmit
BlockContentBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
BlockContentBlock::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
BlockContentBlock::defaultConfiguration public function Gets default configuration for this plugin. Overrides BlockBase::defaultConfiguration
BlockContentBlock::getEntity protected function Loads the block content entity of the block.
BlockContentBlock::__construct public function Constructs a new BlockContentBlock. Overrides BlockBase::__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.
ContextAwarePluginAssignmentTrait::t abstract protected function Ensures the t() method is available.
ContextAwarePluginBase::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginBase::createContextFromConfiguration protected function Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts public function 9
ContextAwarePluginBase::getCacheMaxAge public function 7
ContextAwarePluginBase::getCacheTags public function 4
ContextAwarePluginBase::getContext public function 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
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
PluginBase::$configuration protected property Configuration information passed into the plugin. 2
PluginBase::$pluginDefinition protected property The plugin implementation definition.
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
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
StringTranslationTrait::$stringTranslation protected property The string translation service.
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
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 1
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 1