mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 10:28:54 +00:00
e66422541e
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@294375 c90b9560-bf6c-de11-be94-00142212c4b1
98 lines
2.4 KiB
XML
98 lines
2.4 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="regexiterator.accept" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>RegexIterator::accept</refname>
|
|
<refpurpose>Get accept status</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>bool</type><methodname>RegexIterator::accept</methodname>
|
|
<void />
|
|
</methodsynopsis>
|
|
<para>
|
|
Matches <literal>(string)</literal> <methodname>RegexIterator::current</methodname>
|
|
(or <methodname>RegexIterator::key</methodname> if the
|
|
<link linkend="regexiterator.constants.use-key">RegexIterator::USE_KEY</link> flag is set)
|
|
against the regular expression.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
&no.function.parameters;
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&true; if a match, &false; otherwise.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example xml:id="regexiterator.accept.example.basic">
|
|
<title><methodname>RegexIterator::accept</methodname> example</title>
|
|
<para>
|
|
This example shows that only items matching the regular expression are accepted.
|
|
</para>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$names = new ArrayIterator(array('Ann', 'Bob', 'Charlie', 'David'));
|
|
$filter = new RegexIterator($names, '/^[B-D]/');
|
|
foreach ($filter as $name) {
|
|
echo $name . PHP_EOL;
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
Bob
|
|
Charlie
|
|
David
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><link linkend="regexiterator.constants">RegexIterator constants</link></member>
|
|
<member><methodname>RegexIterator::setFlags</methodname></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
|
|
-->
|