TimeZoneItem.php

Same filename in other branches
  1. 8.9.x core/modules/user/src/TimeZoneItem.php
  2. 10 core/modules/user/src/TimeZoneItem.php
  3. 11.x core/modules/user/src/TimeZoneItem.php

Namespace

Drupal\user

File

core/modules/user/src/TimeZoneItem.php

View source
<?php

namespace Drupal\user;

use Drupal\Core\Field\FieldDefinitionInterface;
use Drupal\Core\Field\Plugin\Field\FieldType\StringItem;
use Drupal\user\Entity\User;

/**
 * Defines a custom field item class for the 'timezone' user entity field.
 */
class TimeZoneItem extends StringItem {
    
    /**
     * {@inheritdoc}
     */
    public static function generateSampleValue(FieldDefinitionInterface $field_definition) {
        $timezones = User::getAllowedTimezones();
        // We need to vary the selected timezones since we're generating a sample.
        $key = rand(0, count($timezones) - 1);
        return $timezones[$key];
    }

}

Classes

Title Deprecated Summary
TimeZoneItem Defines a custom field item class for the 'timezone' user entity field.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.