You are here

class BlockIdFormatter in Open Social 8

Same name and namespace in other branches
  1. 8.9 modules/social_features/social_landing_page/src/Plugin/Field/FieldFormatter/BlockIdFormatter.php \Drupal\social_landing_page\Plugin\Field\FieldFormatter\BlockIdFormatter
  2. 8.2 modules/social_features/social_landing_page/src/Plugin/Field/FieldFormatter/BlockIdFormatter.php \Drupal\social_landing_page\Plugin\Field\FieldFormatter\BlockIdFormatter
  3. 8.3 modules/social_features/social_landing_page/src/Plugin/Field/FieldFormatter/BlockIdFormatter.php \Drupal\social_landing_page\Plugin\Field\FieldFormatter\BlockIdFormatter
  4. 8.4 modules/social_features/social_landing_page/src/Plugin/Field/FieldFormatter/BlockIdFormatter.php \Drupal\social_landing_page\Plugin\Field\FieldFormatter\BlockIdFormatter
  5. 8.5 modules/social_features/social_landing_page/src/Plugin/Field/FieldFormatter/BlockIdFormatter.php \Drupal\social_landing_page\Plugin\Field\FieldFormatter\BlockIdFormatter
  6. 8.6 modules/social_features/social_landing_page/src/Plugin/Field/FieldFormatter/BlockIdFormatter.php \Drupal\social_landing_page\Plugin\Field\FieldFormatter\BlockIdFormatter
  7. 8.7 modules/social_features/social_landing_page/src/Plugin/Field/FieldFormatter/BlockIdFormatter.php \Drupal\social_landing_page\Plugin\Field\FieldFormatter\BlockIdFormatter
  8. 8.8 modules/social_features/social_landing_page/src/Plugin/Field/FieldFormatter/BlockIdFormatter.php \Drupal\social_landing_page\Plugin\Field\FieldFormatter\BlockIdFormatter
  9. 10.3.x modules/social_features/social_landing_page/src/Plugin/Field/FieldFormatter/BlockIdFormatter.php \Drupal\social_landing_page\Plugin\Field\FieldFormatter\BlockIdFormatter
  10. 10.0.x modules/social_features/social_landing_page/src/Plugin/Field/FieldFormatter/BlockIdFormatter.php \Drupal\social_landing_page\Plugin\Field\FieldFormatter\BlockIdFormatter
  11. 10.1.x modules/social_features/social_landing_page/src/Plugin/Field/FieldFormatter/BlockIdFormatter.php \Drupal\social_landing_page\Plugin\Field\FieldFormatter\BlockIdFormatter
  12. 10.2.x modules/social_features/social_landing_page/src/Plugin/Field/FieldFormatter/BlockIdFormatter.php \Drupal\social_landing_page\Plugin\Field\FieldFormatter\BlockIdFormatter

Plugin implementation of the 'block_field' formatter.

Plugin annotation


@FieldFormatter(
  id = "block_label",
  label = @Translation("Block label with id"),
  field_types = {
    "block_field"
  }
)

Hierarchy

Expanded class hierarchy of BlockIdFormatter

File

modules/social_features/social_landing_page/src/Plugin/Field/FieldFormatter/BlockIdFormatter.php, line 24

Namespace

Drupal\social_landing_page\Plugin\Field\FieldFormatter
View source
class BlockIdFormatter extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * The renderer service.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  private $renderer;

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountProxyInterface
   */
  protected $currentUser;

  /**
   * Construct a BlockIdFormatter object.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Any third party settings.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer service.
   * @param \Drupal\Core\Session\AccountProxyInterface $currentUser
   *   The current logged in user.
   *
   * @internal param $ |Drupal\Core\Session\AccountProxyInterface $currentUser
   *   The current user.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, RendererInterface $renderer, AccountProxyInterface $currentUser) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->renderer = $renderer;
    $this->currentUser = $currentUser;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('renderer'), $container
      ->get('current_user'));
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    foreach ($items as $delta => $item) {

      /** @var \Drupal\block_field\BlockFieldItemInterface $item */
      $block_instance = $item
        ->getBlock();

      // Make sure the block exists and is accessible.
      if (!$block_instance || !$block_instance
        ->access($this->currentUser)) {
        continue;
      }
      $elements[$delta] = [
        '#plain_text' => $block_instance
          ->label() . ' (' . $block_instance
          ->getPluginId() . ')',
      ];

      /** @var \Drupal\Core\Render\RendererInterface $renderer */
      $this->renderer
        ->addCacheableDependency($elements[$delta], $block_instance);
    }
    return $elements;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockIdFormatter::$currentUser protected property The current user.
BlockIdFormatter::$renderer private property The renderer service.
BlockIdFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
BlockIdFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
BlockIdFormatter::__construct public function Construct a BlockIdFormatter object. Overrides FormatterBase::__construct
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
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterInterface::settingsForm 24
FormatterBase::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterInterface::settingsSummary 22
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
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.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 42
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
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.