Version 1

[yaffs-website] / web / core / modules / file / src / Plugin / Field / FieldFormatter / FileUriFormatter.php

diff --git a/web/core/modules/file/src/Plugin/Field/FieldFormatter/FileUriFormatter.php b/web/core/modules/file/src/Plugin/Field/FieldFormatter/FileUriFormatter.php
new file mode 100644 (file)
index 0000000..055e32d
--- /dev/null
+++ b/web/core/modules/file/src/Plugin/Field/FieldFormatter/FileUriFormatter.php
@@ -0,0 +1,68 @@
+<?php
+
+namespace Drupal\file\Plugin\Field\FieldFormatter;
+
+use Drupal\Core\Field\FieldDefinitionInterface;
+use Drupal\Core\Field\FieldItemInterface;
+use Drupal\Core\Form\FormStateInterface;
+
+/**
+ * Formatter to render the file URI to its download path.
+ *
+ * @FieldFormatter(
+ *   id = "file_uri",
+ *   label = @Translation("File URI"),
+ *   field_types = {
+ *     "uri"
+ *   }
+ * )
+ */
+class FileUriFormatter extends BaseFieldFileFormatterBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function defaultSettings() {
+    $settings = parent::defaultSettings();
+
+    $settings['file_download_path'] = FALSE;
+    return $settings;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function settingsForm(array $form, FormStateInterface $form_state) {
+    $form = parent::settingsForm($form, $form_state);
+
+    $form['file_download_path'] = [
+      '#title' => $this->t('Display the file download URI'),
+      '#type' => 'checkbox',
+      '#default_value' => $this->getSetting('file_download_path'),
+    ];
+
+    return $form;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function viewValue(FieldItemInterface $item) {
+    $value = $item->value;
+    if ($this->getSetting('file_download_path')) {
+      // @todo Wrap in file_url_transform_relative(). This is currently
+      // impossible. See BaseFieldFileFormatterBase::viewElements(). Fix in
+      // https://www.drupal.org/node/2646744.
+      $value = file_create_url($value);
+    }
+    return $value;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function isApplicable(FieldDefinitionInterface $field_definition) {
+    return parent::isApplicable($field_definition) && $field_definition->getName() === 'uri';
+  }
+
+}