You are here

Home » API reference » Config Pages 8.2 » ConfigPagesReferenceFieldFormatter.php

class ConfigPagesReferenceFieldFormatter in Config Pages 8.2

Plugin implementation of the 'config page entity reference' formatter.

Plugin annotation


@FieldFormatter(
  id = "cp_entity_reference_label",
  label = @Translation("Config Page entity"),
  description = @Translation("Display the referenced config page."),
  field_types = {
    "entity_reference"
  }
)

Hierarchy

Expanded class hierarchy of ConfigPagesReferenceFieldFormatter

File

src/Plugin/Field/FieldFormatter/ConfigPagesReferenceFieldFormatter.php, line 23

Namespace

Drupal\config_pages\Plugin\Field\FieldFormatter
View source 
class ConfigPagesReferenceFieldFormatter extends EntityReferenceEntityFormatter {

  /**
   * {@inheritdoc}
   */
  protected function getEntitiesToView(EntityReferenceFieldItemListInterface $items, $langcode) {
    $entities = [];
    foreach ($items as $delta => $item) {

      // Ignore items where no entity could be loaded in prepareView().
      if (empty($item->_loaded)) {
        continue;
      }
      $entity = $item->entity;
      $access = $this
        ->checkAccess($entity);

      // Add the access result's cacheability, ::view() needs it.
      $item->_accessCacheability = CacheableMetadata::createFromObject($access);
      if ($access
        ->isAllowed()) {

        // Add the referring item, in case the formatter needs it.
        $entity->_referringItem = $items[$delta];
        $configPageType = $entity
          ->id();
        $storage = $this->entityTypeManager
          ->getStorage('config_pages');
        $configPage = $storage
          ->load($configPageType);
        if ($configPage instanceof ConfigPagesInterface) {
          $entities[$delta] = $configPage;
        }
      }
    }
    return $entities;
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {

    // This formatter is only available for 'config_pages_type' target type.
    $target_type = $field_definition
      ->getFieldStorageDefinition()
      ->getSetting('target_type');
    return $target_type === 'config_pages_type';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigPagesReferenceFieldFormatter::getEntitiesToView protected function Returns the referenced entities for display. Overrides EntityReferenceFormatterBase::getEntitiesToView
ConfigPagesReferenceFieldFormatter::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides EntityReferenceEntityFormatter::isApplicable
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
EntityReferenceEntityFormatter::$entityDisplayRepository protected property The entity display repository.
EntityReferenceEntityFormatter::$entityTypeManager protected property The entity type manager.
EntityReferenceEntityFormatter::$loggerFactory protected property The logger factory.
EntityReferenceEntityFormatter::$recursiveRenderDepth protected static property An array of counters for the recursive rendering protection.
EntityReferenceEntityFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
EntityReferenceEntityFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
EntityReferenceEntityFormatter::RECURSIVE_RENDER_LIMIT constant The number of times this formatter allows rendering the same entity.
EntityReferenceEntityFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
EntityReferenceEntityFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
EntityReferenceEntityFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
EntityReferenceEntityFormatter::__construct public function Constructs a EntityReferenceEntityFormatter instance. Overrides FormatterBase::__construct
EntityReferenceFormatterBase::checkAccess protected function Checks access to the given entity. 3
EntityReferenceFormatterBase::needsEntityLoad protected function Returns whether the entity referenced by an item needs to be loaded. 1
EntityReferenceFormatterBase::prepareView public function Loads the entities referenced in that field across all the entities being viewed. Overrides FormatterBase::prepareView
EntityReferenceFormatterBase::view public function Overrides FormatterBase::view
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.
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::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.