Home/ Manual/ intl / intlcalendar/ IntlCalendar::getLocale

IntlCalendar::getLocale

PHP function Edit on GitHub ✎

(PHP 5 >= 5.5.0, PHP 7, PHP 8, PECL >= 3.0.0a1)

Get the locale associated with the object

Description

Oop

IntlCalendar::getLocale(int $type): string|false

Procedural

intlcal_get_locale(IntlCalendar $calendar, int $type): string|false

Returns the locale used by this calendar object.

Parameters

calendar: Intl-calendar
type: Whether to fetch the actual locale (the locale from which the calendar data originates, with Locale::ACTUAL_LOCALE) or the valid locale, i.e., the most specific locale supported by ICU relatively to the requested locale – see Locale::VALID_LOCALE. From the most general to the most specific, the locales are ordered in this fashion – actual locale, valid locale, requested locale.

Return Values

A locale stringFalseforfailure.

Examples

IntlCalendar::getLocale()

php

<?php
$cal = IntlCalendar::createInstance(IntlTimeZone::getGMT(), 'en_US_CALIFORNIA');
var_dump(
    $cal->getLocale(Locale::ACTUAL_LOCALE),
    $cal->getLocale(Locale::VALID_LOCALE)
);

The above example will output:

output

string(2) "en"
string(5) "en_US"

Source: reference/intl/intlcalendar/getlocale.xml · from the official PHP manual (php/doc-en)