adding documentation and examples for strpbrk

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@162746 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Nuno Lopes 2004-07-06 12:32:39 +00:00
parent ce4f51db5b
commit 627cff89cd

View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.strpbrk">
<refnamediv>
<refname>strpbrk</refname>
@ -10,13 +10,39 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>strpbrk</methodname>
<type>string</type><methodname>strpbrk</methodname>
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
<methodparam><type>string</type><parameter>char_list</parameter></methodparam>
</methodsynopsis>
<para>
<function>strpbrk</function> searches the <parameter>haystack</parameter>
string for a <parameter>char_list</parameter>, and returns a string
starting from the character found (or &false; if it is not found).
</para>
<note>
<para>
The <parameter>char_list</parameter> parameter is case sensitive.
</para>
</note>
<para>
<example>
<title><function>strpbrk</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
&warn.undocumented.func;
$text = 'This is a Simple text.';
// this echoes "is is a Simple text." because 'i' is matched first
echo strpbrk($text, 'mi');
// this echoes "Simple text." because chars are case sensitive
echo strpbrk($text, 'S');
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>