php-doc-en/reference/intl/intlchar/getintpropertymaxvalue.xml
Colin O'Dell 911013ce81 Add documentation for the IntlChar class and its methods.
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
2015-09-08 01:07:12 +00:00

100 lines
2.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="intlchar.getintpropertymaxvalue" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>IntlChar::getIntPropertyMaxValue</refname>
<refpurpose>Get the max value for a Unicode property</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <modifier>static</modifier> <type>int</type><methodname>IntlChar::getIntPropertyMaxValue</methodname>
<methodparam><type>int</type><parameter>property</parameter></methodparam>
</methodsynopsis>
<para>
Gets the maximum value for an enumerated/integer/binary Unicode property.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>property</parameter></term>
<listitem>
&intl.property.parameter;
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
The maximum value returned by <function>IntlChar::getIntPropertyValue</function> for a Unicode property.
<literal>&lt;=0</literal> if the property selector is out of range.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>&intl.property.example;</title>
<programlisting role="php">
<![CDATA[
<?php
var_dump(IntlChar::getIntPropertyMaxValue(IntlChar::PROPERTY_BIDI_CLASS));
var_dump(IntlChar::getIntPropertyMaxValue(IntlChar::PROPERTY_SCRIPT));
var_dump(IntlChar::getIntPropertyMaxValue(IntlChar::PROPERTY_IDEOGRAPHIC));
var_dump(IntlChar::getIntPropertyMaxValue(999999999)); // Some made-up value
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
int(22)
int(166)
int(1)
int(-1)
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>IntlChar::hasBinaryProperty</function></member>
<member><function>IntlChar::getIntPropertyMinValue</function></member>
<member><function>IntlChar::getIntPropertyValue</function></member>
<member><function>IntlChar::getUnicodeVersion</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
-->