class FileFormatterBase

Same name and namespace in other branches
  1. 11.x core/modules/file/src/Plugin/Field/FieldFormatter/FileFormatterBase.php \Drupal\file\Plugin\Field\FieldFormatter\FileFormatterBase

Base class for file formatters.

Hierarchy

Expanded class hierarchy of FileFormatterBase

1 file declares its use of FileFormatterBase
ImageFormatterBase.php in core/modules/image/src/Plugin/Field/FieldFormatter/ImageFormatterBase.php

File

core/modules/file/src/Plugin/Field/FieldFormatter/FileFormatterBase.php, line 13

Namespace

Drupal\file\Plugin\Field\FieldFormatter
View on git.drupalcode.org
View source 
abstract class FileFormatterBase extends EntityReferenceFormatterBase {
  
  /**
   * {@inheritdoc}
   */
  protected function needsEntityLoad(EntityReferenceItem $item) {
    return parent::needsEntityLoad($item) && $item->isDisplayed();
  }
  
  /**
   * {@inheritdoc}
   */
  protected function checkAccess(EntityInterface $entity) {
    // Only check access if the current file access control handler explicitly
    // opts in by implementing FileAccessFormatterControlHandlerInterface.
    $access_handler_class = $entity->getEntityType()
      ->getHandlerClass('access');
    if (is_subclass_of($access_handler_class, '\\Drupal\\file\\FileAccessFormatterControlHandlerInterface')) {
      return $entity->access('view', NULL, TRUE);
    }
    else {
      return AccessResult::allowed();
    }
  }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
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
DependencySerializationTrait::__wakeup public function #[\ReturnTypeWillChange]
EntityReferenceFormatterBase::getEntitiesToView protected function Returns the referenced entities for display.
EntityReferenceFormatterBase::prepareView public function Loads the entities referenced in that field across all the entities being
viewed.
EntityReferenceFormatterBase::view public function
FileFormatterBase::checkAccess protected function Checks access to the given entity. Overrides EntityReferenceFormatterBase::checkAccess 1
FileFormatterBase::checkAccess protected function Checks access to the given entity. Overrides EntityReferenceFormatterBase::checkAccess 1
FileFormatterBase::needsEntityLoad protected function Returns whether the entity referenced by an item needs to be loaded. Overrides EntityReferenceFormatterBase::needsEntityLoad 1
FileFormatterBase::needsEntityLoad protected function Returns whether the entity referenced by an item needs to be loaded. Overrides EntityReferenceFormatterBase::needsEntityLoad 1
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings.
FormatterBase::$viewMode protected property The view mode.
FormatterBase::create public static function 3
FormatterBase::create public static function 3
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 7
FormatterBase::isApplicable public static function 7
FormatterBase::settingsForm public function 12
FormatterBase::settingsForm public function 12
FormatterBase::settingsSummary public function 10
FormatterBase::settingsSummary public function 10
FormatterBase::__construct public function Constructs a FormatterBase object. 3
FormatterBase::__construct public function Constructs a FormatterBase object. 3
FormatterInterface::viewElements public function Builds a renderable array for a field value. 19
FormatterInterface::viewElements public function Builds a renderable array for a field value. 19
MessengerTrait::$messenger protected property The messenger. 7
MessengerTrait::$messenger protected property The messenger. 7
MessengerTrait::messenger public function Gets the messenger. 7
MessengerTrait::messenger public function Gets the messenger. 7
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin.
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
PluginBase::getDerivativeId public function
PluginBase::getPluginDefinition public function 1
PluginBase::getPluginDefinition public function 1
PluginBase::getPluginId public function
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 2
PluginSettingsBase::calculateDependencies public function 2
PluginSettingsBase::defaultSettings public static function 18
PluginSettingsBase::defaultSettings public static function 18
PluginSettingsBase::getSetting public function
PluginSettingsBase::getSettings public function
PluginSettingsBase::getThirdPartyProviders public function
PluginSettingsBase::getThirdPartySetting public function
PluginSettingsBase::getThirdPartySettings public function
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function 1
PluginSettingsBase::onDependencyRemoval public function 1
PluginSettingsBase::setSetting public function
PluginSettingsBase::setSettings public function
PluginSettingsBase::setThirdPartySetting public function
PluginSettingsBase::unsetThirdPartySetting public function
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.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.