You are here

Home » API reference » Office Hours 8 » OfficeHoursFormatterTable.php

class OfficeHoursFormatterTable in Office Hours 8

Plugin implementation of the formatter.

Plugin annotation


@FieldFormatter(
  id = "office_hours_table",
  label = @Translation("Table"),
  field_types = {
    "office_hours",
  }
)

Hierarchy

Expanded class hierarchy of OfficeHoursFormatterTable

File

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

Namespace

Drupal\office_hours\Plugin\Field\FieldFormatter
View source 
class OfficeHoursFormatterTable extends OfficeHoursFormatterBase {

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $summary[] = $this
      ->t('Display Office hours in a table.');
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];

    // If no data is filled for this entity, do not show the formatter.
    // N.B. 'Show current day' may return nothing in getRows(),
    // while other days are filled.

    /** @var \Drupal\office_hours\Plugin\Field\FieldType\OfficeHoursItemListInterface $items */
    if (!$items
      ->getValue()) {
      return $elements;
    }
    $settings = $this
      ->getSettings();

    // For a11y screen readers, a header is introduced.
    // Superfluous comments are removed. @see #3110755 for examples and explanation.
    $isLabelEnabled = $settings['day_format'] != 'none';
    $isTimeSlotEnabled = TRUE;
    $isCommentEnabled = $this
      ->getFieldSetting('comment');

    // Build the Table part.
    $table_rows = [];
    $office_hours = $this
      ->getRows($items
      ->getValue(), $this
      ->getSettings(), $this
      ->getFieldSettings());
    foreach ($office_hours as $delta => $item) {
      $table_rows[$delta] = [
        'data' => [],
        'no_striping' => TRUE,
        'class' => [
          'office-hours__item',
        ],
      ];
      if ($isLabelEnabled) {
        $table_rows[$delta]['data']['label'] = [
          'data' => [
            '#markup' => $item['label'],
          ],
          'class' => [
            'office-hours__item-label',
          ],
          'header' => !$isCommentEnabled,
        ];
      }
      if ($isTimeSlotEnabled) {
        $table_rows[$delta]['data']['slots'] = [
          'data' => [
            '#markup' => $item['formatted_slots'],
          ],
          'class' => [
            'office-hours__item-slots',
          ],
        ];
      }
      if ($isCommentEnabled) {
        $table_rows[$delta]['data']['comments'] = [
          'data' => [
            '#markup' => $item['comments'],
          ],
          'class' => [
            'office-hours__item-comments',
          ],
        ];
      }
    }

    // @todo #2720335 Try to get the meta data into the <tr>.

    /*
        foreach ($table_rows as $delta => &$row) {
     $row['#metadata']['itemprop'] = "openingHours";
     $row['#metadata']['property'] = "openingHours";
     $row['#metadata']['content'] = "@todo";
        }
    */
    $table = [
      '#theme' => 'table',
      '#attributes' => [
        'class' => [
          'office-hours__table',
        ],
      ],
      // '#empty' => $this->t('This location has no opening hours.'),
      '#rows' => $table_rows,
      '#attached' => [
        'library' => [
          'office_hours/office_hours_formatter',
        ],
      ],
    ];
    if ($isCommentEnabled) {
      if ($isLabelEnabled) {
        $table['#header'][] = [
          'data' => $this
            ->t('Day'),
          'class' => 'visually-hidden',
        ];
      }
      $table['#header'][] = [
        'data' => $this
          ->t('Time slot'),
        'class' => 'visually-hidden',
      ];
      $table['#header'][] = [
        'data' => $this
          ->t('Comment'),
        'class' => 'visually-hidden',
      ];
    }
    $elements[] = [
      '#theme' => 'office_hours_table',
      '#table' => $table,
      '#office_hours' => $office_hours,
      '#cache' => [
        'max-age' => $this
          ->getStatusTimeLeft($items, $langcode),
        'tags' => [
          'office_hours:field.table',
        ],
      ],
    ];

    // Build the Schema part from https://schema.org/openingHours.
    if ($settings['schema']['enabled']) {
      $elements[0] = $this
        ->addSchemaFormatter($items, $langcode, $elements[0]);
    }

    // Build the Status part. May reorder elements.
    if ($settings['current_status']['position'] != "") {
      $elements = $this
        ->addStatusFormatter($items, $langcode, $elements);
    }
    return $elements;
  }

}

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
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.
OfficeHoursFormatterBase::addSchemaFormatter protected function Add an 'openingHours' formatter from https://schema.org/openingHours.
OfficeHoursFormatterBase::addStatusFormatter protected function Add a 'status' formatter before or after the hours, if necessary.
OfficeHoursFormatterBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings 1
OfficeHoursFormatterBase::getStatusTimeLeft public function
OfficeHoursFormatterBase::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm 1
OfficeHoursFormatterTable::settingsSummary public function Returns a short summary for the current formatter settings. Overrides OfficeHoursFormatterBase::settingsSummary
OfficeHoursFormatterTable::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
OfficeHoursFormatterTrait::compressSlots protected function Formatter: compress the slots: E.g., 0900-1100 + 1300-1700 = 0900-1700.
OfficeHoursFormatterTrait::formatLabels protected function Formatter: format the day name.
OfficeHoursFormatterTrait::formatSlots protected function Formatter: format the office hours list.
OfficeHoursFormatterTrait::getRows public function Returns the items of a field.
OfficeHoursFormatterTrait::groupDays protected function Formatter: group days with same slots into 1 line.
OfficeHoursFormatterTrait::keepCurrentDay protected function Formatter: remove all days, except for today.
OfficeHoursFormatterTrait::keepNextDay protected function Formatter: remove all days, except the first open day.
OfficeHoursFormatterTrait::keepOpenDays protected function Formatter: remove closed days, keeping open days.
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.