class TimeFieldMiniCalendar in Timefield 1.0.x

Plugin for the 'timefield_mini_calendar_formatter' field formatter.

Plugin annotation


@FieldFormatter(
 id = "timefield_mini_calendar_formatter",
 label = @Translation("Mini Calendar"),
 field_types = {"timefield"}
)

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\timefield\Plugin\Field\FieldFormatter\TimeFieldMiniCalendar

Expanded class hierarchy of TimeFieldMiniCalendar

File

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

Namespace

Drupal\timefield\Plugin\Field\FieldFormatter

View source

class TimeFieldMiniCalendar extends FormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'display_format' => [
        'separator' => ':',
        'period_separator' => '',
        'period' => 'a',
        'hour' => 'g',
        'minute' => 'i',
      ],
      'column_format' => [
        'separator' => ':',
        'period_separator' => '',
        'period' => 'a',
        'hour' => 'g',
        'minute' => 'i',
      ],
      'first_day' => 'mon',
      'absolute_start' => '8:00 am',
      'absolute_end' => '10:00 pm',
      'range' => 120,
      'adjust_range' => FALSE,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {

    // @todo Change the autogenerated stub
    $element = parent::settingsForm($form, $form_state);
    $settings = $this
      ->getSettings();
    $element += _timefield_display_format_form('column_format', "Column Time Settings", $settings);
    $element['first_day'] = [
      '#title' => $this
        ->t('First Day of the Week'),
      '#type' => 'select',
      '#options' => _timefield_weekly_summary_days(),
      '#default_value' => $settings['first_day'],
      '#required' => TRUE,
    ];
    $element['absolute_start'] = [
      '#title' => $this
        ->t('Mini Cal Start Time'),
      '#description' => $this
        ->t('The Start Time of the Calendar'),
      '#type' => 'textfield',
      '#default_value' => $settings['absolute_start'],
      '#size' => 15,
      '#maxlength' => 15,
      '#attributes' => [
        'class' => [
          'edit-timefield-timepicker',
          $instance_class,
        ],
      ],
    ];
    $element['absolute_end'] = [
      '#title' => $this
        ->t('Mini Cal End Time'),
      '#description' => $this
        ->t('The End Time of the Calendar'),
      '#type' => 'textfield',
      '#default_value' => $settings['absolute_end'],
      '#size' => 15,
      '#maxlength' => 15,
      '#attributes' => [
        'class' => [
          'edit-timefield-timepicker',
          $instance_class,
        ],
      ],
    ];
    $element['range'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Select the time duration of each block of time'),
      '#options' => [
        30 => $this
          ->t('30 Minutes'),
        60 => $this
          ->t('1 Hour'),
        90 => $this
          ->t('90 minutes'),
        120 => $this
          ->t('2 Hours'),
        180 => $this
          ->t('3 Hours'),
        240 => $this
          ->t('4 Hours'),
      ],
      '#default_value' => $settings['range'],
    ];
    $element['adjust_range'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Adjust Range to fit Items'),
      '#default_value' => $settings['adjust_time'],
    ];
    $element += _timefield_display_format_form('display_format', "Individual Time Display Settings", $settings);
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {

    // @todo Change the autogenerated stub
    $summary = parent::settingsSummary();
    $summary[] = $this
      ->t('Current Format: Mini Calendar Format, expand to see current Selection');
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $settings = $this
      ->getSettings();
    $label_hidden = $this->label == 'hidden';
    $header = [];
    $rows = [];
    foreach ($items as $item) {
      if (!empty($item->value)) {
        $header = _timefield_weekly_summary_build_header($settings['first_day']);
        $rows = timefield_weekly_summary_build_rows($items, $header, $settings);
      }
    }
    return [
      '#theme' => 'timefield_mini_calendar',
      '#label' => $this->fieldDefinition
        ->get('label'),
      '#label_display' => $this->label,
      '#label_hidden' => $label_hidden,
      '#header' => $header,
      '#rows' => $rows,
      '#content' => [
        '#header' => $header,
        '#rows' => $rows,
        '#theme' => 'table',
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
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	12
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	12
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
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.
TimeFieldMiniCalendar::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
TimeFieldMiniCalendar::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
TimeFieldMiniCalendar::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
TimeFieldMiniCalendar::viewElements	public	function	Builds a renderable array for a field value. Overrides FormatterInterface::viewElements

You are here

class TimeFieldMiniCalendar in Timefield 1.0.x

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation