You are here

public function JalaliDateFormatter::format in PersianTools 8

Formats a date, using a date type or a custom date format string.

Parameters

int $timestamp: A UNIX timestamp to format.

string $type: (optional) The format to use, one of:

  • One of the built-in formats: 'short', 'medium', 'long', 'html_datetime', 'html_date', 'html_time', 'html_yearless_date', 'html_week', 'html_month', 'html_year'.
  • The name of a date type defined by a date format config entity.
  • The machine name of an administrator-defined date format.
  • 'custom', to use $format.

Defaults to 'medium'.

string $format: (optional) If $type is 'custom', a PHP date format string suitable for input to date(). Use a backslash to escape ordinary text, so it does not get interpreted as date format characters.

string|null $timezone: (optional) Time zone identifier, as described at http://php.net/manual/timezones.php Defaults to the time zone used to display the page.

string|null $langcode: (optional) Language code to translate to. NULL (default) means to use the user interface language for the page.

Return value

string A translated date string in the requested format. Since the format may contain user input, this value should be escaped when output.

Overrides DateFormatter::format

File

jalalidate/src/JalaliDateFormatter.php, line 20
Contains \Drupal\jalalidate\JalaliDate.

Class

JalaliDateFormatter
Overrides the drupal date service to provide a jalali date.

Namespace

Drupal\jalalidate

Code

public function format($timestamp, $type = 'medium', $format = '', $timezone = NULL, $langcode = NULL) {
  if (empty($langcode)) {
    $langcode = $this->languageManager
      ->getCurrentLanguage()
      ->getId();
  }
  if ($langcode != "fa" || !class_exists('IntlDateFormatter')) {
    return parent::format($timestamp, $type, $format, $timezone, $langcode);
  }
  if (!isset($timezone)) {
    $timezone = date_default_timezone_get();
  }

  // Store DateTimeZone objects in an array rather than repeatedly
  // constructing identical objects over the life of a request.
  if (!isset($this->timezones[$timezone])) {
    $this->timezones[$timezone] = timezone_open($timezone);
  }

  // If we have a non-custom date format use the provided date format pattern.
  if ($date_format = $this
    ->dateFormat($type, $langcode)) {
    switch ($date_format) {
      case 'short':
        $format = 'Y/M/d';
        break;
      case 'medium':
        $format = 'Y/M/d - H:m';
        break;
      case 'long':
        $format = 'EEEE Y/M/d - H:m';
        break;
    }
  }

  // Fall back to medium if a format was not found.
  if (empty($format)) {
    $format = 'EEEE Y/M/d - H:m';
  }
  $date = new \IntlDateFormatter("fa_IR@calendar=persian", \IntlDateFormatter::FULL, \IntlDateFormatter::SHORT, $timezone, \IntlDateFormatter::TRADITIONAL);
  $date
    ->setPattern($format);
  return $date
    ->format(intval($timestamp));
}