getkeywordvaluesforlocale.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1976eae0d815797af97a1e16c5cd90ffc2868395 Maintainer: mumumu Status: ready -->
<refentry xml:id="intlcalendar.getkeywordvaluesforlocale" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>IntlCalendar::getKeywordValuesForLocale</refname>
  <refpurpose>ロケールのキーワードの値の集合を返す</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>
   &style.oop;
  </para>
  <methodsynopsis role="IntlCalendar">
   <modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>IntlIterator</type><type>false</type></type><methodname>IntlCalendar::getKeywordValuesForLocale</methodname>
   <methodparam><type>string</type><parameter>keyword</parameter></methodparam>
   <methodparam><type>string</type><parameter>locale</parameter></methodparam>
   <methodparam><type>bool</type><parameter>onlyCommon</parameter></methodparam>
  </methodsynopsis>
  <para>
   &style.procedural;
  </para>
  <methodsynopsis>
   <type class="union"><type>IntlIterator</type><type>false</type></type><methodname>intlcal_get_keyword_values_for_locale</methodname>
   <methodparam><type>string</type><parameter>keyword</parameter></methodparam>
   <methodparam><type>string</type><parameter>locale</parameter></methodparam>
   <methodparam><type>bool</type><parameter>onlyCommon</parameter></methodparam>
  </methodsynopsis>
  <para>
   指定されたロケールのキーに基づいて、
   異なる振る舞いに繋がるキーに対応する、値の集合を返します。
   現状では、キーワード
   <literal>'calendar'</literal> のみがサポートされています。
  </para>
  <para>
   この関数を使うには、ICU 4.2 以上が必要です。
  </para>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>keyword</parameter></term>
    <listitem>
     <para>
      関連する値を問い合わせるロケールのキーワード。
      現状、
      <literal>'calendar'</literal>
      だけがサポートされています。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>locale</parameter></term>
    <listitem>
     <para>
      キーワード/値 のペアを追加するロケール。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>onlyCommon</parameter></term>
    <listitem>
     <para>
      指定されたロケールで、共通に使われている値だけを表示するかどうか。
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   ロケールのキーワードの値の文字列を格納したイテレータを返します。
   &return.falseforfailure;
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
   <title><function>IntlCalendar::getKeyworkValuesForLocale</function></title>
    <programlisting role="php">
<![CDATA[
<?php
print_r(
        iterator_to_array(
                IntlCalendar::getKeywordValuesForLocale(
                        'calendar', 'fa_IR', true)));
print_r(
        iterator_to_array(
                IntlCalendar::getKeywordValuesForLocale(
                        'calendar', 'fa_IR', false)));




]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
Array
(
    [0] => persian
    [1] => gregorian
    [2] => islamic
    [3] => islamic-civil
)
Array
(
    [0] => persian
    [1] => gregorian
    [2] => islamic
    [3] => islamic-civil
    [4] => japanese
    [5] => buddhist
    [6] => roc
    [7] => hebrew
    [8] => chinese
    [9] => indian
    [10] => coptic
    [11] => ethiopic
    [12] => ethiopic-amete-alem
)

]]>
    </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
-->