PEAR Manual
Prev |  | Next

# File_Find::glob()

File_Find::glob() -- find matches for a pattern in a directory

## Synopsis

    require_once 'File/Find.php';

``array &File_Find::glob` (string $pattern, string $dirpath [, string $pattern_type = 'php'])`

## Description

Search the directory to find matches for the specified pattern.

## Parameter

- `$pattern` - a string containing the pattern to search the directory for.

- `$dirpath` - a string containing the directory path to search.

- `$pattern_type` - a string containing the type of pattern matching functions to use (can either be 'php', 'perl' or 'shell').

  The format of the `$pattern` depends on the `$pattern_type`-value. For more information see search methods

## Return value

`array` - an array contains all filenames and name of subdirectories, which matches the pattern. Or a PEAR_Error.

## Throws

Table 38-1. Possible PEAR_Error values

Error code | Error message | Reason | Solution
--- | --- | --- | ---
`NULL` | " Cannot open directory " | The given directory could not be opend. | Check typing and directory permissions. This can not be caused by a competive processing the archive with Archive_Tar

## Note

This function can be called statically.

## Example

Example 38-1. Find all PHP files in current directory
    include "File/Find.php";

    $dir = ".";
    $items = &File_Find::glob( '!.*\.php$!', $dir, 'perl' );

    print_r($items);

Prev | Home | Next
Search methods | Up | File_Find::maptree()