You are here

class FieldDownloadCount in Open Social 8

Same name and namespace in other branches
  1. 8.9 modules/custom/download_count/src/Plugin/Field/FieldFormatter/FieldDownloadCount.php \Drupal\download_count\Plugin\Field\FieldFormatter\FieldDownloadCount
  2. 8.2 modules/custom/download_count/src/Plugin/Field/FieldFormatter/FieldDownloadCount.php \Drupal\download_count\Plugin\Field\FieldFormatter\FieldDownloadCount
  3. 8.3 modules/custom/download_count/src/Plugin/Field/FieldFormatter/FieldDownloadCount.php \Drupal\download_count\Plugin\Field\FieldFormatter\FieldDownloadCount
  4. 8.4 modules/custom/download_count/src/Plugin/Field/FieldFormatter/FieldDownloadCount.php \Drupal\download_count\Plugin\Field\FieldFormatter\FieldDownloadCount
  5. 8.5 modules/custom/download_count/src/Plugin/Field/FieldFormatter/FieldDownloadCount.php \Drupal\download_count\Plugin\Field\FieldFormatter\FieldDownloadCount
  6. 8.6 modules/custom/download_count/src/Plugin/Field/FieldFormatter/FieldDownloadCount.php \Drupal\download_count\Plugin\Field\FieldFormatter\FieldDownloadCount
  7. 8.7 modules/custom/download_count/src/Plugin/Field/FieldFormatter/FieldDownloadCount.php \Drupal\download_count\Plugin\Field\FieldFormatter\FieldDownloadCount
  8. 8.8 modules/custom/download_count/src/Plugin/Field/FieldFormatter/FieldDownloadCount.php \Drupal\download_count\Plugin\Field\FieldFormatter\FieldDownloadCount
  9. 10.3.x modules/custom/download_count/src/Plugin/Field/FieldFormatter/FieldDownloadCount.php \Drupal\download_count\Plugin\Field\FieldFormatter\FieldDownloadCount
  10. 10.0.x modules/custom/download_count/src/Plugin/Field/FieldFormatter/FieldDownloadCount.php \Drupal\download_count\Plugin\Field\FieldFormatter\FieldDownloadCount
  11. 10.1.x modules/custom/download_count/src/Plugin/Field/FieldFormatter/FieldDownloadCount.php \Drupal\download_count\Plugin\Field\FieldFormatter\FieldDownloadCount
  12. 10.2.x modules/custom/download_count/src/Plugin/Field/FieldFormatter/FieldDownloadCount.php \Drupal\download_count\Plugin\Field\FieldFormatter\FieldDownloadCount

The FieldDownloadCount class.

Plugin annotation


@FieldFormatter(
 id = "FieldDownloadCount",
 label = @Translation("Generic file with download count"),
 field_types = {"file"}
)

Hierarchy

Expanded class hierarchy of FieldDownloadCount

1 string reference to 'FieldDownloadCount'
SocialDownloadCountConfigOverride::loadOverrides in modules/social_features/social_download_count/src/SocialDownloadCountConfigOverride.php
Load overrides.

File

modules/custom/download_count/src/Plugin/Field/FieldFormatter/FieldDownloadCount.php, line 22

Namespace

Drupal\download_count\Plugin\Field\FieldFormatter
View source
class FieldDownloadCount extends GenericFileFormatter {

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $element = [];
    $entity = $items
      ->getEntity();
    $entity_type = $entity
      ->getEntityTypeId();
    $access = \Drupal::currentUser()
      ->hasPermission('view download counts');
    foreach ($this
      ->getEntitiesToView($items, $langcode) as $delta => $file) {
      $item = $file->_referringItem;
      if ($access) {
        $download = Database::getConnection()
          ->query('SELECT COUNT(fid) from {download_count} where fid = :fid AND type = :type AND id = :id', [
          ':fid' => $file
            ->id(),
          ':type' => $entity_type,
          ':id' => $entity
            ->id(),
        ])
          ->fetchField();
        $file->download = $download;
      }
      $link_url = file_create_url($file
        ->getFileUri());
      $file_size = $file
        ->getSize();
      $options = [
        'attributes' => [
          'type' => $file
            ->getMimeType() . '; length=' . $file
            ->getSize(),
        ],
      ];

      // Use the description as the link text if available.
      if (empty($item->description)) {
        $link_text = $file
          ->getFilename();
      }
      else {
        $link_text = $item->description;
        $options['attributes']['title'] = Html::escape($file
          ->getFilename());
      }

      // Classes to add to the file field for icons.
      $classes = [
        'file',
        // Add a specific class for each and every mime type.
        'file--mime-' . strtr($file
          ->getMimeType(), [
          '/' => '-',
          '.' => '-',
        ]),
        // Add a more general class for groups of well known mime types.
        'file--' . file_icon_class($file
          ->getMimeType()),
      ];
      $attributes = new Attribute([
        'class' => $classes,
      ]);
      $link = Link::fromTextAndUrl($link_text, Url::fromUri($link_url, $options))
        ->toString();
      if (isset($file->download) && $file->download > 0) {
        $count = \Drupal::translation()
          ->formatPlural($file->download, '1 download', '@count downloads');
      }
      else {
        $count = $this
          ->t('0 downloads');
      }
      $theme = \Drupal::theme()
        ->getActiveTheme();

      // Check if socialbase is one of the base themes.
      // Then get the path to socialbase theme and provide a variable
      // that can be used in the template for a path to the icons.
      if (array_key_exists('socialbase', $theme
        ->getBaseThemes())) {
        $basethemes = $theme
          ->getBaseThemes();
        $path_to_socialbase = $basethemes['socialbase']
          ->getPath();
      }
      $mime_type = $file
        ->getMimeType();
      $generic_mime_type = file_icon_class($mime_type);
      if (isset($generic_mime_type)) {

        // Set new icons for the mime types.
        switch ($generic_mime_type) {
          case 'application-pdf':
            $node_icon = 'pdf';
            break;
          case 'x-office-document':
            $node_icon = 'document';
            break;
          case 'x-office-presentation':
            $node_icon = 'presentation';
            break;
          case 'x-office-spreadsheet':
            $node_icon = 'spreadsheet';
            break;
          case 'package-x-generic':
            $node_icon = 'archive';
            break;
          case 'audio':
            $node_icon = 'audio';
            break;
          case 'video':
            $node_icon = 'video';
            break;
          case 'image':
            $node_icon = 'image';
            break;
          default:
            $node_icon = 'text';
        }
      }
      $element[$delta] = [
        '#theme' => !$access ? 'file_link' : 'download_count_file_field_formatter',
        '#file' => $file,
        '#link' => $link,
        '#link_url' => $link_url,
        '#link_text' => $link_text,
        '#classes' => $attributes['class'],
        '#count' => $count,
        '#file_size' => format_size($file_size),
        '#path_to_socialbase' => $path_to_socialbase,
        '#node_icon' => $node_icon,
        '#attached' => [
          'library' => [
            'classy/file',
          ],
        ],
        '#cache' => [
          'tags' => $file
            ->getCacheTags(),
        ],
      ];

      // Pass field item attributes to the theme function.
      if (isset($item->_attributes)) {
        $element[$delta] += [
          '#attributes' => [],
        ];
        $element[$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 $element;
  }

}

Members

Namesort descending 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
DescriptionAwareFileFormatterBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
DescriptionAwareFileFormatterBase::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
DescriptionAwareFileFormatterBase::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
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
FieldDownloadCount::viewElements public function Builds a renderable array for a field value. Overrides GenericFileFormatter::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.