-
Notifications
You must be signed in to change notification settings - Fork 56
/
getpropertyvaluename.xml
172 lines (167 loc) · 6.03 KB
/
getpropertyvaluename.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1976eae0d815797af97a1e16c5cd90ffc2868395 Maintainer: mumumu Status: ready -->
<refentry xml:id="intlchar.getpropertyvaluename" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>IntlChar::getPropertyValueName</refname>
<refpurpose>プロパティの値に対応する、Unicode の名前を取得する</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="IntlChar">
<modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>IntlChar::getPropertyValueName</methodname>
<methodparam><type>int</type><parameter>property</parameter></methodparam>
<methodparam><type>int</type><parameter>value</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>type</parameter><initializer>IntlChar::LONG_PROPERTY_NAME</initializer></methodparam>
</methodsynopsis>
<para>
指定されたプロパティの値に対応する、Unicode の名前を返します。
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>
範囲外の値が指定されたり、
このメソッドが指定された値で動作しなかった場合は、
&false; を返します。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem>
<para>
プロパティの値を指定します。
範囲外の値が指定された場合、&false; を返します。
</para>
<para>
一般的に、有効な値は <literal>0</literal>
からある最大値までの値を取りますが、いくつか例外があります:
<simplelist>
<member>
プロパティが <constant>IntlChar::PROPERTY_BLOCK</constant> の場合、
0 でない値 <constant>IntlChar::BLOCK_CODE_BASIC_LATIN</constant>
から始まります。
</member>
<member>
プロパティが
<constant>IntlChar::PROPERTY_CANONICAL_COMBINING_CLASS</constant>
の場合は、連続してしない 0..240 までの値を取ります。
</member>
</simplelist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem>
<para>
どの名前を取得するかを選択します。
範囲外の値の場合、&false; を返します。
</para>
<para>
全ての値には長い名前 (long name) が存在します。
殆どの値には短縮名 (short name) が存在しますが、
ないものもあります。
さらに、Unicode はこれら以外の追加の名前も許容しています。つまり、
追加の名前が存在する場合、
<constant>IntlChar::LONG_PROPERTY_NAME</constant>
に追加される形で返されます。
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
名前を返します。
<parameter>property</parameter> や
<parameter>type</parameter> が範囲外の場合は、
&false; を返します。
失敗した場合は、&null; を返します。
</para>
<para>
指定された <parameter>type</parameter> が &false; を返す場合は、
それより大きな
<parameter>type</parameter> の値も &false; を返しますが、
ひとつだけ例外があります。
<constant>IntlChar::SHORT_PROPERTY_NAME</constant>
を指定して &false; を返す場合は、
<constant>IntlChar::LONG_PROPERTY_NAME</constant>
(と、それより大きな値) は &false; でない値を返します。
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>&intl.property.example;</title>
<programlisting role="php">
<![CDATA[
<?php
var_dump(IntlChar::getPropertyValueName(IntlChar::PROPERTY_BLOCK, IntlChar::BLOCK_CODE_GREEK));
var_dump(IntlChar::getPropertyValueName(IntlChar::PROPERTY_BLOCK, IntlChar::BLOCK_CODE_GREEK, IntlChar::SHORT_PROPERTY_NAME));
var_dump(IntlChar::getPropertyValueName(IntlChar::PROPERTY_BLOCK, IntlChar::BLOCK_CODE_GREEK, IntlChar::LONG_PROPERTY_NAME));
var_dump(IntlChar::getPropertyValueName(IntlChar::PROPERTY_BLOCK, IntlChar::BLOCK_CODE_GREEK, IntlChar::LONG_PROPERTY_NAME + 1));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
string(16) "Greek_And_Coptic"
string(5) "Greek"
string(16) "Greek_And_Coptic"
bool(false)
]]>
</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
-->