mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
convert to new style
add new offset&length parameters integrate users notes about 'overlapped' substrings improve the example git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@190586 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Nuno Lopes
parent
1f7e10b4b2
commit
b11367af14
1 changed files with 142 additions and 34 deletions
|
|
@ -1,44 +1,152 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.6 $ -->
|
||||
<!-- $Revision: 1.7 $ -->
|
||||
<!-- splitted from ./en/functions/strings.xml, last change in rev 1.27 -->
|
||||
<refentry id="function.substr-count">
|
||||
<refnamediv>
|
||||
<refname>substr_count</refname>
|
||||
<refpurpose>Count the number of substring occurrences</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>substr_count</methodname>
|
||||
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
|
||||
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>substr_count</function> returns the number of times the
|
||||
<parameter>needle</parameter> substring occurs in the
|
||||
<parameter>haystack</parameter> string. Please note that
|
||||
<parameter>needle</parameter> is case sensitive.
|
||||
</para>
|
||||
<refentry id="function.substr-count">
|
||||
<refnamediv>
|
||||
<refname>substr_count</refname>
|
||||
<refpurpose>Count the number of substring occurrences</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1 role="description">
|
||||
&reftitle.description;
|
||||
<methodsynopsis>
|
||||
<type>int</type><methodname>substr_count</methodname>
|
||||
<methodparam><type>string</type><parameter>haystack</parameter></methodparam>
|
||||
<methodparam><type>string</type><parameter>needle</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>offset</parameter></methodparam>
|
||||
<methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
|
||||
</methodsynopsis>
|
||||
<para>
|
||||
<function>substr_count</function> returns the number of times the
|
||||
<parameter>needle</parameter> substring occurs in the
|
||||
<parameter>haystack</parameter> string. Please note that
|
||||
<parameter>needle</parameter> is case sensitive.
|
||||
</para>
|
||||
<note>
|
||||
<para>
|
||||
This function doesn't count overlapped substrings. See the example below!
|
||||
</para>
|
||||
</note>
|
||||
</refsect1>
|
||||
|
||||
<para>
|
||||
<example>
|
||||
<title><function>substr_count</function> example</title>
|
||||
<programlisting role="php">
|
||||
<refsect1 role="parameters">
|
||||
&reftitle.parameters;
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><parameter>haystack</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The string to search in
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>needle</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The substring to search for
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>offset</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The offset where to start counting
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><parameter>length</parameter></term>
|
||||
<listitem>
|
||||
<para>
|
||||
The maximum legth after the specified offset to search for the
|
||||
substring. It outputs a warning if the offset plus the length is
|
||||
greater than the <parameter>haystack</parameter> length.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
This functions returns an <type>integer</type>.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="changelog">
|
||||
&reftitle.changelog;
|
||||
<para>
|
||||
<informaltable>
|
||||
<tgroup cols="2">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>&Version;</entry>
|
||||
<entry>&Description;</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>5.1.0</entry>
|
||||
<entry>
|
||||
Added the <parameter>offset</parameter> and
|
||||
the <parameter>length</parameter> parameters
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</informaltable>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="examples">
|
||||
&reftitle.examples;
|
||||
<para>
|
||||
<example>
|
||||
<title>A <function>substr_count</function> example</title>
|
||||
<programlisting role="php">
|
||||
<![CDATA[
|
||||
<?php
|
||||
echo substr_count("This is a test", "is"); // prints out 2
|
||||
$text = 'This is a test';
|
||||
echo strlen($text); // 14
|
||||
|
||||
echo substr_count($text, 'is'); // 2
|
||||
|
||||
// the string is reduced to 's is a test', so it prints 1
|
||||
echo substr_count($text, 'is', 3);
|
||||
|
||||
// the text is reduced to 's i', so it prints 0
|
||||
echo substr_count($text, 'is', 3, 3);
|
||||
|
||||
// generates a warning because 5+10 > 14
|
||||
echo substr_count($text, 'is', 5, 10);
|
||||
|
||||
|
||||
// prints only 1, because it doesn't count overlapped subtrings
|
||||
$text2 = 'gcdgcdgcd';
|
||||
echo substr_count($text2, 'gcdgcd');
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
<simpara>
|
||||
See also <function>count_chars</function>,
|
||||
<function>strpos</function>, <function>substr</function>,
|
||||
and <function>strstr</function>.
|
||||
</simpara>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
<refsect1 role="seealso">
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
<simplelist>
|
||||
<member><function>count_chars</function></member>
|
||||
<member><function>strpos</function></member>
|
||||
<member><function>substr</function></member>
|
||||
<member><function>strstr</function></member>
|
||||
</simplelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
|
|
|
|||
Loading…
Reference in a new issue