class SmartDateTimezoneWidget in Smart Date 3.x

Plugin implementation of the 'smartdate_timezone' widget.

Plugin annotation

@FieldWidget(
  id = "smartdate_timezone",
  label = @Translation("Date and time range with timezone"),
  field_types = {
    "smartdate"
  }
)

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\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface
        • class \Drupal\datetime\Plugin\Field\FieldWidget\DateTimeWidgetBase
          • class \Drupal\smart_date\Plugin\Field\FieldWidget\SmartDateWidgetBase
            • class \Drupal\smart_date\Plugin\Field\FieldWidget\SmartDateDefaultWidget implements ContainerFactoryPluginInterface
              • class \Drupal\smart_date\Plugin\Field\FieldWidget\SmartDateTimezoneWidget implements ContainerFactoryPluginInterface

File

src/Plugin/Field/FieldWidget/SmartDateTimezoneWidget.php, line 20

Namespace

Drupal\smart_date\Plugin\Field\FieldWidget

class SmartDateTimezoneWidget extends SmartDateDefaultWidget implements ContainerFactoryPluginInterface {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'default_tz' => '',
      'custom_tz' => '',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $element = parent::formElement($items, $delta, $element, $form, $form_state);

    // Set default, based on field config.
    $default_label = t('- default: @tz_label -', [
      '@tz_label' => $this
        ->getSiteTimezone(),
    ]);
    switch ($this
      ->getSetting('default_tz')) {
      case '':
        $default_timezone = '';
        break;
      case 'user':
        $default_timezone = date_default_timezone_get();
        break;
      case 'custom':
        $default_timezone = $this
          ->getSetting('custom_tz');
        break;
    }
    $element['timezone']['#type'] = 'select';
    $element['timezone']['#options'] = [
      '' => $default_label,
    ] + $this
      ->getTimezones();
    $element['timezone']['#default_value'] = $items[$delta]->timezone ? $items[$delta]->timezone : $default_timezone;
    $element['timezone']['#attributes']['class'][] = 'field-timezone';
    $element['timezone']['#weight'] = 100;
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = parent::settingsForm($form, $form_state);
    $element['default_tz'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Default timezone'),
      '#default_value' => $this
        ->getSetting('default_tz'),
      '#options' => [
        '' => $this
          ->t('Site default (ignores any user override)'),
        'user' => $this
          ->t("User's timezone, defaulting to site (always saved)"),
        'custom' => $this
          ->t('A custom timezone (always saved)'),
      ],
    ];
    $custom_tz = $this
      ->getSetting('custom_tz') ? $this
      ->getSetting('custom_tz') : $this
      ->getSiteTimezone();
    $element['custom_tz'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Custom timezone'),
      '#default_value' => $custom_tz,
      '#options' => $this
        ->getTimezones(),
      '#states' => [
        // Show this select only if the 'default_tz' select is set to custom.
        'visible' => [
          'select[name$="[settings][default_tz]"]' => [
            'value' => 'custom',
          ],
        ],
      ],
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    switch ($this
      ->getSetting('default_tz')) {
      case '':
        $summary[] = $this
          ->t("The site's timezone will be used unless overridden");
        break;
      case 'user':
        $summary[] = $this
          ->t("The user's timezone will be used by default");
        break;
      case 'custom':
        $summary[] = $this
          ->t('Custom default timezone: @custom_tz', [
          '@custom_tz' => $this
            ->getSetting('custom_tz'),
        ]);
        break;
    }
    return $summary;
  }

  /**
   * Helper function to retrieve available timezones.
   */
  public function getTimezones() {
    return system_time_zones(FALSE, TRUE);
  }

  /**
   * Helper function to return only the site's timezone.
   */
  public function getSiteTimezone() {

    // Ignore PHP strict notice if time zone has not yet been set in the php.ini
    // configuration.
    $config = \Drupal::config('system.date');
    $config_data_default_timezone = $config
      ->get('timezone.default');
    return !empty($config_data_default_timezone) ? $config_data_default_timezone : @date_default_timezone_get();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DateTimeWidgetBase::createDefaultValue	protected	function	Creates a date object for use as a default value.
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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	2
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
SmartDateDefaultWidget::$dateStorage	protected	property	The date format storage.
SmartDateDefaultWidget::create	public static	function	Creates an instance of the plugin. Overrides WidgetBase::create
SmartDateDefaultWidget::__construct	public	function	Constructs a WidgetBase object. Overrides WidgetBase::__construct
SmartDateTimezoneWidget::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides SmartDateDefaultWidget::defaultSettings
SmartDateTimezoneWidget::formElement	public	function	Returns the form for a single field widget. Overrides SmartDateDefaultWidget::formElement
SmartDateTimezoneWidget::getSiteTimezone	public	function	Helper function to return only the site's timezone.
SmartDateTimezoneWidget::getTimezones	public	function	Helper function to retrieve available timezones.
SmartDateTimezoneWidget::settingsForm	public	function	Returns a form to configure settings for the widget. Overrides SmartDateDefaultWidget::settingsForm
SmartDateTimezoneWidget::settingsSummary	public	function	Returns a short summary for the current widget settings. Overrides SmartDateDefaultWidget::settingsSummary
SmartDateWidgetBase::createWidget	public static	function	Helper method to create SmartDate element.
SmartDateWidgetBase::formMultipleElements	protected	function	Special handling to create form elements for multiple values. Overrides WidgetBase::formMultipleElements
SmartDateWidgetBase::massageFormValues	public	function	Massages the form values into the format expected for field values. Overrides DateTimeWidgetBase::massageFormValues
SmartDateWidgetBase::remapDatetime	public static	function	Conditionally convert a DrupalDateTime object to a timestamp.
SmartDateWidgetBase::smartGetTimestamp	private	function	Conditionally convert a DrupalDateTime object to a timestamp.
SmartDateWidgetBase::validateStartEnd	public static	function	Ensure that the start date <= the end date via #element_validate callback.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.
WidgetBase::$fieldDefinition	protected	property	The field definition.
WidgetBase::$settings	protected	property	The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::addMoreAjax	public static	function	Ajax callback for the "Add another item" button.
WidgetBase::addMoreSubmit	public static	function	Submission handler for the "Add another item" button.
WidgetBase::afterBuild	public static	function	After-build handler for field elements in a form.
WidgetBase::errorElement	public	function	Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement	8
WidgetBase::extractFormValues	public	function	Extracts field values from submitted form values. Overrides WidgetBaseInterface::extractFormValues	2
WidgetBase::flagErrors	public	function	Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface::flagErrors	2
WidgetBase::form	public	function	Creates a form element for a field. Overrides WidgetBaseInterface::form	3
WidgetBase::formSingleElement	protected	function	Generates the form element for a single copy of the widget.
WidgetBase::getFieldSetting	protected	function	Returns the value of a field setting.
WidgetBase::getFieldSettings	protected	function	Returns the array of field settings.
WidgetBase::getFilteredDescription	protected	function	Returns the filtered field description.
WidgetBase::getWidgetState	public static	function	Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface::getWidgetState
WidgetBase::getWidgetStateParents	protected static	function	Returns the location of processing information within $form_state.
WidgetBase::handlesMultipleValues	protected	function	Returns whether the widget handles multiple values.
WidgetBase::isApplicable	public static	function	Returns if the widget can be used for the provided field. Overrides WidgetInterface::isApplicable	4
WidgetBase::isDefaultValueWidget	protected	function	Returns whether the widget used for default value form.
WidgetBase::setWidgetState	public static	function	Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState