abstract class OfficeHoursFormatterBase in Office Hours 8

Abstract plugin implementation of the formatter.

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\office_hours\Plugin\Field\FieldFormatter\OfficeHoursFormatterBase uses OfficeHoursFormatterTrait

Expanded class hierarchy of OfficeHoursFormatterBase

File

src/Plugin/Field/FieldFormatter/OfficeHoursFormatterBase.php, line 17

Namespace

Drupal\office_hours\Plugin\Field\FieldFormatter

View source

abstract class OfficeHoursFormatterBase extends FormatterBase {
  use OfficeHoursFormatterTrait;

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'day_format' => 'long',
      'time_format' => 'G',
      'compress' => FALSE,
      'grouped' => FALSE,
      'show_closed' => 'all',
      'closed_format' => 'Closed',
      'separator' => [
        'days' => '<br />',
        'grouped_days' => ' - ',
        'day_hours' => ': ',
        'hours_hours' => '-',
        'more_hours' => ', ',
      ],
      'current_status' => [
        'position' => '',
        // Hidden.
        'open_text' => 'Currently open!',
        'closed_text' => 'Currently closed',
      ],
      'schema' => [
        'enabled' => FALSE,
      ],
      'timezone_field' => '',
      'office_hours_first_day' => '',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = parent::settingsForm($form, $form_state);
    $settings = $this
      ->getSettings();
    $day_names = OfficeHoursDateHelper::weekDays(FALSE);
    $day_names[''] = $this
      ->t("- system's Regional settings -");

    /*
        // Find timezone fields, to be used in 'Current status'-option.
        $fields = field_info_instances( (isset($form['#entity_type']) ? $form['#entity_type'] : NULL), (isset($form['#bundle']) ? $form['#bundle'] : NULL));
        $timezone_fields = [];
        foreach ($fields as $field_name => $timezone_instance) {
     if ($field_name == $field['field_name']) {
       continue;
     }
     $timezone_field = field_read_field($field_name);

     if (in_array($timezone_field['type'], ['tzfield'])) {
       $timezone_fields[$timezone_instance['field_name']] = $timezone_instance['label'] . ' (' . $timezone_instance['field_name'] . ')';
     }
        }
        if ($timezone_fields) {
     $timezone_fields = ['' => '<None>'] + $timezone_fields;
        }
    */
    $element['show_closed'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Number of days to show'),
      '#options' => [
        'all' => $this
          ->t('Show all days'),
        'open' => $this
          ->t('Show only open days'),
        'next' => $this
          ->t('Show next open day'),
        'none' => $this
          ->t('Hide all days'),
        'current' => $this
          ->t('Show only current day'),
      ],
      '#default_value' => $settings['show_closed'],
      '#description' => $this
        ->t('The days to show in the formatter. Useful in combination with the Current Status block.'),
    ];

