You are here

Home » API reference » Formatter Field 8 » FromFieldFormatter.php

class FromFieldFormatter in Formatter Field 8

Plugin implementation of the 'formatter_field' formatter.

Plugin annotation


@FieldFormatter(
  id = "formatter_field_from",
  label = @Translation("Formatter from field"),
  field_types = {}
)

Hierarchy

Expanded class hierarchy of FromFieldFormatter

See also

formatter_field_field_formatter_info_alter()

File

src/Plugin/Field/FieldFormatter/FromFieldFormatter.php, line 24

Namespace

Drupal\formatter_field\Plugin\Field\FieldFormatter
View source 
class FromFieldFormatter extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * Formatter plugin manager.
   *
   * @var \Drupal\Core\Field\FormatterPluginManager
   */
  protected $formatterManager;

  /**
   * Entity field manager.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $fieldManager;

  /**
   * Constructs a new ModerationStateWidget 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\Field\FormatterPluginManager $formatter_manager
   *   Formatter plugin manager.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $field_manager
   *   Entity field manager.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, FormatterPluginManager $formatter_manager, EntityFieldManagerInterface $field_manager) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->formatterManager = $formatter_manager;
    $this->fieldManager = $field_manager;
  }

  /**
   * {@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('plugin.manager.field.formatter'), $container
      ->get('entity_field.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function prepareView(array $entities_items) {
    if ($formatter = $this
      ->getFormatter($entities_items[0])) {
      $formatter
        ->prepareView($entities_items);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    if ($formatter = $this
      ->getFormatter($items)) {
      return $formatter
        ->viewElements($items, $langcode);
    }
    return [];
  }

  /**
   * Creates an appropriate formatter for the field.
   *
   * @param \Drupal\Core\Field\FieldItemListInterface $items
   *   The field values to be rendered.
   *
   * @return \Drupal\Core\Field\FormatterInterface|null|void
   *   A formatter object or null when plugin is not found.
   */
  protected function getFormatter(FieldItemListInterface $items) {
    $definitions = $this->fieldManager
      ->getFieldDefinitions($this->fieldDefinition
      ->getTargetEntityTypeId(), $this->fieldDefinition
      ->getTargetBundle());
    $target_field_name = $this->fieldDefinition
      ->getName();
    $target_definition = $definitions[$target_field_name];
    $formatter_field = NULL;
    foreach ($definitions as $field_name => $definition) {
      if ($definition
        ->getType() == 'formatter_field_formatter' && $definition
        ->getSetting('field') == $target_field_name) {
        $formatter_field = $field_name;
      }
    }
    if (!$formatter_field) {
      $message = $this
        ->t('Could not find appropriate formatter field to render %field_label.', [
        '%field_label' => $target_definition
          ->getLabel(),
      ]);
      drupal_set_message($message, 'warning');
      return;
    }
    $type = NULL;
    $settings = [];
    $field_items = $items
      ->getEntity()
      ->get($formatter_field);
    if (isset($field_items[0])) {
      $formatter_data = $field_items[0]
        ->getValue();
      $type = empty($formatter_data['type']) ? '' : $formatter_data['type'];
      $settings = empty($formatter_data['settings']) ? [] : unserialize($formatter_data['settings']);
    }
    if (!$type) {
      return;
    }
    $options = [
      'field_definition' => $target_definition,
      'configuration' => [
        'type' => $type,
        'settings' => $settings,
        'label' => '',
        'weight' => 0,
      ],
      'view_mode' => '_custom',
    ];
    $formatter = $this->formatterManager
      ->getInstance($options);
    return $formatter;
  }

}

Members

Namesort descending Modifiers Type Description 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 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::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
FromFieldFormatter::$fieldManager protected property Entity field manager.
FromFieldFormatter::$formatterManager protected property Formatter plugin manager.
FromFieldFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
FromFieldFormatter::getFormatter protected function Creates an appropriate formatter for the field.
FromFieldFormatter::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterBase::prepareView
FromFieldFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
FromFieldFormatter::__construct public function Constructs a new ModerationStateWidget object. Overrides FormatterBase::__construct
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.