class PDFPreviewFormatter in PDFPreview 8

Same name and namespace in other branches

2.0.x src/Plugin/Field/FieldFormatter/PdfPreviewFormatter.php \Drupal\pdfpreview\Plugin\Field\FieldFormatter\PdfPreviewFormatter

Plugin implementation of the 'pdfpreview' formatter.

Plugin annotation


@FieldFormatter(
  id = "pdfpreview",
  label = @Translation("PDF Preview"),
  field_types = {
    "file"
  }
)

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\image\Plugin\Field\FieldFormatter\ImageFormatterBase
    class \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatter implements ContainerFactoryPluginInterface
    class \Drupal\pdfpreview\Plugin\Field\FieldFormatter\PDFPreviewFormatter

Expanded class hierarchy of PDFPreviewFormatter

File

src/Plugin/Field/FieldFormatter/PDFPreviewFormatter.php, line 26

Namespace

Drupal\pdfpreview\Plugin\Field\FieldFormatter

View source

class PDFPreviewFormatter extends ImageFormatter {

  /**
   * The config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * The image factory.
   *
   * @var \Drupal\Core\Image\ImageFactory
   */
  protected $imageFactory;

  /**
   * The PDF Preview generator.
   * @var \Drupal\pdfpreview\PDFPreviewGenerator
   */
  protected $pdfPreviewGenerator;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $instance = parent::create($container, $configuration, $plugin_id, $plugin_definition);
    $instance
      ->setConfigFactory($container
      ->get('config.factory'));
    $instance
      ->setImageFactory($container
      ->get('image.factory'));
    $instance
      ->setPdfPreviewGenerator($container
      ->get('pdfpreview.generator'));
    return $instance;
  }

  /**
   * Sets the config factory.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   */
  public function setConfigFactory(ConfigFactoryInterface $config_factory) {
    $this->configFactory = $config_factory;
  }

  /**
   * Sets the image factory.
   *
   * @param \Drupal\Core\Image\ImageFactory $image_factory
   *   The image factory.
   */
  public function setImageFactory(ImageFactory $image_factory) {
    $this->imageFactory = $image_factory;
  }

  /**
   * Sets the PDF Preview generator.
   *
   * @param \Drupal\pdfpreview\PDFPreviewGenerator $pdf_preview_generator
   *   The PDF Preview generator.
   */
  public function setPdfPreviewGenerator(PDFPreviewGenerator $pdf_preview_generator) {
    $this->pdfPreviewGenerator = $pdf_preview_generator;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $config = \Drupal::config('pdfpreview.settings');
    return [
      'show_description' => $config
        ->get('show_description'),
      'tag' => $config
        ->get('tag'),
      'fallback_formatter' => $config
        ->get('fallback_formatter'),
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $form['show_description'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Description'),
      '#description' => $this
        ->t('Show file description beside image'),
      '#options' => [
        0 => $this
          ->t('No'),
        1 => $this
          ->t('Yes'),
      ],
      '#default_value' => $this
        ->getSetting('show_description'),
    ];
    $form['tag'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('HTML tag'),
      '#description' => $this
        ->t('Select which kind of HTML element will be used to theme elements'),
      '#options' => [
        'span' => 'span',
        'div' => 'div',
      ],
      '#default_value' => $this
        ->getSetting('tag'),
    ];
    $form['fallback_formatter'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Fallback to default file formatter'),
      '#description' => $this
        ->t('When enabled, non-PDF files will be formatted using a default file formatter.'),
      '#default_value' => (bool) $this
        ->getSetting('fallback_formatter'),
      '#return_value' => $this->configFactory
        ->get('pdfpreview.settings')
        ->get('fallback_formatter'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $summary[] = $this
      ->t('Separator tag: @tag', [
      '@tag' => $this
        ->getSetting('tag'),
    ]);
    $summary[] = $this
      ->t('Descriptions: @visibility', [
      '@visibility' => $this
        ->getSetting('show_description') ? $this
        ->t('Visible') : $this
        ->t('Hidden'),
    ]);
    if ($this
      ->getSetting('fallback_formatter')) {
      $summary[] = $this
        ->t('Using the default file formatter for non-PDF files');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $files = $this
      ->getEntitiesToView($items, $langcode);

    // Early opt-out if the field is empty.
    if (empty($files)) {
      return $elements;
    }
    $url = NULL;
    $image_link_setting = $this
      ->getSetting('image_link');

    // Check if the formatter involves a link.
    if ($image_link_setting == 'content') {
      $entity = $items
        ->getEntity();
      if (!$entity
        ->isNew()) {
        $url = $entity
          ->toUrl();
      }
    }
    elseif ($image_link_setting == 'file') {
      $link_file = TRUE;
    }
    $image_style_setting = $this
      ->getSetting('image_style');

    // Collect cache tags to be added for each item in the field.
    $cache_tags = [];
    if (!empty($image_style_setting)) {
      $image_style = $this->imageStyleStorage
        ->load($image_style_setting);
      $cache_tags = $image_style
        ->getCacheTags();
    }

    /** @var \Drupal\file\Entity\File $file */
    foreach ($files as $delta => $file) {
      $cache_contexts = [];
      if (isset($link_file)) {
        $image_uri = $file
          ->getFileUri();

        // @todo Wrap in file_url_transform_relative(). This is currently
        // impossible. As a work-around, we currently add the 'url.site' cache
        // context to ensure different file URLs are generated for different
        // sites in a multisite setup, including HTTP and HTTPS versions of the
        // same site. Fix in https://www.drupal.org/node/2646744.
        $url = Url::fromUri(file_create_url($image_uri));
        $cache_contexts[] = 'url.site';
      }
      $cache_tags = Cache::mergeTags($cache_tags, $file
        ->getCacheTags());

      // Extract field item attributes for the theme function, and unset them
      // from the $item so that the field template does not re-render them.
      $item = $file->_referringItem;
      $item_attributes = $item->_attributes;
      unset($item->_attributes);
      if (isset($item->description)) {
        $item_attributes['alt'] = $item->description;
        $item_attributes['title'] = $item->description;
      }
      $item_attributes['class'][] = 'pdfpreview-file';

      // Separate the PDF previews from the other files.
      $show_preview = FALSE;
      if ($file
        ->getMimeType() == 'application/pdf') {
        $preview_uri = $this->pdfPreviewGenerator
          ->getPDFPreview($file);
        $preview = $this->imageFactory
          ->get($preview_uri);
        if ($preview
          ->isValid()) {
          $show_preview = TRUE;
          $item->uri = $preview_uri;
          $item->width = $preview
            ->getWidth();
          $item->height = $preview
            ->getHeight();
          $elements[$delta] = [
            '#theme' => 'image_formatter',
            '#item' => $item,
            '#item_attributes' => $item_attributes,
            '#image_style' => $image_style_setting,
            '#url' => $url,
            '#cache' => [
              'tags' => $cache_tags,
              'contexts' => $cache_contexts,
            ],
          ];
        }
      }
      if (!$show_preview) {
        $elements[$delta] = [
          '#theme' => 'file_link',
          '#file' => $file,
          '#cache' => [
            'tags' => $file
              ->getCacheTags(),
          ],
        ];
      }
      $elements[$delta]['#description'] = $item->description;
      $elements[$delta]['#theme_wrappers'][] = 'pdfpreview_formatter';
      $elements[$delta]['#settings'] = $this
        ->getSettings();
      $elements[$delta]['#fid'] = $file
        ->id();
    }
    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::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
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::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
ImageFormatter::$currentUser	protected	property	The current user.
ImageFormatter::$imageStyleStorage	protected	property	The image style entity storage.
ImageFormatter::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides PluginSettingsBase::calculateDependencies
ImageFormatter::onDependencyRemoval	public	function	Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsBase::onDependencyRemoval
ImageFormatter::__construct	public	function	Constructs an ImageFormatter object. Overrides FormatterBase::__construct	1
ImageFormatterBase::getEntitiesToView	protected	function	Returns the referenced entities for display. Overrides EntityReferenceFormatterBase::getEntitiesToView
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PDFPreviewFormatter::$configFactory	protected	property	The config factory.
PDFPreviewFormatter::$imageFactory	protected	property	The image factory.
PDFPreviewFormatter::$pdfPreviewGenerator	protected	property	The PDF Preview generator.
PDFPreviewFormatter::create	public static	function	Creates an instance of the plugin. Overrides ImageFormatter::create
PDFPreviewFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides ImageFormatter::defaultSettings
PDFPreviewFormatter::setConfigFactory	public	function	Sets the config factory.
PDFPreviewFormatter::setImageFactory	public	function	Sets the image factory.
PDFPreviewFormatter::setPdfPreviewGenerator	public	function	Sets the PDF Preview generator.
PDFPreviewFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides ImageFormatter::settingsForm
PDFPreviewFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides ImageFormatter::settingsSummary
PDFPreviewFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides ImageFormatter::viewElements
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::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::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 PDFPreviewFormatter in PDFPreview 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation