File: preg-grep.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (86 lines) | stat: -rw-r--r-- 2,585 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/pcre.xml, last change in rev 1.2 -->
  <refentry id="function.preg-grep">
   <refnamediv>
    <refname>preg_grep</refname>
    <refpurpose>
     Return array entries that match the pattern
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>array</type><methodname>preg_grep</methodname>
      <methodparam><type>string</type><parameter>pattern</parameter></methodparam>
      <methodparam><type>array</type><parameter>input</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
     </methodsynopsis>

    <para>
     <function>preg_grep</function> returns the array consisting of
     the elements of the <parameter>input</parameter> array that match
     the given <parameter>pattern</parameter>.
    </para>
 
    <para>
     <parameter>flags</parameter> can be the following flag:
     <variablelist>
      <varlistentry>
       <term>PREG_GREP_INVERT</term>
       <listitem>
        <simpara>
         If this flag is passed, <function>preg_grep</function> returns the
         elements of the input array that do <emphasis>not</emphasis> match
         the given <parameter>pattern</parameter>.
         This flag is available since PHP 4.2.0.
        </simpara>
       </listitem>
      </varlistentry>
     </variablelist>
    </para>

    <para>
     Since PHP 4.0.4, the results returned by <function>preg_grep</function>
     are indexed using the keys from the input array. If this behavior is
     undesirable, use <function>array_values</function> on the array returned by
     <function>preg_grep</function> to reindex the values.
    </para>

    <para>
     <example>
      <title><function>preg_grep</function> example</title>
      <programlisting role="php">
<![CDATA[
<?php
// return all array elements
// containing floating point numbers
$fl_array = preg_grep("/^(\d+)?\.\d+$/", $array);
?>
]]>
      </programlisting>
     </example>
    </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
-->