Update getpropertyvalueenum.xml infostyle

This commit is contained in:
Mikhail Alferov
2024-08-05 21:38:40 +03:00
committed by GitHub
parent 913f1d9fd2
commit c2ff313883

View File

@ -4,7 +4,7 @@
<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>Вернуть числовой идентификатор свойства по его имени</refpurpose>
<refpurpose>Получает значение свойства по имени значения</refpurpose>
</refnamediv>
<refsect1 role="description">
@ -15,24 +15,33 @@
<methodparam><type>string</type><parameter>name</parameter></methodparam>
</methodsynopsis>
<para>
Возвращает числовой идентификатор свойства Unicode по его имени, как определено в файле PropertyValueAliases.txt.
Принимаются длинные, короткие и прочие варианты имени.
Метод возвращает целочисленное значение свойства Юникода по имени значения,
как определяет файл базы данных Юникода — PropertyValueAliases.txt. Метод распознаёт короткие,
длинные и другие варианты имён.
</para>
<note>
<para>
Некоторые имена из PropertyValueAliases.txt могут быть извлечены только с помощью
<constant>IntlChar::PROPERTY_GENERAL_CATEGORY_MASK</constant>, а не
<constant>IntlChar::PROPERTY_GENERAL_CATEGORY</constant>.
Включая:
Отдельные названия значений свойств из файла PropertyValueAliases.txt извлекаются только
через флаг <constant>IntlChar::PROPERTY_GENERAL_CATEGORY_MASK</constant>,
а не <constant>IntlChar::PROPERTY_GENERAL_CATEGORY</constant>.
К таким значениям относятся следующие категории символов (список приводит короткое и длинное название
категории, а также сокращённое описание):
<simplelist>
<member>"C" / "Прочее"</member>
<member>"L" / "Буквы"</member>
<member>"LC" / "Буквы, имеющие несколько регистров"</member>
<member>"M" / "Метки"</member>
<member>"N" / "Числа"</member>
<member>"P" / "Пунктуация"</member>
<member>"S" / "Символы"</member>
<member> "Z" / "Разделители"</member>
<member>
"C" / "Other" — прочие символы (управлящие, форматирования, суррогаты, частные и зарезервированные неназначенные
кодовые точки и несимвольные коды)
</member>
<member>"L" / "Letter" — буквы</member>
<member>
"LC" / "Cased_Letter" — категория регистровых букв, которая объединяет категории:
заглавных букв — Lu, строчных букв — Ll и диграфов с первым заглавным символом — Lt, то есть отдельных одиночных символов,
которые состоят из двух символов, из которых первый — заглавный, например Cz [ч] и Sz [ш]
</member>
<member>"M" / "Mark" — метки</member>
<member>"N" / "Number" — числа</member>
<member>"P" / "Punctuation" — символы пунктуации</member>
<member>"S" / "Symbol" — символы (математические, валют, диакритические и прочие)</member>
<member> "Z" / "Separator" — символы-разделители</member>
</simplelist>
</para>
</note>
@ -46,8 +55,8 @@
<listitem>
&intl.property.parameter;
<para>
Если не входит в допустимый диапазон, либо если метод не работает с данным значением, возвращается
<constant>IntlChar::PROPERTY_INVALID_CODE</constant>.
Метод вернёт значение флага <constant>IntlChar::PROPERTY_INVALID_CODE</constant>,
если свойство выходит за пределы допустимого диапазона, или если метод не работает с заданным значением.
</para>
</listitem>
</varlistentry>
@ -55,7 +64,8 @@
<term><parameter>name</parameter></term>
<listitem>
<para>
Имя свойства. Имена сравниваются по принципу "loose matching", как описано в PropertyValueAliases.txt.
Название значения свойства, которое требуется сопоставить. Имена сравниваются по принципу «свободного соответствия»
(loose matching), как описывает файл базы данных Юникода — PropertyValueAliases.txt.
</para>
</listitem>
</varlistentry>
@ -65,9 +75,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Возвращает соответствующее целочисленное значение или
<constant>IntlChar::PROPERTY_INVALID_CODE</constant> если соответствие не найдено
или если свойство некорректно.
Метод возвращает целочисленное значение свойства, которое соответствует названию значения свойства,
или <constant>IntlChar::PROPERTY_INVALID_CODE</constant>, если имя не совпадает ни с одним значением
свойства или если свойство недопустимо.
</para>
</refsect1>
@ -78,10 +88,12 @@
<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>