getpropertyvalueenum.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1976eae0d815797af97a1e16c5cd90ffc2868395 Maintainer: mumumu Status: ready -->

<refentry xml:id="intlchar.getpropertyvalueenum" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>IntlChar::getPropertyValueEnum</refname>
  <refpurpose>指定された値の名前に対応する、プロパティの値を取得する</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="IntlChar">
   <modifier>public</modifier> <modifier>static</modifier> <type>int</type><methodname>IntlChar::getPropertyValueEnum</methodname>
   <methodparam><type>int</type><parameter>property</parameter></methodparam>
   <methodparam><type>string</type><parameter>name</parameter></methodparam>
  </methodsynopsis>
  <para>
   指定された値の名前に対応する、プロパティの値を整数で返します。
   Unicode のデータベースファイル
   PropertyValueAliases.txt に存在するものです。
   短縮名や長い名前、その他の名前も認識します。
  </para>
  <note>
   <para>
    PropertyValueAliases.txt に存在する名前の中には、
    <constant>IntlChar::PROPERTY_GENERAL_CATEGORY_MASK</constant>
    を指定しないと取得できないものがあります。
    <constant>IntlChar::PROPERTY_GENERAL_CATEGORY</constant>
    を指定すると取得できません。
    以下の文字が該当します:
    <simplelist>
     <member>"C" / "Other"</member>
     <member>"L" / "Letter"</member>
     <member>"LC" / "Cased_Letter"</member>
     <member>"M" / "Mark"</member>
     <member>"N" / "Number"</member>
     <member>"P" / "Punctuation"</member>
     <member>"S" / "Symbol"</member>
     <member> "Z" / "Separator"</member>
    </simplelist>
   </para>
  </note>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>property</parameter></term>
    <listitem>
     &intl.property.parameter;
     <para>
      範囲外の値が指定されたり、
      このメソッドが指定された値で動作しなかった場合は、
      <constant>IntlChar::PROPERTY_INVALID_CODE</constant> を返します。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>name</parameter></term>
    <listitem>
     <para>
      マッチさせる値の名前。
      PropertyValueAliases.txt で説明されている
      "loose matching" を使って比較されます。
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   対応する値の整数を返します。
   指定した名前が、プロパティのどの値にもマッチしないか、
   プロパティそのものが無効な場合は、
   <constant>IntlChar::PROPERTY_INVALID_CODE</constant>
   を返します。
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>&intl.property.example;</title>
   <programlisting role="php">
    <![CDATA[
<?php
var_dump(IntlChar::getPropertyValueEnum(IntlChar::PROPERTY_BLOCK, 'greek') === IntlChar::BLOCK_CODE_GREEK);
var_dump(IntlChar::getPropertyValueEnum(IntlChar::PROPERTY_BIDI_CLASS, 'RIGHT_TO_LEFT') === IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT);
var_dump(IntlChar::getPropertyValueEnum(IntlChar::PROPERTY_BIDI_CLASS, 'some made-up string') === IntlChar::PROPERTY_INVALID_CODE);
var_dump(IntlChar::getPropertyValueEnum(123456789, 'RIGHT_TO_LEFT') === IntlChar::PROPERTY_INVALID_CODE);
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
    <![CDATA[
bool(true)
bool(true)
bool(true)
bool(true)
]]>
   </screen>
  </example>
 </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
-->