mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
collapse extract variants into one function
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@259329 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Ed Batutis
parent
43e11396cd
commit
b737121adf
2 changed files with 23 additions and 132 deletions
|
|
@ -1,5 +1,5 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<!-- $Revision: 1.3 $ -->
|
||||
<refentry xml:id="function.grapheme-extract" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>grapheme_extract</refname>
|
||||
|
|
@ -35,10 +35,28 @@
|
|||
<term><parameter>size</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Maximum number of grapheme clusters to return.
|
||||
Maximum number items - based on the $extract_type - to return.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>extract_type</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Defines the type of units referred to by the $size parameter:
|
||||
</para>
|
||||
<para>
|
||||
<simplelist>
|
||||
<member>GRAPHEME_EXTR_COUNT (default) - $size is the number of default
|
||||
grapheme clusters to extract.</member>
|
||||
<member>GRAPHEME_EXTR_MAXBYTES - $size is the maximum number of bytes
|
||||
returned.</member>
|
||||
<member>GRAPHEME_EXTR_MAXCHARS - $size is the maximum number of UTF-8
|
||||
characters returned.</member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>start</parameter></term>
|
||||
<listitem>
|
||||
|
|
@ -58,7 +76,8 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
A string starting at offset $start containing no more than $size grapheme clusters and ending on a default grapheme cluster boundary.
|
||||
A string starting at offset $start and ending on a default grapheme cluster
|
||||
boundary that conforms to the $size and $extract_type specified.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -73,7 +92,7 @@
|
|||
$char_a_ring_nfd = "a\xCC\x8A"; // 'LATIN SMALL LETTER A WITH RING ABOVE' (U+00E5) normalization form "D"
|
||||
$char_o_diaeresis_nfd = "o\xCC\x88"; // 'LATIN SMALL LETTER O WITH DIAERESIS' (U+00F6) normalization form "D"
|
||||
|
||||
print urlencode(grapheme_extract( $char_a_ring_nfd . $char_o_diaeresis_nfd, 1, 2));
|
||||
print urlencode(grapheme_extract( $char_a_ring_nfd . $char_o_diaeresis_nfd, 1, GRAPHEME_EXTR_COUNT, 2));
|
||||
|
||||
?>
|
||||
]]>
|
||||
|
|
@ -91,7 +110,6 @@ o%CC%88
|
|||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>grapheme_extractb</function></member>
|
||||
<member><function>grapheme_substr</function></member>
|
||||
<member>
|
||||
<link xlink:href="&uri.unicode.graphemes;">
|
||||
|
|
|
|||
|
|
@ -1,127 +0,0 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!-- $Revision: 1.2 $ -->
|
||||
<refentry xml:id="function.grapheme-extractb" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
||||
<refnamediv>
|
||||
<refname>grapheme_extractb</refname>
|
||||
<refpurpose>Function to extract a sequence of default grapheme clusters from a text buffer, which must be encoded in UTF-8.</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<para>Procedural style</para>
|
||||
<methodsynopsis>
|
||||
<type>string</type><methodname>grapheme_extractb</methodname>
|
||||
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
|
||||
<methodparam><type>int</type><parameter>bsize</parameter></methodparam>
|
||||
<methodparam choice='opt'><type>int</type><parameter>start</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
Function to extract a sequence of default grapheme clusters from a text
|
||||
buffer, which must be encoded in UTF-8, limited by a byte count.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>haystack</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
String to search.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>bsize</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Maximum number of bytes to return.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>start</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
Starting position in $haystack in bytes. If given, it must be zero or a
|
||||
positive value that is less than or equal to the length of $haystack in
|
||||
bytes. The default is zero. If $start does not point to the first byte of a
|
||||
UTF-8 character, the start position is moved to the next character
|
||||
boundary.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
A string starting at offset $start containing no more than $bsize bytes and ending on a default grapheme cluster boundary.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<example>
|
||||
<title><function>grapheme_extractb</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
< ?php
|
||||
|
||||
$char_a_ring_nfd = "a\xCC\x8A"; // 'LATIN SMALL LETTER A WITH RING ABOVE' (U+00E5) normalization form "D"
|
||||
$char_o_diaeresis_nfd = "o\xCC\x88"; // 'LATIN SMALL LETTER O WITH DIAERESIS' (U+00F6) normalization form "D"
|
||||
|
||||
print urlencode(grapheme_extractb( $char_a_ring_nfd . $char_o_diaeresis_nfd, 4));
|
||||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
&example.outputs;
|
||||
<screen>
|
||||
<![CDATA[
|
||||
a%CC%8A
|
||||
]]>
|
||||
</screen>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>grapheme_extract</function></member>
|
||||
<member><function>grapheme_substr</function></member>
|
||||
<member>
|
||||
<link xlink:href="&uri.unicode.graphemes;">
|
||||
Unicode Text Segmentation: Grapheme Cluster Boundaries
|
||||
</link>
|
||||
</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:"../../../../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
|
||||
-->
|
||||
Loading…
Reference in a new issue