class FieldFormatter in Twig Extender 4.x

The plugin to render a field with a specific formatter.

Plugin annotation

@TwigPlugin(
  id = "twig_extender_field_formatter",
  label = @Translation("Get a formatted field"),
  type = "filter",
  name = "view",
  function = "getField"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\twig_extender\Plugin\Twig\TwigPluginBase implements TwigExtensionInterface
      • class \Drupal\twig_extender_extras\Plugin\TwigPlugin\FieldFormatter

File

modules/twig_extender_extras/src/Plugin/TwigPlugin/FieldFormatter.php, line 20

Namespace

Drupal\twig_extender_extras\Plugin\TwigPlugin

class FieldFormatter extends TwigPluginBase {

  /**
   * Implementation for render field formatter.
   *
   * @param \Drupal\Core\Field\FieldItemList $field
   *   FieldItemList to display with formatter.
   * @param string $formatter
   *   Formatter plugin id to use.
   * @param string $label
   *   Label option for formatter, could be hidden|above|inside.
   * @param array $settings
   *   Settings for formatter plugin.
   * @param int $maxItems
   *   How many items to display.
   * @param int $offset
   *   Offset to start from.
   *
   * @return array
   *   Array for rendering.
   */
  public function getField(FieldItemList $field, $formatter, $label = 'hidden', array $settings = [], $maxItems = -1, $offset = 0) {
    $formatterService = \Drupal::service('plugin.manager.field.formatter');
    try {
      $plugin = $formatterService
        ->getDefinition($formatter);
      $field_type = $field
        ->getFieldDefinition()
        ->getType();
      $field_options = $formatterService
        ->getOptions();
      $default_settings = $formatterService
        ->getDefaultsettings($formatter);
      $settings = NestedArray::mergeDeep($default_settings, $settings);
      $renderer = \Drupal::service('renderer');
      if ($offset > 0) {
        if (!$field
          ->offsetExists($offset)) {
          $build = [];
          $renderer
            ->addCacheableDependency($build, $field
            ->getEntity());
          return $build;
        }
        for ($i = 0; $i < $offset; $i++) {
          $field
            ->removeItem(0);
        }
      }
      if ($maxItems > 0 && $maxItems != $field
        ->count()) {
        $remove = $field
          ->count() - $maxItems;
        for ($i = 0; $i < $remove; $i++) {
          $field
            ->removeItem(1);
        }
      }
      $field_to_view = $field
        ->view([
        'type' => $formatter,
        'settings' => $settings,
        'label' => $label,
      ]);
      return $field_to_view;
    } catch (\Exception $e) {
      \Drupal::logger('twig_extender_extras')
        ->error($e
        ->getMessage());
      throw $e;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FieldFormatter::getField	public	function	Implementation for render field formatter.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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	2
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	98
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.
TwigPluginBase::getFunction	public	function	Get type of the twig extension. Overrides TwigExtensionInterface::getFunction
TwigPluginBase::getName	public	function	Get type of the twig extension. Overrides TwigExtensionInterface::getName
TwigPluginBase::getType	public	function	Get type of the twig extension. Overrides TwigExtensionInterface::getType
TwigPluginBase::register	public	function	Get type of the twig extension. Overrides TwigExtensionInterface::register