View source
<?php
namespace Drupal\office_hours\Plugin\Field\FieldType;
use Drupal\Core\Field\FieldDefinitionInterface;
use Drupal\Core\Field\FieldItemBase;
use Drupal\Core\Field\FieldStorageDefinitionInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\TypedData\DataDefinition;
use Drupal\office_hours\Element\OfficeHoursDatetime;
use Drupal\office_hours\OfficeHoursDateHelper;
class OfficeHoursItem extends FieldItemBase {
public static function schema(FieldStorageDefinitionInterface $field_definition) {
return [
'columns' => [
'day' => [
'type' => 'int',
'not null' => FALSE,
],
'starthours' => [
'type' => 'int',
'not null' => FALSE,
],
'endhours' => [
'type' => 'int',
'not null' => FALSE,
],
'comment' => [
'type' => 'varchar',
'length' => 255,
'not null' => FALSE,
],
],
];
}
public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
$properties['day'] = DataDefinition::create('integer')
->setLabel(t('Day'))
->setDescription("Stores the day of the week's numeric representation (0=Sun, 6=Sat)");
$properties['starthours'] = DataDefinition::create('integer')
->setLabel(t('Start hours'))
->setDescription("Stores the start hours value");
$properties['endhours'] = DataDefinition::create('integer')
->setLabel(t('End hours'))
->setDescription("Stores the end hours value");
$properties['comment'] = DataDefinition::create('string')
->setLabel(t('Comment'))
->addConstraint('Length', [
'max' => 255,
])
->setDescription("Stores the comment");
return $properties;
}
public static function defaultStorageSettings() {
$defaultStorageSettings = [
'time_format' => 'G',
'element_type' => 'office_hours_datelist',
'increment' => 30,
'required_start' => FALSE,
'required_end' => FALSE,
'limit_start' => '',
'limit_end' => '',
'comment' => 1,
'valhrs' => FALSE,
'cardinality_per_day' => 2,
] + parent::defaultStorageSettings();
return $defaultStorageSettings;
}
public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
$element = parent::storageSettingsForm($form, $form_state, $has_data);
$settings = $this
->getFieldDefinition()
->getFieldStorageDefinition()
->getSettings();
$hours = OfficeHoursDateHelper::hours('H', FALSE);
foreach ($hours as $key => &$hour) {
if (!empty($hour)) {
$hrs = OfficeHoursDateHelper::format($hour . '00', 'H:i');
$ampm = OfficeHoursDateHelper::format($hour . '00', 'g:i a');
$hour = "{$hrs} ({$ampm})";
}
}
$element['#element_validate'] = [
[
static::class,
'validateOfficeHoursSettings',
],
];
$description = $this
->t('The maximum number of time slots, that are allowed per day.
<br/><strong> Warning! Lowering this setting after data has been created
could result in the loss of data! </strong><br/> Be careful when using
more then 2 slots per day, since not all external services (like Google
Places) support this.');
$element['cardinality_per_day'] = [
'#type' => 'select',
'#title' => $this
->t('Number of time slots per day'),
'#options' => array_combine(range(1, 12), range(1, 12)),
'#default_value' => $settings['cardinality_per_day'],
'#description' => $description,
];
$element['time_format'] = [
'#type' => 'select',
'#title' => $this
->t('Time notation'),
'#options' => [
'G' => $this
->t('24 hour time @example', [
'@example' => '(9:00)',
]),
'H' => $this
->t('24 hour time @example', [
'@example' => '(09:00)',
]),
'g' => $this
->t('12 hour time @example', [
'@example' => '09:00 am)',
]),
'h' => $this
->t('12 hour time @example', [
'@example' => '(09:00 am)',
]),
],
'#default_value' => $settings['time_format'],
'#required' => FALSE,
'#description' => $this
->t('Format of the time in the widget.'),
];
$element['element_type'] = [
'#type' => 'select',
'#title' => $this
->t('Time element type'),
'#description' => $this
->t('Select the widget type for selecting the time.'),
'#options' => [
'office_hours_datelist' => 'Select list',
'office_hours_datetime' => 'HTML5 time input',
],
'#default_value' => $this
->getSetting('element_type'),
];
$element['increment'] = [
'#type' => 'select',
'#title' => $this
->t('Time increments'),
'#default_value' => $settings['increment'],
'#options' => [
1 => $this
->t('1 minute'),
5 => $this
->t('5 minute'),
15 => $this
->t('15 minute'),
30 => $this
->t('30 minute'),
60 => $this
->t('60 minute'),
],
'#required' => FALSE,
'#description' => $this
->t('Restrict the input to fixed fractions of an hour.'),
];
$element['comment'] = [
'#type' => 'select',
'#title' => $this
->t('Allow a comment per time slot'),
'#required' => FALSE,
'#default_value' => $settings['comment'],
'#options' => [
0 => $this
->t('No comments allowed'),
1 => $this
->t('Allow comments (HTML tags possible)'),
2 => $this
->t('Allow translatable comments (no HTML)'),
],
];
$element['valhrs'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Validate hours'),
'#required' => FALSE,
'#default_value' => $settings['valhrs'],
'#description' => $this
->t('Assure that endhours are later then starthours.
Please note that this will work as long as both hours are set and
the opening hours are not through midnight.'),
];
$element['required_start'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Require Start time'),
'#default_value' => $settings['required_start'],
];
$element['required_end'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Require End time'),
'#default_value' => $settings['required_end'],
];
$element['limit_start'] = [
'#type' => 'select',
'#title' => $this
->t('Limit hours - from'),
'#description' => $this
->t('Restrict the hours available - select options will start from this hour.'),
'#default_value' => $settings['limit_start'],
'#options' => $hours,
];
$element['limit_end'] = [
'#type' => 'select',
'#title' => $this
->t('Limit hours - until'),
'#description' => $this
->t('Restrict the hours available - select options
will end at this hour. You may leave \'until\' time empty.
Use \'00:00\' for closing at midnight.'),
'#default_value' => $settings['limit_end'],
'#options' => $hours,
];
return $element;
}
public static function generateSampleValue(FieldDefinitionInterface $field_definition) {
$values['day'] = mt_rand(0, 6);
$values['starthours'] = mt_rand(00, 23) * 100;
$values['endhours'] = mt_rand(00, 23) * 100;
$values['comment'] = mt_rand(0, 1) ? 'additional text' : '';
return $values;
}
public function isEmpty() {
return OfficeHoursDatetime::isEmpty($this
->getValue());
}
public function getConstraints() {
$constraints = [];
$max_length = $this
->getSetting('max_length');
if ($max_length) {
$constraint_manager = \Drupal::typedDataManager()
->getValidationConstraintManager();
$constraints[] = $constraint_manager
->create('ComplexData', [
'value' => [
'Length' => [
'max' => $max_length,
'maxMessage' => $this
->t('%name: may not be longer than @max characters.', [
'%name' => $this
->getFieldDefinition()
->getLabel(),
'@max' => $max_length,
]),
],
],
]);
}
return $constraints;
}
public static function validateOfficeHoursSettings(array $element, FormStateInterface &$form_state) {
if (!empty($element['limit_end']['#value']) && $element['limit_end']['#value'] < $element['limit_start']['#value']) {
$form_state
->setError($element['limit_start'], t('%start is later then %end.', [
'%start' => $element['limit_start']['#title'],
'%end' => $element['limit_end']['#title'],
]));
}
}
}