    // First day of week, copied from system.variable.inc.
    $element['office_hours_first_day'] = [
      '#type' => 'select',
      '#options' => $day_names,
      '#title' => $this
        ->t('First day of week'),
      '#default_value' => $this
        ->getSetting('office_hours_first_day'),
    ];
    $element['day_format'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Day notation'),
      '#options' => [
        'long' => $this
          ->t('long'),
        'short' => $this
          ->t('3-letter weekday abbreviation'),
        'two_letter' => $this
          ->t('2-letter weekday abbreviation'),
        'number' => $this
          ->t('number'),
        'none' => $this
          ->t('none'),
      ],
      '#default_value' => $settings['day_format'],
    ];
    $element['time_format'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Time notation'),
      '#options' => [
        'G' => $this
          ->t('24 hour time') . ' (9:00)',
        // D7: key = 0.
        'H' => $this
          ->t('24 hour time') . ' (09:00)',
        // D7: key = 2.
        'g' => $this
          ->t('12 hour time') . ' (9:00 am)',
        // D7: key = 1.
        'h' => $this
          ->t('12 hour time') . ' (09:00 am)',
      ],
      '#default_value' => $settings['time_format'],
      '#required' => FALSE,
      '#description' => $this
        ->t('Format of the clock in the formatter.'),
    ];
    $element['compress'] = [
      '#title' => $this
        ->t('Compress all hours of a day into one set'),
      '#type' => 'checkbox',
      '#default_value' => $settings['compress'],
      '#description' => $this
        ->t('Even if more hours is allowed, you might want to show a compressed form. E.g., 7:00-12:00, 13:30-19:00 becomes 7:00-19:00.'),
      '#required' => FALSE,
    ];
    $element['grouped'] = [
      '#title' => $this
        ->t('Group consecutive days with same hours into one set'),
      '#type' => 'checkbox',
      '#default_value' => $settings['grouped'],
      '#description' => $this
        ->t('E.g., Mon: 7:00-19:00; Tue: 7:00-19:00 becomes Mon-Tue: 7:00-19:00.'),
      '#required' => FALSE,
    ];
    $element['closed_format'] = [
      '#type' => 'textfield',
      '#size' => 30,
      '#title' => $this
        ->t('Empty days notation'),
      '#default_value' => $settings['closed_format'],
      '#required' => FALSE,
      '#description' => $this
        ->t('Format of empty (closed) days. String
        <a>can be translated</a> when the
        <a href=":install">Interface Translation module</a> is installed.', [
        ':install' => Url::fromRoute('system.modules_list')
          ->toString(),
      ]),
    ];

    // Taken from views_plugin_row_fields.inc.
    $element['separator'] = [
      '#title' => $this
        ->t('Separators'),
      '#type' => 'details',
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    ];
    $element['separator']['days'] = [
      '#type' => 'textfield',
      '#size' => 10,
      '#default_value' => $settings['separator']['days'],
      '#description' => $this
        ->t('This separator will be placed between the days. Use &#39&ltbr&gt&#39 to show each day on a new line.'),
    ];
    $element['separator']['grouped_days'] = [
      '#type' => 'textfield',
      '#size' => 10,
      '#default_value' => $settings['separator']['grouped_days'],
      '#description' => $this
        ->t('This separator will be placed between the labels of grouped days.'),
    ];
    $element['separator']['day_hours'] = [
      '#type' => 'textfield',
      '#size' => 10,
      '#default_value' => $settings['separator']['day_hours'],
      '#description' => $this
        ->t('This separator will be placed between the day and the hours.'),
    ];
    $element['separator']['hours_hours'] = [
      '#type' => 'textfield',
      '#size' => 10,
      '#default_value' => $settings['separator']['hours_hours'],
      '#description' => $this
        ->t('This separator will be placed between the hours of a day.'),
    ];
    $element['separator']['more_hours'] = [
      '#type' => 'textfield',
      '#size' => 10,
      '#default_value' => $settings['separator']['more_hours'],
      '#description' => $this
        ->t('This separator will be placed between the hours and more_hours of a day.'),
    ];

    // Show a 'Current status' option.
    $element['current_status'] = [
      '#title' => $this
        ->t('Current status'),
      '#type' => 'details',
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
      '#description' => $this
        ->t('Below strings <a>can be translated</a> when the
        <a href=":install">Interface Translation module</a> is installed.', [
        ':install' => Url::fromRoute('system.modules_list')
          ->toString(),
      ]),
    ];
    $element['current_status']['position'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Current status position'),
      '#options' => [
        '' => $this
          ->t('Hidden'),
        'before' => $this
          ->t('Before hours'),
        'after' => $this
          ->t('After hours'),
      ],
      '#default_value' => $settings['current_status']['position'],
      '#description' => $this
        ->t('Where should the current status be located?'),
    ];
    $element['current_status']['open_text'] = [
      '#title' => $this
        ->t('Status strings'),
      '#type' => 'textfield',
      '#size' => 40,
      '#default_value' => $settings['current_status']['open_text'],
      '#description' => $this
        ->t('Format of the message displayed when currently open.'),
    ];
    $element['current_status']['closed_text'] = [
      '#type' => 'textfield',
      '#size' => 40,
      '#default_value' => $settings['current_status']['closed_text'],
      '#description' => $this
        ->t('Format of message displayed when currently closed.'),
    ];
    $element['schema'] = [
      '#title' => $this
        ->t('Schema.org openingHours support'),
      '#type' => 'details',
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    ];
    $element['schema']['enabled'] = [
      '#title' => $this
        ->t('Enable Schema.org openingHours support'),
      '#type' => 'checkbox',
      '#default_value' => $settings['schema']['enabled'],
      '#description' => $this
        ->t('Enable meta tags with property for Schema.org openingHours.'),
      '#required' => FALSE,
    ];

    /*
        if ($timezone_fields) {
     $element['timezone_field'] = [
       '#type' => 'select',
       '#title' => $this->t('Timezone') . ' ' . $this->t('Field'),
       '#options' => $timezone_fields,
       '#default_value' => $settings['timezone_field'],
       '#description' => $this->t('Should we use another field to set the timezone for these hours?'),
     ];
        }
        else {
     $element['timezone_field'] = [
       '#type' => 'hidden',
       '#value' => $settings['timezone_field'],
     ];
        }
    */
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();

    // @todo Return more info, like Date module does.
    $summary[] = $this
      ->t('Display Office hours in different formats.');
    return $summary;
  }

  /**
   * Add an 'openingHours' formatter from https://schema.org/openingHours.
   *
   * @param \Drupal\office_hours\Plugin\Field\FieldType\OfficeHoursItemListInterface $items
   * @param $langcode
   * @param array $elements
   *
   * @return array
   */
  protected function addSchemaFormatter(OfficeHoursItemListInterface $items, $langcode, array $elements) {
    $formatter = new OfficeHoursFormatterSchema($this->pluginId, $this->pluginDefinition, $this->fieldDefinition, $this->settings, $this->viewMode, $this->label, $this->thirdPartySettings);
    $new_element = $formatter
      ->viewElements($items, $langcode);
    $schema_items = [];
    foreach ($new_element[0]['#office_hours'] as $schema) {
      $schema_items[] = [
        'label' => $schema['label'],
        'formatted_slots' => $schema['formatted_slots'],
      ];
    }
    $elements['#schema'] = [
      '#theme' => 'office_hours',
      '#office_hours' => [
        'schema' => $schema_items,
      ],
      '#cache' => [
        'max-age' => $this
          ->getStatusTimeLeft($items, $langcode),
        'tags' => [
          'office_hours:field.default',
        ],
      ],
    ];
    return $elements;
  }

  /**
   * Add a 'status' formatter before or after the hours, if necessary.
   *
   * @param \Drupal\office_hours\Plugin\Field\FieldType\OfficeHoursItemListInterface $items
   * @param $langcode
   * @param array $elements
   *
   * @return array
   */
  protected function addStatusFormatter(OfficeHoursItemListInterface $items, $langcode, array $elements) {
    if (!empty($this->settings['current_status']['position'])) {
      $formatter = new OfficeHoursFormatterStatus($this->pluginId, $this->pluginDefinition, $this->fieldDefinition, $this->settings, $this->viewMode, $this->label, $this->thirdPartySettings);
      $new_element = $formatter
        ->viewElements($items, $langcode);
      switch ($new_element['#position']) {
        case 'before':
          array_unshift($elements, $new_element);
          break;
        case 'after':
          array_push($elements, $new_element);
          break;
        default:
          break;
      }
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public function getStatusTimeLeft(OfficeHoursItemListInterface $items, $langcode) {

    // @see https://www.drupal.org/docs/8/api/cache-api/cache-max-age
    // If there are no open days, cache forever.
    if (empty($items
      ->getValue())) {
      return Cache::PERMANENT;
    }
    $date = new DrupalDateTime('now');
    $today = $date
      ->format('w');
    $now = $date
      ->format('Hi');
    $seconds = $date
      ->format('s');
    $next_time = '0000';
    $add_days = 0;

    // Get some settings from field. Do not overwrite defaults.
    $settings = $this
      ->getSettings();

    // Return the filtered days/slots/items/rows.
    switch ($settings['show_closed']) {
      case 'all':
      case 'open':
      case 'none':

        // These caches never expire, since they are always correct.
        return Cache::PERMANENT;
      case 'current':

        // Cache expires at midnight.
        $next_time = '0000';
        $add_days = 1;
        break;
      case 'next':

        // Get the first (and only) day of the list.
        // Make sure we only receive 1 day, only to calculate the cache.
        $office_hours = $this
          ->getRows($items
          ->getValue(), $this
          ->getSettings(), $this
          ->getFieldSettings());
        $next = array_shift($office_hours);

        // Get the difference in hours/minutes between 'now' and next open/closing time.
        $first_time = NULL;
        foreach ($next['slots'] as $slot) {
          $start = $slot['start'];
          $end = $slot['end'];
          if ($next['startday'] != $today) {

            // We will open tomorrow or later.
            $next_time = $start;
            $add_days = ($next['startday'] - $today + 7) % 7;
            break;
          }
          elseif ($start > $now) {

            // We will open later today.
            $next_time = $start;
            $add_days = 0;
            break;
          }
          elseif ($start > $end || $start == $end || $start < $end && $end > $now) {
            $next_time = $end;
            $add_days = $start < $end ? 0 : 1;

            // Add 1 day if open until after midnight.
            break;
          }
          else {

            // We were open today. Take the first slot of the day.
            if (!isset($first_time_slot_found)) {
              $first_time_slot_found = TRUE;
              $next_time = $start;
              $add_days = 7;
            }
            continue;

            // A new slot might come along.
          }
        }
        break;
      default:

        // We should have covered all options above.
        return Cache::PERMANENT;
    }

    // Set to 0 to avoid php error if time field is not set.
    $next_time = is_numeric($next_time) ? $next_time : '0000';

    // Calculate the remaining cache time.
    $time_left = (int) $add_days * 24 * 3600;
    $time_left += (int) (substr($next_time, 0, 2) - substr($now, 0, 2)) * 3600;
    $time_left += (int) (substr($next_time, 2, 2) - substr($now, 2, 2)) * 60;
    $time_left -= $seconds;

    // Correct for the current minute.
    return $time_left;
  }

}

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::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
FormatterInterface::viewElements	public	function	Builds a renderable array for a field value.	47
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
OfficeHoursFormatterBase::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary	3
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.

You are here

abstract class OfficeHoursFormatterBase in Office Hours 8

Hierarchy

File

Namespace

Members

API Navigation