You are here

Home » API reference » Field as Block 8 » FieldBlock.php

class FieldBlock in Field as Block 8

Same name in this branch
  1. 8 src/Plugin/Derivative/FieldBlock.php \Drupal\fieldblock\Plugin\Derivative\FieldBlock
  2. 8 src/Plugin/Block/FieldBlock.php \Drupal\fieldblock\Plugin\Block\FieldBlock
Same name and namespace in other branches
  1. 8.2 src/Plugin/Block/FieldBlock.php \Drupal\fieldblock\Plugin\Block\FieldBlock

Provides a fieldblock.

Plugin annotation


@Block(
  id = "fieldblock",
  admin_label = @Translation("Fieldblock"),
  deriver = "Drupal\fieldblock\Plugin\Derivative\FieldBlock"
)

Hierarchy

Expanded class hierarchy of FieldBlock

File

src/Plugin/Block/FieldBlock.php, line 20
Contains \Drupal\fieldblock\Plugin\Block\FieldBlock.

Namespace

Drupal\fieldblock\Plugin\Block
View source 
class FieldBlock extends BlockBase {

  /**
   * {@inheritdoc}
   */
  public function build() {
    $block_id = $this
      ->getDerivativeId();
    $block = $this::getFieldBlock($block_id);
    return $block;
  }

  /**
   * @var array[]
   *   Static storage for fields that are grabbed from the entity's render
   *   array, to be retrieved when fieldblocks are built.
   */
  protected static $fieldBlocks;

  /**
   * @param string $fieldblock_id
   *   The identifier of the fieldblock.
   * @return mixed[]|false
   *   The render array of the field that is published as block or false if the
   *   field is not available.
   */
  public static function getFieldBlock($fieldblock_id) {
    if (isset(self::$fieldBlocks[$fieldblock_id])) {
      return self::$fieldBlocks[$fieldblock_id];
    }
    else {
      return FALSE;
    }
  }

  /**
   * @param string $fieldblock_id
   *   The identifier of the fieldblock.
   * @param mixed[] $render_array
   *   The render array of the field that will be published as block.
   */
  public static function setFieldBlock($fieldblock_id, array $render_array) {
    self::$fieldBlocks[$fieldblock_id] = $render_array;
  }

  /**
   * #post_render_cache callback, temporarily stores a field's render array in a
   * static variable and returns the original element as post render cache
   * callbacks are supposed to do.
   *
   * Note that this is an atypical way to use the post render cache mechanism.
   * Post render cache is meant to allow modules to dynamically alter pieces of
   * cached content. Here we use it as some kind of context-aware cache, because
   * the cached field will only be retrieved and displayed as a block when the
   * entity is viewed.
   *
   * @param mixed[] $element
   *   The render array being rendered.
   * @param mixed[] $context
   *   Array containing the fieldblock ID and the field's render array.
   * @return mixed[]
   *   The render array being rendered.
   */
  public static function fieldBlockPostRenderCache(array $element, array $context) {
    self::setFieldBlock($context['fieldblock_id'], $context['build']);
    return $element;
  }

}

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::blockAccess protected function Indicates whether the block should be shown. 16
BlockPluginTrait::blockForm public function 16
BlockPluginTrait::blockSubmit public function 13
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::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
BlockPluginTrait::__construct public function 22
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
FieldBlock::$fieldBlocks protected static property Static storage for fields that are grabbed from the entity's render array, to be retrieved when fieldblocks are built.
FieldBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
FieldBlock::fieldBlockPostRenderCache public static function #post_render_cache callback, temporarily stores a field's render array in a static variable and returns the original element as post render cache callbacks are supposed to do.
FieldBlock::getFieldBlock public static function
FieldBlock::setFieldBlock public static function
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