class BynderDocumentFormatter in Bynder 4.0.x

Same name and namespace in other branches

8.3 src/Plugin/Field/FieldFormatter/BynderDocumentFormatter.php \Drupal\bynder\Plugin\Field\FieldFormatter\BynderDocumentFormatter

Plugin implementation of the 'Bynder Document' formatter.

Plugin annotation


@FieldFormatter(
  id = "bynder_document",
  label = @Translation("Bynder (Document)"),
  field_types = {"string", "string_long", "entity_reference"}
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
    class \Drupal\bynder\Plugin\Field\FieldFormatter\BynderFormatterBase implements ContainerFactoryPluginInterface
    class \Drupal\bynder\Plugin\Field\FieldFormatter\BynderDocumentFormatter implements ContainerFactoryPluginInterface

Expanded class hierarchy of BynderDocumentFormatter

File

src/Plugin/Field/FieldFormatter/BynderDocumentFormatter.php, line 20

Namespace

Drupal\bynder\Plugin\Field\FieldFormatter

View source

class BynderDocumentFormatter extends BynderFormatterBase implements ContainerFactoryPluginInterface {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'link' => TRUE,
      'title_field' => '',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = parent::settingsForm($form, $form_state);
    $elements['link'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Render as link'),
      '#description' => $this
        ->t('Whether the URL should be shown as a link or just as a plain URL.'),
      '#default_value' => $this
        ->getSetting('link'),
    ];
    $field_candidates = $this
      ->getAttributesFieldsCandidates();
    $elements['title_field'] = [
      '#type' => 'select',
      '#options' => $field_candidates,
      '#title' => $this
        ->t('Link Title field'),
      '#description' => $this
        ->t('Select the name of the field that should be used for the link title. Falls back to the name of the file if not set.'),
      '#default_value' => $this
        ->getSetting('title_field'),
      '#empty_option' => $this
        ->t('- File name -'),
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $settings = $this
      ->getSettings();
    $summary[] = $this
      ->t('Link: @link', [
      '@link' => $settings['link'] ? $this
        ->t('Yes') : $this
        ->t('No'),
    ]);
    if ($settings['link']) {
      $field_candidates = $this
        ->getAttributesFieldsCandidates();
      $summary[] = $this
        ->t('Link title field: @field', [
        '@field' => $settings['title_field'] ? $field_candidates[$settings['title_field']] : $this
          ->t('- File name -'),
      ]);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $is_entityreference = $this->fieldDefinition
      ->getType() == 'entity_reference';
    foreach ($items as $delta => $item) {

      /** @var \Drupal\media\MediaInterface $media */
      $media = $is_entityreference ? $item->entity : $items
        ->getEntity();
      if (!$media) {
        continue;
      }
      $source_plugin = $media
        ->getSource();
      if ($source_plugin instanceof Bynder && ($original = $source_plugin
        ->getMetadata($media, 'original'))) {
        if ($this
          ->getSetting('link')) {
          if ($this
            ->getSetting('title_field') && $media
            ->hasField($this
            ->getSetting('title_field')) && !$media
            ->get($this
            ->getSetting('title_field'))
            ->isEmpty()) {
            $title = $media
              ->get($this
              ->getSetting('title_field'))->value;
          }
          else {
            $title = basename($original);
          }
          $elements[$delta] = [
            '#type' => 'link',
            '#title' => $title,
            '#url' => Url::fromUri($original),
          ];
        }
        else {
          $elements[$delta] = [
            '#plain_text' => $original,
          ];
        }
      }
    }
    return $elements;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BynderDocumentFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
BynderDocumentFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
BynderDocumentFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
BynderDocumentFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
BynderFormatterBase::$bynder	protected	property	The Bynder API service.
BynderFormatterBase::$configFactory	protected	property	The config factory.
BynderFormatterBase::$currentUser	protected	property	The current user.
BynderFormatterBase::$entityFieldManager	protected	property	The entity field manager service.
BynderFormatterBase::$entityTypeManager	protected	property	The entity type manager service.
BynderFormatterBase::$renderer	protected	property	Renderer object.
BynderFormatterBase::create	public static	function	Creates an instance of the plugin. Overrides FormatterBase::create	1
BynderFormatterBase::getAttributesFieldsCandidates	protected	function	Gets list of fields that are candidates for IMG attributes.
BynderFormatterBase::isApplicable	public static	function	Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
BynderFormatterBase::__construct	public	function	Constructs a BynderFormatter object. Overrides FormatterBase::__construct
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
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::prepareView	public	function	Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView	2
FormatterBase::view	public	function	Builds a renderable array for a fully themed field. Overrides FormatterInterface::view	1
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.
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.	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.

You are here

class BynderDocumentFormatter in Bynder 4.0.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation