class PdfDefault in PDF 8

Plugin annotation


@FieldFormatter(
 id = "pdf_default",
 label = @Translation("PDF: Default viewer of PDF.js"),
 description = @Translation("Use the default viewer like http://mozilla.github.io/pdf.js/web/viewer.html."),
 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\pdf\Plugin\Field\FieldFormatter\PdfDefault

Expanded class hierarchy of PdfDefault

File

src/Plugin/Field/FieldFormatter/PdfDefault.php, line 18

Namespace

Drupal\pdf\Plugin\Field\FieldFormatter

View source

class PdfDefault extends FormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'keep_pdfjs' => TRUE,
      'width' => '100%',
      'height' => '',
      'page' => NULL,
      'zoom' => NULL,
      'custom_zoom' => NULL,
      'pagemode' => NULL,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = parent::settingsForm($form, $form_state);
    $field_name = $this->fieldDefinition
      ->getName();
    $elements['keep_pdfjs'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Always use pdf.js'),
      '#default_value' => $this
        ->getSetting('keep_pdfjs'),
      '#description' => t("Use pdf.js even when the browser has Adobe Reader Plugin, WebKit PDF Reader for Safari or the PDF Reader for Chrome (Chrome's default alternative to the Adobe Reader Plugin) installed."),
    ];
    $elements['width'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Width'),
      '#default_value' => $this
        ->getSetting('width'),
      '#description' => $this
        ->t('Width of the viewer. Ex: 250px or 100%'),
    ];
    $elements['height'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Height'),
      '#default_value' => $this
        ->getSetting('height'),
      '#description' => $this
        ->t('Height of the viewer. Ex: 250px or 100%'),
    ];

    // Extra Options.
    $elements['page'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Initial page'),
      '#default_value' => $this
        ->getSetting('page'),
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $field_name . '][settings_edit_form][settings][keep_pdfjs]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $elements['zoom'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Zoom Level'),
      '#default_value' => $this
        ->getSetting('zoom'),
      '#options' => [
        '' => $this
          ->t('- None -'),
        'auto' => $this
          ->t('Automatic Zoom'),
        'page-actual' => $this
          ->t('Actual Size'),
        'page-fit' => $this
          ->t('Fit Page'),
        'page-width' => $this
          ->t('Full Width'),
        'custom' => $this
          ->t('Custom Scale'),
      ],
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $field_name . '][settings_edit_form][settings][keep_pdfjs]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $elements['custom_zoom'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Custom Zoom Level (%)'),
      '#default_value' => $this
        ->getSetting('custom_zoom'),
      '#min' => 5,
      '#step' => 1,
      '#states' => [
        'visible' => [
          'select[name="fields[' . $field_name . '][settings_edit_form][settings][zoom]"]' => [
            'value' => 'custom',
          ],
        ],
        'required' => [
          'select[name="fields[' . $field_name . '][settings_edit_form][settings][zoom]"]' => [
            'value' => 'custom',
          ],
        ],
      ],
    ];
    $elements['pagemode'] = [
      '#type' => 'select',
      '#group' => 'extra_options',
      '#title' => $this
        ->t('Page Mode'),
      '#default_value' => $this
        ->getSetting('pagemode'),
      '#options' => [
        '' => $this
          ->t('- None -'),
        'thumbs' => $this
          ->t('Thumbnails'),
        'bookmarks' => $this
          ->t('Bookmarks'),
      ],
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $field_name . '][settings_edit_form][settings][keep_pdfjs]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $keep_pdfjs = $this
      ->getSetting('keep_pdfjs');
    $width = $this
      ->getSetting('width');
    $height = $this
      ->getSetting('height');
    if (empty($keep_pdfjs) && empty($width) && empty($height)) {
      $summary[] = $this
        ->t('No settings');
    }
    else {
      $summary[] = t('Use pdf.js even when users have PDF reader plugin: @keep_pdfjs', [
        '@keep_pdfjs' => $keep_pdfjs ? t('Yes') : t('No'),
      ]) . '. ' . t('Width: @width , Height: @height', [
        '@width' => $width,
        '@height' => $height,
      ]);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $config = \Drupal::config('pdf.settings');
    $viewer_path = $config
      ->get('custom_viewer') ? $config
      ->get('custom_viewer') : base_path() . 'libraries/pdf.js/web/viewer.html';
    $keep_pdfjs = $this
      ->getSetting('keep_pdfjs');
    $extra_options = array_filter(array_intersect_key($this
      ->getSettings(), array_flip([
      'page',
      'zoom',
      'custom_zoom',
      'pagemode',
    ])));
    if (isset($extra_options['zoom']) && $extra_options['zoom'] == 'custom') {
      $extra_options['zoom'] = $extra_options['custom_zoom'];
    }
    unset($extra_options['custom_zoom']);
    $query = UrlHelper::buildQuery($extra_options);
    foreach ($items as $delta => $item) {
      if ($item->entity
        ->getMimeType() == 'application/pdf') {
        $file_url = file_create_url($item->entity
          ->getFileUri());
        $iframe_src = file_create_url($viewer_path) . '?file=' . rawurlencode($file_url);
        $iframe_src = !empty($query) && $keep_pdfjs ? $iframe_src . '#' . $query : $iframe_src;
        $html = [
          '#theme' => 'file_pdf',
          '#attributes' => [
            'class' => [
              'pdf',
            ],
            'webkitallowfullscreen' => '',
            'mozallowfullscreen' => '',
            'allowfullscreen' => '',
            'frameborder' => 'no',
            'width' => $this
              ->getSetting('width'),
            'height' => $this
              ->getSetting('height'),
            'src' => $iframe_src,
            'data-src' => $file_url,
            'title' => $item->entity
              ->label(),
          ],
        ];
        $elements[$delta] = $html;
      }
      else {
        $elements[$delta] = [
          '#theme' => 'file_link',
          '#file' => $item->entity,
        ];
      }
    }
    if ($keep_pdfjs != TRUE) {
      $elements['#attached']['library'][] = 'pdf/default';
    }
    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
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::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
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.
PdfDefault::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
PdfDefault::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
PdfDefault::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
PdfDefault::viewElements	public	function	Builds a renderable array for a field value. Overrides FormatterInterface::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::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 PdfDefault in PDF 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation