class TablefieldFormatter in TableField 8.2

Plugin implementation of the default Tablefield formatter.

@FieldFormatter ( id = "tablefield", label =

Plugin annotation


@Translation("Tabular View"),
  field_types = {
    "tablefield"
  }
)

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\tablefield\Plugin\Field\FieldFormatter\TablefieldFormatter implements ContainerFactoryPluginInterface

Expanded class hierarchy of TablefieldFormatter

File

src/Plugin/Field/FieldFormatter/TablefieldFormatter.php, line 27

Namespace

Drupal\tablefield\Plugin\Field\FieldFormatter

View source

class TablefieldFormatter extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * Drupal\Core\Session\AccountProxy definition.
   *
   * @var \Drupal\Core\Session\AccountProxy
   */
  protected $currentUser;

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * {@inheritdoc}
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, AccountProxy $currentUser, ModuleHandlerInterface $moduleHandler) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->currentUser = $currentUser;
    $this->ModuleHandler = $moduleHandler;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('current_user'), $container
      ->get('module_handler'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'row_header' => 1,
      'column_header' => 0,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements['row_header'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display first row as a table header'),
      '#default_value' => $this
        ->getSetting('row_header'),
    ];
    $elements['column_header'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display first column as a table header'),
      '#default_value' => $this
        ->getSetting('column_header'),
    ];
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $row_header = $this
      ->getSetting('row_header');
    $column_header = $this
      ->getSetting('column_header');
    if ($row_header) {
      $summary[] = $this
        ->t('First row as a table header');
    }
    if ($column_header) {
      $summary[] = $this
        ->t('First column as a table header');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode = NULL) {
    $field = $items
      ->getFieldDefinition();
    $field_name = $field
      ->getName();
    $field_settings = $field
      ->getSettings();
    $entity = $items
      ->getEntity();
    $entity_type = $entity
      ->getEntityTypeId();
    $entity_id = $entity
      ->id();
    $row_header = $this
      ->getSetting('row_header');
    $column_header = $this
      ->getSetting('column_header');
    $elements = [];
    $header = [];
    foreach ($items as $delta => $table) {
      if (!empty($table->value)) {

        // Tablefield::rationalizeTable($table->value);.
        $tabledata = $table->value;
        $caption = $tabledata['caption'];
        unset($tabledata['caption']);

        // Run the table through input filters.
        foreach ($tabledata as $row_key => $row) {
          foreach ($row as $col_key => $cell) {
            $tabledata[$row_key][$col_key] = [
              'data' => empty($table->format) ? $cell : check_markup($cell, $table->format),
              'class' => [
                'row_' . $row_key,
                'col_' . $col_key,
              ],
            ];
          }
        }
        if ($row_header) {

          // Pull the header for theming.
          $header_data = array_shift($tabledata);

          // Check for an empty header, if so we don't want to theme it.
          $has_header = FALSE;
          foreach ($header_data as $cell) {
            if (strlen($cell['data']) > 0) {
              $has_header = TRUE;
              break;
            }
          }
          if ($has_header) {
            $header = $header_data;
          }
        }
        if ($column_header) {
          foreach ($tabledata as $row_key => $row) {
            if (strlen($tabledata[$row_key][0]['data']) > 0) {
              $tabledata[$row_key][0]['header'] = TRUE;
            }
          }
        }
        $render_array = [];

        // If the user has access to the csv export option, display it now.
        if ($field_settings['export'] && $entity_id && $this->currentUser
          ->hasPermission('export tablefield')) {
          $route_params = [
            'entity_type' => $entity_type,
            'entity' => $entity_id,
            'field_name' => $field_name,
            'langcode' => $items
              ->getLangcode(),
            'delta' => $delta,
          ];
          $url = Url::fromRoute('tablefield.export', $route_params);
          $render_array['export'] = [
            '#type' => 'container',
            '#attributes' => [
              'id' => 'tablefield-export-link-' . $delta,
              'class' => 'tablefield-export-link',
            ],
          ];
          $render_array['export']['link'] = [
            '#type' => 'link',
            '#title' => $this
              ->t('Export Table Data'),
            '#url' => $url,
          ];
        }
        $render_array['tablefield'] = [
          '#type' => 'table',
          '#header' => $header,
          '#rows' => $tabledata,
          '#attributes' => [
            'id' => 'tablefield-' . $entity_type . '-' . $entity_id . '-' . $field_name . '-' . $delta,
            'class' => [
              'tablefield',
            ],
          ],
          '#caption' => $caption,
          '#prefix' => '<div id="tablefield-wrapper-' . $entity_type . '-' . $entity_id . '-' . $field_name . '-' . $delta . '" class="tablefield-wrapper">',
          '#suffix' => '</div>',
          '#responsive' => FALSE,
        ];

        // Extend render array if responsive_tables_filter module is enabled.
        if ($this->ModuleHandler
          ->moduleExists('responsive_tables_filter')) {
          array_push($render_array['tablefield']['#attributes']['class'], 'tablesaw', 'tablesaw-stack');
          $render_array['tablefield']['#attributes']['data-tablesaw-mode'] = 'stack';
          $render_array['tablefield']['#attached'] = [
            'library' => [
              'responsive_tables_filter/tablesaw-filter',
            ],
          ];
        }
        $elements[$delta] = $render_array;
      }
    }
    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::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
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.
TablefieldFormatter::$currentUser	protected	property	Drupal\Core\Session\AccountProxy definition.
TablefieldFormatter::$moduleHandler	protected	property	The module handler.
TablefieldFormatter::create	public static	function	Creates an instance of the plugin. Overrides FormatterBase::create
TablefieldFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
TablefieldFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
TablefieldFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
TablefieldFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
TablefieldFormatter::__construct	public	function	Constructs a FormatterBase object. Overrides FormatterBase::__construct

You are here

class TablefieldFormatter in TableField 8.2

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation