File: glob.xml

package info (click to toggle)
phpdoc 20050512-1
  • links: PTS
  • area: non-free
  • in suites: sarge
  • size: 36,592 kB
  • ctags: 1,501
  • sloc: xml: 376,768; php: 6,708; cpp: 500; makefile: 293; perl: 161; sh: 151; awk: 28
file content (130 lines) | stat: -rw-r--r-- 3,520 bytes parent folder | download
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.17 $ -->
  <refentry id="function.glob">
   <refnamediv>
    <refname>glob</refname> 
    <refpurpose>Find pathnames matching a pattern</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <methodsynopsis>
     <type>array</type><methodname>glob</methodname>
     <methodparam><type>string</type><parameter>pattern</parameter></methodparam>
     <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
    </methodsynopsis>
    <para>
     The <function>glob</function> function searches for all the pathnames
     matching <parameter>pattern</parameter> according to the rules used by
     the libc glob() function, which is similar to the rules used by common
     shells. No tilde expansion or parameter substitution is done.
    </para>
    <para>
     Returns an array containing the matched files/directories or &false; on
     error.
    </para>
    <para>
    Valid flags:
    <itemizedlist>
     <listitem>
      <simpara>
       <constant>GLOB_MARK</constant> - Adds a slash to each item returned
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       <constant>GLOB_NOSORT</constant> - Return files as they appear in the 
       directory (no sorting)
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       <constant>GLOB_NOCHECK</constant> - Return the search pattern if no 
       files matching it were found
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       <constant>GLOB_NOESCAPE</constant> - Backslashes do not quote 
       metacharacters
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       <constant>GLOB_BRACE</constant> - Expands {a,b,c} to match 'a', 'b', 
       or 'c'
      </simpara>
     </listitem>
     <listitem>
      <simpara>
       <constant>GLOB_ONLYDIR</constant> - Return only directory entries 
       which match the pattern
      </simpara>
     </listitem>
    </itemizedlist>
    </para>
    <note>
     <simpara>
      Before PHP 4.3.3 <constant>GLOB_ONLYDIR</constant> was 
      <emphasis role="strong">not</emphasis>
      available on Windows and other systems not using the GNU
      C library.
     </simpara>
    </note>
    <para>
     <example>
      <title>
       Convenient way how <function>glob</function> can replace
       <function>opendir</function> and friends.
      </title>
      <programlisting role="php">
<![CDATA[
<?php
foreach (glob("*.txt") as $filename) {
    echo "$filename size " . filesize($filename) . "\n";
}
?>
]]>
      </programlisting>
      <para>
       Output will look something like:
      </para>
      <screen>
<![CDATA[
funclist.txt size 44686
funcsummary.txt size 267625
quickref.txt size 137820
]]>
      </screen>
     </example>
    </para>
    
    &note.no-remote;
    
    <para>
     See also <function>opendir</function>,
     <function>readdir</function>,
     <function>closedir</function>, and <function>fnmatch</function>.
    </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
-->