mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 23:08:55 +00:00
fc1383edb3
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@332615 c90b9560-bf6c-de11-be94-00142212c4b1
113 lines
3 KiB
XML
113 lines
3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
||
<!-- $Revision$ -->
|
||
|
||
<refentry xml:id="intlcalendar.getlocale" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||
<refnamediv>
|
||
<refname>IntlCalendar::getLocale</refname>
|
||
<refpurpose>Get the locale associated with the object</refpurpose>
|
||
</refnamediv>
|
||
|
||
<refsect1 role="description">
|
||
&reftitle.description;
|
||
<para>
|
||
&style.oop;
|
||
</para>
|
||
<methodsynopsis>
|
||
<modifier>public</modifier> <type>string</type><methodname>IntlCalendar::getLocale</methodname>
|
||
<methodparam><type>int</type><parameter>localeType</parameter></methodparam>
|
||
</methodsynopsis>
|
||
<para>
|
||
&style.procedural;
|
||
</para>
|
||
<methodsynopsis>
|
||
<type>string</type><methodname>intlcal_get_locale</methodname>
|
||
<methodparam><type>IntlCalendar</type><parameter>cal</parameter></methodparam>
|
||
<methodparam><type>int</type><parameter>localeType</parameter></methodparam>
|
||
</methodsynopsis>
|
||
<para>
|
||
Returns the locale used by this calendar object.
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1 role="parameters">
|
||
&reftitle.parameters;
|
||
<variablelist>
|
||
<varlistentry>
|
||
<term><parameter>cal</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
The IntlCalendar resource.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
<varlistentry>
|
||
<term><parameter>localeType</parameter></term>
|
||
<listitem>
|
||
<para>
|
||
Whether to fetch the actual locale (the locale from which the calendar
|
||
data originates, with <constant>Locale::ACTUAL_LOCALE</constant>) or the
|
||
valid locale, i.e., the most specific locale supported by ICU relatively
|
||
to the requested locale – see <constant>Locale::VALID_LOCALE</constant>.
|
||
From the most general to the most specific, the locales are ordered in
|
||
this fashion – actual locale, valid locale, requested locale.
|
||
</para>
|
||
</listitem>
|
||
</varlistentry>
|
||
</variablelist>
|
||
</refsect1>
|
||
|
||
<refsect1 role="returnvalues">
|
||
&reftitle.returnvalues;
|
||
<para>
|
||
A locale string&return.falseforfailure;.
|
||
</para>
|
||
</refsect1>
|
||
|
||
<refsect1 role="examples">
|
||
&reftitle.examples;
|
||
<para>
|
||
<example>
|
||
<title><function>IntlCalendar::getLocale</function></title>
|
||
<programlisting role="php">
|
||
<![CDATA[
|
||
<?php
|
||
$cal = IntlCalendar::createInstance(IntlTimeZone::getGMT(), 'en_US_CALIFORNIA');
|
||
var_dump(
|
||
$cal->getLocale(Locale::ACTUAL_LOCALE),
|
||
$cal->getLocale(Locale::VALID_LOCALE)
|
||
);
|
||
]]>
|
||
</programlisting>
|
||
&example.outputs;
|
||
<screen>
|
||
<![CDATA[
|
||
string(2) "en"
|
||
string(5) "en_US"
|
||
]]>
|
||
</screen>
|
||
</example>
|
||
</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
|
||
-->
|