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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="intlchar.charname" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>IntlChar::charName</refname>
<refpurpose>Retrieve the name of a Unicode character</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="IntlChar">
<modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>string</type><type>null</type></type><methodname>IntlChar::charName</methodname>
<methodparam><type class="union"><type>int</type><type>string</type></type><parameter>codepoint</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>type</parameter><initializer>IntlChar::UNICODE_CHAR_NAME</initializer></methodparam>
</methodsynopsis>
<para>
Retrieves the name of a Unicode character.
</para>
<para>
Depending on <parameter>type</parameter>, the resulting character name is the "modern" name or the name that
was defined in Unicode version 1.0. The name contains only "invariant" characters like A-Z, 0-9, space, and '-'.
Unicode 1.0 names are only retrieved if they are different from the modern names and if ICU contains the data for them.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>codepoint</parameter></term>
<listitem>
&intl.codepoint.parameter;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>type</parameter></term>
<listitem>
<para>
Which set of names to use for the lookup. Can be any of these constants:
<simplelist>
<member><constant>IntlChar::UNICODE_CHAR_NAME</constant> (default)</member>
<member><constant>IntlChar::UNICODE_10_CHAR_NAME</constant></member>
<member><constant>IntlChar::EXTENDED_CHAR_NAME</constant></member>
<member><constant>IntlChar::CHAR_NAME_ALIAS</constant></member>
<member><constant>IntlChar::CHAR_NAME_CHOICE_COUNT</constant></member>
</simplelist>
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The corresponding name, or an empty string if there is no name for this character,
or &null; if there is no such code point.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>&intl.codepoint.example;</title>
<programlisting role="php">
<![CDATA[
<?php
var_dump(IntlChar::charName("."));
var_dump(IntlChar::charName(".", IntlChar::UNICODE_CHAR_NAME));
var_dump(IntlChar::charName("\u{2603}"));
var_dump(IntlChar::charName("\u{0000}"));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
string(9) "FULL STOP"
string(9) "FULL STOP"
string(7) "SNOWMAN"
string(0) ""
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>IntlChar::charFromName</function></member>
<member><function>IntlChar::enumCharNames</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
-->
|
