# PearPackageScanner

Extends \DirectoryScanner

Scans for files in a PEAR package.

These criteria consist of a set of include and exclude patterns. With these patterns, you can select which files you want to have included, and which files you want to have excluded.

The idea is simple. A given directory is recursively scanned for all files and directories. Each file/directory is matched against a set of include and exclude patterns. Only files/directories that match at least one pattern of the include pattern list, and don't match a pattern of the exclude pattern list will be placed in the list of files/directories found.

When no list of include patterns is supplied, "**" will be used, which means that everything will be matched. When no list of exclude patterns is supplied, an empty list is used, such that nothing will be excluded.

The pattern matching is done as follows: The name to be matched is split up in path segments. A path segment is the name of a directory or file, which is bounded by DIRECTORY_SEPARATOR ('/' under UNIX, '\' under Windows). E.g. "abc/def/ghi/xyz.php" is split up in the segments "abc", "def", "ghi" and "xyz.php". The same is done for the pattern against which should be matched.

Then the segments of the name and the pattern will be matched against each other. When '**' is used for a path segment in the pattern, then it matches zero or more path segments of the name.

There are special case regarding the use of DIRECTORY_SEPARATOR at the beginning of the pattern and the string to match: When a pattern starts with a DIRECTORY_SEPARATOR, the string to match must also start with a DIRECTORY_SEPARATOR. When a pattern does not start with a DIRECTORY_SEPARATOR, the string to match may not start with a DIRECTORY_SEPARATOR. When one of these rules is not obeyed, the string will not match.

When a name path segment is matched against a pattern path segment, the following special characters can be used: '*' matches zero or more characters, '?' matches one character.

Examples:

"*\.php" matches all .php files/dirs in a directory tree.

"test\a??.php" matches all files/dirs which start with an 'a', then two more characters and then ".php", in a directory called test.

"**" matches everything in a directory tree.

"\test\\XYZ*" matches all files/dirs that start with "XYZ" and where there is a parent directory called test (e.g. "abc\test\def\ghi\XYZ123").

Case sensitivity may be turned off if necessary. By default, it is turned on.

Example of usage: $ds = new DirectroyScanner();$includes = array("*.php"); $excludes = array("modules*\");$ds->SetIncludes($includes);$ds->SetExcludes($excludes);$ds->SetBasedir("test"); $ds->SetCaseSensitive(true);$ds->Scan();

inherited

inherited

inherited

### Arguments

#### $_name string the name to match ### Response boolean true when the name matches against at least one ## Tests whether a name should be selected. isSelected(string$name, string $file) : boolean inherited ### Arguments ####$name

string

The filename to check for selecting.

#### $file string The full file path. ### Response boolean False when the selectors says that the file should not be selected, True otherwise. ## Lists contents of a given directory and returns array with entries listDir(string$_dir) : array
inherited
 author Albert Lash, [email protected]

inherited

### Arguments

#### $pattern string pattern to match against ####$str

string

string that must be matched against the pattern

inherited

### Arguments

#### $pattern string the (non-null) pattern to match against ####$str

string

the (non-null) string (path) to match

#### $isCaseSensitive boolean must a case sensitive match be done? ### Response boolean true when the pattern matches against the string. false otherwise. ## Does the path match the start of this pattern up to the first "**". matchPatternStart(string$pattern, string $str, boolean$isCaseSensitive = true) : boolean
inherited

This is a static mehtod and should always be called static

This is not a general purpose test and should only be used if you can live with false positives.

pattern=**\a and str=b will yield true.

### Arguments

#### $pattern string the pattern to match against ####$str

string

the string (path) to match

#### $isCaseSensitive boolean must matches be case sensitive? ### Response boolean true if matches, otherwise false ## Scans the base directory for files that match at least one include pattern, and don't match any exclude patterns. scan()  inherited ## Scans the passed dir for files and directories. Found files and directories are placed in their respective collections, based on the matching of includes and excludes. When a directory is found, it is scanned recursively. scandir(string$_rootdir, string $_vpath, boolean$_fast)
inherited
 see \#filesIncluded \#filesNotIncluded \#filesExcluded \#dirsIncluded \#dirsNotIncluded \#dirsExcluded

### Arguments

#### $_rootdir string the directory to scan ####$_vpath

string

the path relative to the basedir (needed to prevent problems with an absolute path when using dir)

inherited

inherited

### Arguments

#### $channel string package channel name or alias ## Sets the full path to the PEAR configuration file setConfig(string$config) : void
Throws \BuildException

### Arguments

#### $config string Configuration file ## Sets the package.xml file to read, instead of using the local pear installation. setDescFile(string$descfile) : void
Throws \BuildException

inherited

### Arguments

#### $errorOnMissingDir boolean whether or not a missing base directory is an error ## Sets the set of exclude patterns to use. All '/' and '\' characters are replaced by <code>File.separatorChar</code>. So the separator used need not match <code>File.separatorChar</code>. setExcludes(array$_excludes = array())
inherited

When a pattern ends with a '/' or '\', "**" is appended.

### Arguments

#### $_excludes array list of exclude patterns ## Sets the set of include patterns to use. All '/' and '\' characters are replaced by DIRECTORY_SEPARATOR. So the separator used need not match DIRECTORY_SEPARATOR. setIncludes(array$_includes = array())
inherited

When a pattern ends with a '/' or '\', "**" is appended.

inherited

### Arguments

#### \$selectors

array

the selectors to be invoked on a scan

## Toplevel invocation for the scan.

slowScan()
inherited

Returns immediately if a slow scan has already been requested.

## packageInfo

packageInfo :

## role

role :

## config

config :

## package

package :

## channel

channel :

## packageFile

packageFile :

## default set of excludes

DEFAULTEXCLUDES :
inherited

## The base directory which should be scanned.

basedir : string
inherited

### Type(s)

string

## The patterns for the files that should be included.

includes : array<mixed,string>
inherited

### Type(s)

array<mixed,string>

## The patterns for the files that should be excluded.

excludes : array<mixed,string>
inherited

### Type(s)

array<mixed,string>

## The files that where found and matched at least one includes, and matched no excludes.

filesIncluded :
inherited

## The files that where found and did not match any includes. Trie

filesNotIncluded :
inherited

## The files that where found and matched at least one includes, and also matched at least one excludes. Trie object.

filesExcluded :
inherited

## The directories that where found and matched at least one includes, and matched no excludes.

dirsIncluded :
inherited

## The directories that where found and did not match any includes.

dirsNotIncluded :
inherited

## The files that where found and matched at least one includes, and also matched at least one excludes.

dirsExcluded :
inherited

## Have the vars holding our results been built by a slow scan?

haveSlowResults :
inherited

## Should the file system be treated as a case sensitive one?

isCaseSensitive :
inherited

## Whether a missing base directory is an error.

errorOnMissingDir :
inherited

## Selectors

selectorsList : array<mixed,\FileSelector>
inherited
 var Selectors

### Type(s)

array<mixed,\FileSelector>

## filesDeselected

filesDeselected :
inherited

## dirsDeselected

dirsDeselected :
inherited

## if there are no deselected files

everythingIncluded :
inherited