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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="intlchar.getpropertyname" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>IntlChar::getPropertyName</refname>
<refpurpose>Get the Unicode name for a property</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::getPropertyName</methodname>
<methodparam><type>int</type><parameter>property</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>type</parameter><initializer>IntlChar::LONG_PROPERTY_NAME</initializer></methodparam>
</methodsynopsis>
<para>
Returns the Unicode name for a given property, as given in the Unicode database file PropertyAliases.txt.
</para>
<para>
In addition, this function maps the property <constant>IntlChar::PROPERTY_GENERAL_CATEGORY_MASK</constant> to the
synthetic names "gcm" / "General_Category_Mask". These names are not in PropertyAliases.txt.
</para>
<para>
This function complements <function>IntlChar::getPropertyEnum</function>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>property</parameter></term>
<listitem>
&intl.property.parameter;
<para>
<constant>IntlChar::PROPERTY_INVALID_CODE</constant> should not be used.
Also, if <parameter>property</parameter> is out of range, &false; is returned.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem>
<para>
Selector for which name to get. If out of range, &false; is returned.
</para>
<para>
All properties have a long name. Most have a short name, but some do not. Unicode allows for additional names;
if present these will be returned by adding 1, 2, etc. to <constant>IntlChar::LONG_PROPERTY_NAME</constant>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the name, or &false; if either the <parameter>property</parameter> or the <parameter>type</parameter>
is out of range.
</para>
<para>
If a given <parameter>type</parameter> returns &false;, then all larger values of
<parameter>type</parameter> will return &false;, with one exception: if &false; is returned for
<constant>IntlChar::SHORT_PROPERTY_NAME</constant>, then <constant>IntlChar::LONG_PROPERTY_NAME</constant>
(and higher) may still return a non-&false; value.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>&intl.property.example;</title>
<programlisting role="php">
<![CDATA[
<?php
var_dump(IntlChar::getPropertyName(IntlChar::PROPERTY_BIDI_CLASS));
var_dump(IntlChar::getPropertyName(IntlChar::PROPERTY_BIDI_CLASS, IntlChar::SHORT_PROPERTY_NAME));
var_dump(IntlChar::getPropertyName(IntlChar::PROPERTY_BIDI_CLASS, IntlChar::LONG_PROPERTY_NAME));
var_dump(IntlChar::getPropertyName(IntlChar::PROPERTY_BIDI_CLASS, IntlChar::LONG_PROPERTY_NAME + 1));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
string(10) "Bidi_Class"
string(2) "bc"
string(10) "Bidi_Class"
bool(false)
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>IntlChar::getPropertyEnum</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
-->
|
