filter-matches.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1976eae0d815797af97a1e16c5cd90ffc2868395 Maintainer: takagi Status: ready -->
<refentry xml:id="locale.filtermatches" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>Locale::filterMatches</refname>
  <refname>locale_filter_matches</refname>
  <refpurpose>言語タグフィルタがロケールにマッチするかどうかを調べる</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>
   &style.oop;
  </para>
  <methodsynopsis role="Locale">
   <modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>bool</type><type>null</type></type><methodname>Locale::filterMatches</methodname>
   <methodparam><type>string</type><parameter>languageTag</parameter></methodparam>
   <methodparam><type>string</type><parameter>locale</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>canonicalize</parameter><initializer>&false;</initializer></methodparam>
  </methodsynopsis>
  <para>
   &style.procedural;
  </para>
  <methodsynopsis>
   <type class="union"><type>bool</type><type>null</type></type><methodname>locale_filter_matches</methodname>
   <methodparam><type>string</type><parameter>languageTag</parameter></methodparam>
   <methodparam><type>string</type><parameter>locale</parameter></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>canonicalize</parameter><initializer>&false;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <parameter>languageTag</parameter> フィルタが
   <parameter>locale</parameter> でマッチするかどうかを
   RFC 4647 の基本フィルタリングアルゴリズムで調べます。
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>languageTag</parameter></term>
     <listitem>
      <para>
       調べたい言語タグ。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>locale</parameter></term>
     <listitem>
      <para>
       調べる対象となる言語の範囲。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>canonicalize</parameter></term>
     <listitem>
     <para>
      true の場合は、引数を正式な形式に変換してからマッチを行います。
     </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>


 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <parameter>locale</parameter> が
   <parameter>languageTag</parameter> にマッチする場合に &true;、
   それ以外の場合に &false; を返します。
  </para>
  &intl.locale-len.return;
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>locale_filter_matches</function> の例</title>
   <programlisting role="php">
<![CDATA[
<?php
echo (locale_filter_matches('de-DEVA','de-DE', false)) ? "Matches" : "Does not match";
echo '; ';
echo (locale_filter_matches('de-DE_1996','de-DE', false)) ? "Matches" : "Does not match";
?>
]]>
   </programlisting>
  </example>
  <example>
   <title>オブジェクト指向の例</title>
   <programlisting role="php">
<![CDATA[
<?php
echo (Locale::filterMatches('de-DEVA','de-DE', false)) ? "Matches" : "Does not match";
echo '; ';
echo (Locale::filterMatches('de-DE-1996','de-DE', false)) ? "Matches" : "Does not match";
?>
]]>
   </programlisting>
  </example>
  &example.outputs;
  <screen>
<![CDATA[
Does not match; Matches
]]>
  </screen>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>locale_lookup</function></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
-->