You are here

class TableFormatter in File Hash 8

Plugin implementation of the 'filehash_table' formatter.

Plugin annotation

  id = "filehash_table",
  label = @Translation("Table of files with hashes"),
  field_types = {


Expanded class hierarchy of TableFormatter


src/Plugin/Field/FieldFormatter/TableFormatter.php, line 21


View source
class TableFormatter extends DescriptionAwareFileFormatterBase {

   * {@inheritdoc}
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    if ($files = $this
      ->getEntitiesToView($items, $langcode)) {
      $names = filehash_names();
      $header = [
          ->t('@algo hash', [
          '@algo' => $names[$this
      $rows = [];
      foreach ($files as $file) {
        if (property_exists($file, '_referringItem')) {
          $item = $file->_referringItem;
          $rows[] = [
              'data' => [
                '#theme' => 'file_link',
                '#file' => $file,
                '#description' => $this
                  ->getSetting('use_description_as_link_text') ? $item->description : NULL,
                '#cache' => [
                  'tags' => $file
              'data' => format_size(method_exists($file, 'getSize') ? $file
                ->getSize() : 0),
              'data' => [
                '#markup' => substr(chunk_split(property_exists($file, 'filehash') ? $file->filehash[$this
                  ->getSetting('algo')] : '', 1, '<wbr />'), 0, -7),
      $elements[0] = [];
      if (!empty($rows)) {
        $elements[0] = [
          '#theme' => 'table__filehash_formatter_table',
          '#header' => $header,
          '#rows' => $rows,
    return $elements;

   * {@inheritdoc}
  public static function defaultSettings() {
    $settings = parent::defaultSettings();
    $algos = filehash_algos();
    $settings['algo'] = array_pop($algos);
    return $settings;

   * {@inheritdoc}
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $names = filehash_names();
    $options = [];
    foreach (filehash_algos() as $algo) {
      $options[$algo] = $names[$algo];
    $form['algo'] = [
      '#title' => $this
        ->t('Hash algorithm'),
      '#type' => 'select',
      '#default_value' => $this
      '#options' => $options,
    return $form;

   * {@inheritdoc}
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $algos = filehash_names();
    if (isset($algos[$this
      ->getSetting('algo')])) {
      $summary[] = $this
        ->t('@algo hash', [
        '@algo' => $algos[$this
    return $summary;



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