You are here

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

class OfficeHoursSlot in Office Hours 8

Provides a one-line text field form element for the Week Widget.

Plugin annotation

@FormElement("office_hours_slot");

Hierarchy

Expanded class hierarchy of OfficeHoursSlot

1 #type use of OfficeHoursSlot
OfficeHoursDefaultWidget::formElement in src/Plugin/Field/FieldWidget/OfficeHoursDefaultWidget.php
Returns the form for a single field widget.

File

src/Element/OfficeHoursSlot.php, line 12

Namespace

Drupal\office_hours\Element
View source 
class OfficeHoursSlot extends OfficeHoursList {

  /**
   * {@inheritdoc}
   */
  public static function processOfficeHoursSlot(&$element, FormStateInterface $form_state, &$complete_form) {

    // Fill with default data from a List element.
    $element = parent::processOfficeHoursSlot($element, $form_state, $complete_form);
    $max_delta = $element['#field_settings']['cardinality_per_day'] - 1;
    $day_delta = $element['#daydelta'];
    $day = isset($element['#value']['day']) ? (int) $element['#value']['day'] : '';
    if ($day_delta == 0) {

      // This is the first slot of the day.
      // Display the slot with Day name (already translated) as label.
      $label = $element['#dayname'];
    }
    elseif ($day_delta > $max_delta) {

      // Never show this illegal slot.
      // In case the number of slots per day was lowered by admin, this element
      // may have a value. Better clear it (in case a value was entered before).
      // The value will be removed upon the next 'Save' action.
      $label = '';

      // The following style is only needed if js isn't working.
      // The following class is the trigger for js to hide the row.
      $element['#attributes']['class'][] = 'office-hours-hide';
      $element['#value'] = empty($element['#value'] ? [] : $element['#value']);
      $element['#value']['starthours'] = '';
      $element['#value']['endhours'] = '';
      $element['#value']['comment'] = '';
    }
    elseif (isset($element['#value']['starthours']) && (!empty($element['#value']['starthours']) || $element['#value']['starthours'] === '0')) {

      // @todo Use OfficeHoursDateTime::isEmpty()?
      // This is a following slot with contents.
      $label = t('and');

      // Display the slot and display Add-link.
      $element['#attributes']['class'][] = 'office-hours-more';
    }
    else {

      // This is an empty following slot.
      $label = t('and');

      // Hide the slot and add Add-link, in case shown by js.
      $element['#attributes']['class'][] = 'office-hours-hide';
      $element['#attributes']['class'][] = 'office-hours-more';
    }

    // Override (hide) the 'day' select-field.
    $element['day'] = [
      '#type' => 'hidden',
      '#prefix' => $day_delta ? "<div class='office-hours-more-label'>{$label}</div>" : "<div class='office-hours-label'>{$label}</div>",
      '#default_value' => $day,
      '#value' => $day,
    ];
    $element['#attributes']['class'][] = "office-hours-day-{$day}";
    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
FormElement::processAutocomplete public static function Adds autocomplete functionality to elements.
FormElement::processPattern public static function #process callback for #pattern form element property.
FormElement::validatePattern public static function #element_validate callback for #pattern form element property.
FormElement::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback 15
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
OfficeHoursList::getDefaultOperations public static function Gets this list element's default operations.
OfficeHoursList::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
OfficeHoursList::validateOfficeHoursSlot public static function Render API callback: Validates the element.
OfficeHoursSlot::processOfficeHoursSlot public static function Process an individual element. Overrides OfficeHoursList::processOfficeHoursSlot
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
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.