search.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 9ee27f088aefb55de20529000792c4deefc0226b Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="eventbuffer.search" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>EventBuffer::search</refname>
  <refpurpose>Сканирует буфер на наличие строки</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier>
   <type>mixed</type>
   <methodname>EventBuffer::search</methodname>
   <methodparam>
    <type>string</type>
    <parameter>what</parameter>
   </methodparam>
   <methodparam
   choice="opt">
    <type>int</type>
    <parameter>start</parameter>
    <initializer>-1</initializer>
   </methodparam>
   <methodparam choice="opt">
    <type>int</type>
    <parameter>end</parameter>
    <initializer>-1</initializer>
   </methodparam>
  </methodsynopsis>
  <para>
   Сканирует буфер на наличие строки
   <parameter>what</parameter>.
   Возвращает числовую позицию строки или &false;, если строка
   не была найдена.
  </para>
  <para>
   Если указан аргумент
   <parameter>start</parameter>,
   он указывает на позицию, с которой должен
   начинаться поиск; в противном случае поиск выполняется с начала строки. Если
   указан аргумент
   <parameter>end</parameter>,
   поиск выполняется между начальной и конечной
   позициями буфера.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term>
     <parameter>what</parameter>
    </term>
    <listitem>
     <para>
      Строка для поиска.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>start</parameter>
    </term>
    <listitem>
     <para>
      Позиция начала поиска.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term>
     <parameter>end</parameter>
    </term>
    <listitem>
     <para>
      Позиция окончания поиска.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает числовую позицию первого вхождения строки
   в буфере или &false;, если строка не найдена.
  </para>
  &return.falseproblem;
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Пример использования
    <function>EventBuffer::search</function></title>
   <programlisting role="php">
<![CDATA[
<?php
// Count total occurances of 'str' in 'buf'
function count_instances($buf, $str) {
    $total = 0;
    $p     = 0;
    $i     = 0;

    while (1) {
        $p = $buf->search($str, $p);
        if ($p === FALSE) {
            break;
        }
        ++$total;
        ++$p;
    }

    return $total;
}

$buf = new EventBuffer();
$buf->add("Some string within a string inside another string");
var_dump(count_instances($buf, "str"));
?>
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
int(3)
]]>
   </screen>
  </example>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member>
    <methodname>EventBuffer::searchEol</methodname>
   </member>
  </simplelist>
 </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
-->