mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-24 04:48:55 +00:00
911013ce81
Documentation is based on PHP 7.0.0 RC2. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@337779 c90b9560-bf6c-de11-be94-00142212c4b1
120 lines
3.7 KiB
XML
120 lines
3.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<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>Get the property value for a given value name</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<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>
|
|
Returns the property value integer for a given value name, as specified in the Unicode database file PropertyValueAliases.txt.
|
|
Short, long, and any other variants are recognized.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
Some of the names in PropertyValueAliases.txt will only be recognized with
|
|
<constant>IntlChar::PROPERTY_GENERAL_CATEGORY_MASK</constant>, not
|
|
<constant>IntlChar::PROPERTY_GENERAL_CATEGORY</constant>.
|
|
These include:
|
|
<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>
|
|
If out of range, or this method doesn't work with the given value,
|
|
<constant>IntlChar::PROPERTY_INVALID_CODE</constant> is returned.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>name</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The value name to be matched. The name is compared using "loose matching" as described in PropertyValueAliases.txt.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the corresponding value integer, or <constant>IntlChar::PROPERTY_INVALID_CODE</constant> if the given name
|
|
does not match any value of the given property, or if the property is invalid.
|
|
</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
|
|
-->
|