php-doc-en/reference/filesystem/functions/glob.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.19 $ -->
  <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>
      <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>
     </listitem>
     <listitem>
      <simpara>
       <constant>GLOB_ERR</constant> - Stop on read errors (like unreadable  
       directories), by default errors are ignored
      </simpara>
      <note>
       <simpara>
        <constant>GLOB_ERR</constant> was added in PHP 5.1
       </simpara>
      </note>
     </listitem>
    </itemizedlist>
    </para>
    <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
-->