Verified Commit 66d0a88f authored by Jess's avatar Jess
Browse files

Issue #3295658 by quietone, smustgrave, alexpott, tstoeckler, vijaycs85:... 

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

(cherry picked from commit f38816ed)
parent 80d0db0c

core/lib/Drupal/Core/Datetime/DateFormatter.php

+12 −6
Original line number Diff line number Diff line
@@ -315,8 +315,14 @@ public function formatDiff($from, $to, $options = []) { 
  /**

   * 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 @@ public function formatDiff($from, $to, $options = []) { 
   *   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];

  }



  /**