IntlDateFormatter::getCalendarObject

datefmt_get_calendar_object

Get copy of formatterʼs calendar object

&reftitle.description;

&style.oop;

public ``IntlCalendar``false``null```IntlDateFormatter::getCalendarObject`

&style.procedural;

``IntlCalendar``false``null```datefmt_get_calendar_object` `IntlDateFormatter` `formatter`

Obtain a copy of the calendar object used internally by this formatter. This calendar will have a type (as in gregorian, japanese, buddhist, roc, persian, islamic, etc.) and a timezone that match the type and timezone used by the formatter. The date/time of the object is unspecified.

&reftitle.parameters; &no.function.parameters;
&reftitle.returnvalues;

A copy of the internal calendar object used by this formatter, or &null; if none has been set, &return.falseforfailure;.

&reftitle.examples;

### `IntlDateFormatter::getCalendarObject` example

    <?php
    $formatter = IntlDateFormatter::create(
        "fr_FR@calendar=islamic",
        NULL,
        NULL,
        "GMT-01:00",
        IntlDateFormatter::TRADITIONAL
    );

    $cal = $formatter->getCalendarObject();

    var_dump(
        $cal->getType(),
        $cal->getTimeZone(),
        $cal->getLocale(Locale::VALID_LOCALE)
    );

&example.outputs;

    string(7) "islamic"
    object(IntlTimeZone)#3 (4) {
      ["valid"]=>
      bool(true)
      ["id"]=>
      string(9) "GMT-01:00"
      ["rawOffset"]=>
      int(-3600000)
      ["currentOffset"]=>
      int(-3600000)
    }
    string(5) "fr_FR"

&reftitle.seealso;

- `IntlDateFormatter::getCalendar`
- `IntlDateFormatter::setCalendar`
- `IntlCalendar`