<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="intldateformatter.getcalendarobject" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>IntlDateFormatter::getCalendarObject</refname>
  <refname>datefmt_get_calendar_object</refname>
  <refpurpose>Get copy of formatterʼs calendar object</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <para>
   &style.oop;
  </para>
  <methodsynopsis role="IntlDateFormatter">
   <modifier>public</modifier> <type class="union"><type>IntlCalendar</type><type>false</type><type>null</type></type><methodname>IntlDateFormatter::getCalendarObject</methodname>
   <void/>
  </methodsynopsis>
  <para>
   &style.procedural;
  </para>
  <methodsynopsis>
   <type class="union"><type>IntlCalendar</type><type>false</type><type>null</type></type><methodname>datefmt_get_calendar_object</methodname>
   <methodparam><type>IntlDateFormatter</type><parameter>formatter</parameter></methodparam>
  </methodsynopsis>
  
  <para>
   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.
  </para>
  
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  &no.function.parameters;
 </refsect1>
 
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   A copy of the internal calendar object used by this formatter,
   or &null; if none has been set, &return.falseforfailure;.
  </para>
 </refsect1>
 
 
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>IntlDateFormatter::getCalendarObject</function> example</title>
    <programlisting role="php">
<![CDATA[
<?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)
);

]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
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"
]]>
    </screen>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>IntlDateFormatter::getCalendar</function></member>
    <member><function>IntlDateFormatter::setCalendar</function></member>
    <member><classname>IntlCalendar</classname></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
