function TimezoneController::getTimezone

Same name in other branches
  1. 9 core/modules/system/src/Controller/TimezoneController.php \Drupal\system\Controller\TimezoneController::getTimezone()
  2. 10 core/modules/system/src/Controller/TimezoneController.php \Drupal\system\Controller\TimezoneController::getTimezone()
  3. 11.x core/modules/system/src/Controller/TimezoneController.php \Drupal\system\Controller\TimezoneController::getTimezone()

Retrieve a JSON object containing a time zone name given a timezone abbreviation.

Parameters

string $abbreviation: Time zone abbreviation.

int $offset: Offset from GMT in seconds. Defaults to -1 which means that first found time zone corresponding to abbr is returned. Otherwise exact offset is searched and only if not found then the first time zone with any offset is returned.

null|bool $is_daylight_saving_time: Daylight saving time indicator. If abbr does not exist then the time zone is searched solely by offset and isdst.

Return value

\Symfony\Component\HttpFoundation\JsonResponse The timezone name in JsonResponse object.

1 string reference to 'TimezoneController::getTimezone'
system.routing.yml in core/modules/system/system.routing.yml
core/modules/system/system.routing.yml

File

core/modules/system/src/Controller/TimezoneController.php, line 30

Class

TimezoneController
Provides a callback for finding out a timezone name.

Namespace

Drupal\system\Controller

Code

public function getTimezone($abbreviation = '', $offset = -1, $is_daylight_saving_time = NULL) {
    // An abbreviation of "0" passed in the callback arguments should be
    // interpreted as the empty string.
    $abbreviation = $abbreviation ? $abbreviation : '';
    $timezone = timezone_name_from_abbr($abbreviation, intval($offset), $is_daylight_saving_time);
    return new JsonResponse($timezone);
}

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