mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
daee9e9ce9
This also integrates user note 123394. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@346144 c90b9560-bf6c-de11-be94-00142212c4b1
119 lines
3.5 KiB
XML
119 lines
3.5 KiB
XML
<?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>
|
|
<modifier>public</modifier> <modifier>static</modifier> <type>string</type><methodname>IntlChar::charName</methodname>
|
|
<methodparam><type>mixed</type><parameter>codepoint</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter>nameChoice</parameter><initializer><constant>IntlChar::UNICODE_CHAR_NAME</constant></initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Retrieves the name of a Unicode character.
|
|
</para>
|
|
<para>
|
|
Depending on <parameter>nameChoice</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>nameChoice</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
|
|
-->
|