You are here

Home » API reference » Opigno module 3.x » OpignoTftFormatter.php

class OpignoTftFormatter in Opigno module 3.x

Same name and namespace in other branches
  1. 8 ActivityTypes/opigno_video/src/Plugin/Field/FieldFormatter/OpignoTftFormatter.php \Drupal\opigno_video\Plugin\Field\FieldFormatter\OpignoTftFormatter

Plugin implementation of the 'opigno_tft_formatter' formatter.

Plugin annotation


@FieldFormatter(
  id = "opigno_tft_formatter",
  label = @Translation("Tft formatter"),
  field_types = {
    "file"
  }
)

Hierarchy

Expanded class hierarchy of OpignoTftFormatter

File

ActivityTypes/opigno_video/src/Plugin/Field/FieldFormatter/OpignoTftFormatter.php, line 25

Namespace

Drupal\opigno_video\Plugin\Field\FieldFormatter
View source 
class OpignoTftFormatter extends FormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'width' => 220,
      'height' => 220,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    return parent::settingsForm($form, $form_state) + [
      'width' => [
        '#type' => 'number',
        '#title' => $this
          ->t('Width'),
        '#default_value' => $this
          ->getSetting('width'),
        '#size' => 5,
        '#maxlength' => 5,
        '#field_suffix' => $this
          ->t('pixels'),
        '#min' => 0,
        '#required' => TRUE,
      ],
      'height' => [
        '#type' => 'number',
        '#title' => $this
          ->t('Height'),
        '#default_value' => $this
          ->getSetting('height'),
        '#size' => 5,
        '#maxlength' => 5,
        '#field_suffix' => $this
          ->t('pixels'),
        '#min' => 0,
        '#required' => TRUE,
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements['#attached']['library'][] = 'core/drupal.dialog.ajax';
    foreach ($items as $delta => $item) {
      $elements[$delta] = [
        $this
          ->viewValue($item),
      ];
    }
    if (empty($items->list)) {
      $media = $items
        ->getEntity();
      if (!empty($media) && $media
        ->hasField('opigno_moxtra_recording_link') && !empty($link = $media
        ->get('opigno_moxtra_recording_link')
        ->getValue())) {

        // Moxtra recording file.
        // Get the filefield icon.
        $icon_class = file_icon_class('video/mp4');
        $elements[][] = [
          '#type' => 'link',
          '#title' => $media
            ->getName(),
          '#url' => Url::fromUri("internal:/tft/download/file/{$media->id()}"),
          '#attributes' => [
            'class' => "file {$icon_class}",
            'target' => '_blank',
          ],
          '#prefix' => '<div>',
          '#suffix' => '</div>',
        ];
      }
    }
    return $elements;
  }

  /**
   * Generate the output appropriate for one field item.
   *
   * @param \Drupal\Core\Field\FieldItemInterface $item
   *   One field item.
   *
   * @return string
   *   The textual output generated.
   */
  protected function viewValue(FieldItemInterface $item) {
    $fid = $item
      ->getValue();
    $file = File::load($fid['target_id']);
    $ext = explode('/', $file
      ->getMimeType());
    $entity = $item
      ->getEntity();
    $output[] = [
      '#type' => 'link',
      '#title' => $entity
        ->label(),
      '#url' => Url::fromUri("internal:/tft/download/file/{$entity->id()}"),
      '#attributes' => [
        'target' => '_blank',
      ],
      '#prefix' => '<div>',
      '#suffix' => '</div>',
    ];
    switch ($ext[0]) {
      case 'video':
        $source_attributes = new Attribute();
        $source_attributes
          ->setAttribute('src', file_url_transform_relative(file_create_url($file
          ->getFileUri())))
          ->setAttribute('type', $file
          ->getMimeType());
        $source_file = [
          'file' => $file,
          'source_attributes' => $source_attributes,
        ];
        $video_attributes = new Attribute();
        $video_attributes
          ->setAttribute('controls', 'controls')
          ->setAttribute('width', $this
          ->getSetting('width'))
          ->setAttribute('height', $this
          ->getSetting('height'))
          ->setAttribute('controlsList', 'nodownload');
        array_unshift($output, [
          '#theme' => 'file_video',
          '#attributes' => $video_attributes,
          '#files' => [
            $source_file,
          ],
        ]);
        break;
      case 'image':
        $image = [
          '#theme' => 'image_style',
          '#style_name' => 'medium',
          '#uri' => $file
            ->getFileUri(),
          '#width' => $this
            ->getSetting('width'),
          '#height' => $this
            ->getSetting('height'),
        ];
        array_unshift($output, [
          '#type' => 'link',
          '#title' => $image,
          '#url' => URL::fromRoute('opigno_video.image_popup_render', [
            'fid' => $fid['target_id'],
          ]),
          '#options' => [
            'attributes' => [
              'class' => [
                'use-ajax',
                'ops-link',
              ],
              'data-dialog-type' => 'modal',
              'data-dialog-options' => Json::encode([
                'width' => 500,
              ]),
            ],
          ],
        ]);
        break;
    }
    return $output;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 12
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::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterInterface::settingsSummary 22
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 12
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
OpignoTftFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
OpignoTftFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
OpignoTftFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
OpignoTftFormatter::viewValue protected function Generate the output appropriate for one field item.
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.