class TestFieldApplicableFormatter

Same name and namespace in other branches
  1. 11.x core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldFormatter/TestFieldApplicableFormatter.php \Drupal\field_test\Plugin\Field\FieldFormatter\TestFieldApplicableFormatter

Plugin implementation of the 'field_test_applicable' formatter.

It is applicable to test_field fields unless their name is 'deny_applicable'.

Plugin annotation


@FieldFormatter(
  id = "field_test_applicable",
  label = @Translation("Applicable"),
  description = @Translation("Applicable formatter"),
  field_types = {
    "test_field"
  },
  weight = 15,
)

Hierarchy

Expanded class hierarchy of TestFieldApplicableFormatter

File

core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldFormatter/TestFieldApplicableFormatter.php, line 24

Namespace

Drupal\field_test\Plugin\Field\FieldFormatter
View source
class TestFieldApplicableFormatter extends FormatterBase {
  
  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    return $field_definition->getName() != 'deny_applicable';
  }
  
  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    return [
      '#markup' => 'Nothing to see here',
    ];
  }

}

Members

Title Sort descending 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]
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::prepareView public function 1
FormatterBase::prepareView public function 1
FormatterBase::settingsForm public function 12
FormatterBase::settingsForm public function 12
FormatterBase::settingsSummary public function 10
FormatterBase::settingsSummary public function 10
FormatterBase::view public function
FormatterBase::__construct public function Constructs a FormatterBase object. 3
FormatterBase::__construct public function Constructs a FormatterBase object. 3
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.
TestFieldApplicableFormatter::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
TestFieldApplicableFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements

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