Issue #3295658 by quietone, smustgrave, alexpott, tstoeckler, vijaycs85: Improve documentation and parameter naming for DateFormatter::dateFormat()

merge-requests/3130/merge
xjm 2022-12-18 17:22:01 -06:00
parent b232340b2f
commit f38816ed12
No known key found for this signature in database
GPG Key ID: 206B0B8743BDF4C2
1 changed files with 12 additions and 6 deletions

View File

@ -315,8 +315,14 @@ class DateFormatter implements DateFormatterInterface {
/**
* Loads the given format pattern for the given langcode.
*
* @param string $format
* The machine name of the date format.
* @param string $type
* The machine name of the date format type which is one of:
* - One of the built-in date format types: 'short', 'medium',
* 'long', 'html_datetime', 'html_date', 'html_time',
* 'html_yearless_date', 'html_week', 'html_month', 'html_year'.
* - The name of a date format type defined by a date format config entity.
* - The machine name of an administrator-defined date format type.
* - 'custom' for a custom date format type.
* @param string $langcode
* The langcode of the language to use.
*
@ -324,14 +330,14 @@ class DateFormatter implements DateFormatterInterface {
* The configuration entity for the date format in the given language for
* non-custom formats, NULL otherwise.
*/
protected function dateFormat($format, $langcode) {
if (!isset($this->dateFormats[$format][$langcode])) {
protected function dateFormat($type, $langcode) {
if (!isset($this->dateFormats[$type][$langcode])) {
$original_language = $this->languageManager->getConfigOverrideLanguage();
$this->languageManager->setConfigOverrideLanguage(new Language(['id' => $langcode]));
$this->dateFormats[$format][$langcode] = $this->dateFormatStorage->load($format);
$this->dateFormats[$type][$langcode] = $this->dateFormatStorage->load($type);
$this->languageManager->setConfigOverrideLanguage($original_language);
}
return $this->dateFormats[$format][$langcode];
return $this->dateFormats[$type][$langcode];
}
/**