class FileDownloadFieldFormatter in File Download 8

Plugin annotation


@FieldFormatter(
  id = "file_download_formatter",
  label = @Translation("File Download"),
  field_types = {
    "file",
    "image"
  }
)

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\Core\Field\Plugin\Field\FieldFormatter\EntityReferenceFormatterBase
    class \Drupal\file\Plugin\Field\FieldFormatter\FileFormatterBase
    class \Drupal\file_download\Plugin\Field\FieldFormatter\FileDownloadFieldFormatter

Expanded class hierarchy of FileDownloadFieldFormatter

File

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

Namespace

Drupal\file_download\Plugin\Field\FieldFormatter

View source

class FileDownloadFieldFormatter extends FileFormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $options = parent::defaultSettings();
    $options['link_title'] = 'file';
    $options['custom_title_text'] = '';
    $options['file_size'] = 0;
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $form['link_title'] = [
      '#type' => 'radios',
      '#options' => $this
        ->getDisplayOptions(),
      '#title' => $this
        ->t('Title Display'),
      '#description' => $this
        ->t('Control what is displayed in the title of the link'),
      '#default_value' => $this
        ->getSetting('link_title'),
    ];
    $fieldName = $this->fieldDefinition
      ->getName();
    $form['custom_title_text'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Custom text'),
      '#default_value' => $this
        ->getSetting('custom_title_text'),
      '#placeholder' => $this
        ->t('e.g. "Download"'),
      '#description' => $this
        ->t('Provide a custom text to display for all download links.  This field takes HTML and @link', [
        '@link' => '<a href="/admin/help/token">file entity tokens for current user, file and parent entity.</a>',
      ]),
      '#states' => [
        'visible' => [
          ":input[name=\"fields[{$fieldName}][settings_edit_form][settings][link_title]\"]" => [
            'value' => 'custom',
          ],
        ],
      ],
    ];
    $form['file_size'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display file size'),
      '#description' => $this
        ->t('Displays the size of the file next to the download link.'),
      '#default_value' => $this
        ->getSetting('file_size'),
    ];
    return $form;
  }

  /**
   * @return array
   */
  private function getDisplayOptions() {
    return [
      'file' => $this
        ->t('Title of file'),
      'entity_title' => $this
        ->t('Title of parent entity'),
      'description' => $this
        ->t('Contents of the description field'),
      'empty' => $this
        ->t('Nothing'),
      'custom' => $this
        ->t('Custom text'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $settings = $this
      ->getSettings();
    $displayOptions = $this
      ->getDisplayOptions();
    $selectedTitleDisplay = $settings['link_title'];
    $tArgs = [
      '@view' => $displayOptions[$selectedTitleDisplay],
    ];
    $summary[] = $this
      ->t('Title Display: @view', $tArgs);
    if ($selectedTitleDisplay === 'custom') {
      $tArgs = [
        '@text' => $settings['custom_title_text'],
      ];
      $summary[] = $this
        ->t('Custom text: @text', $tArgs);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $token_data = [
      'user' => \Drupal::currentUser(),
      $items
        ->getEntity()
        ->getEntityTypeId() => $items
        ->getEntity(),
    ];
    $settings = $this
      ->getSettings();
    foreach ($this
      ->getEntitiesToView($items, $langcode) as $delta => $file) {
      $token_data['file'] = $file;
      $item = $file->_referringItem;
      switch ($settings['link_title']) {

        // This is useful for instance if you are using an icon.
        case 'empty':
          $title = '';
          break;
        case 'entity_title':
          $entity = $items
            ->getEntity();
          $title = NULL;
          if ($entity
            ->label() != NULL) {
            $title = $entity
              ->label();
          }
          break;
        case 'custom':
          $title = \Drupal::token()
            ->replace($settings['custom_title_text'], $token_data, [
            'clear' => TRUE,
          ]);
          break;
        case 'description':
          $title = $item->description;
          break;

        // This equates to choosing filename.
        default:

          // If title has no value then filename is substituted
          // See template_preprocess_download_file_link()
          $title = NULL;
      }
      if (empty($title) && $settings['link_title'] !== 'empty') {

        // If we explicitly want to have a title but no title was defined yet,
        // fallback to the filename.
        $title = NULL;
      }
      $elements[$delta] = [
        '#theme' => 'download_file_link',
        '#file' => $file,
        '#title' => $title,
        '#description' => $item->description,
        '#cache' => [
          'tags' => $file
            ->getCacheTags(),
        ],
      ];
      if ($settings['file_size']) {
        $elements[$delta]['#size'] = format_size($file
          ->getSize());
        $elements[$delta]['#raw_size'] = $file
          ->getSize();
      }

      // Pass field item attributes to the theme function.
      if (isset($item->_attributes)) {
        $elements[$delta] += [
          '#attributes' => [],
        ];
        $elements[$delta]['#attributes'] += $item->_attributes;

        // Unset field item attributes since they have been included in the
        // formatter output and should not be rendered in the field template.
        unset($item->_attributes);
      }
    }
    return $elements;
  }

}

Members

Name	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
EntityReferenceFormatterBase::getEntitiesToView	protected	function	Returns the referenced entities for display.	1
EntityReferenceFormatterBase::prepareView	public	function	Loads the entities referenced in that field across all the entities being viewed. Overrides FormatterBase::prepareView
EntityReferenceFormatterBase::view	public	function	Overrides FormatterBase::view
FileDownloadFieldFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
FileDownloadFieldFormatter::getDisplayOptions	private	function
FileDownloadFieldFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
FileDownloadFieldFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
FileDownloadFieldFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
FileFormatterBase::checkAccess	protected	function	Checks access to the given entity. Overrides EntityReferenceFormatterBase::checkAccess
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. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode	protected	property	The view mode.
FormatterBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	11
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::__construct	public	function	Constructs a FormatterBase object. Overrides PluginBase::__construct	11
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::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.

You are here

class FileDownloadFieldFormatter in File Download 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation