$ignore (line 63)

Data type : false|array

Format: array(array(regexp-ready string to search for whole path,

$phpDocOptions (line 57)

Data type : mixed

Holds all the options that are avaible to the cmd line interface

$valid_booleans = array
(
'', ' ', 'on', 'y', 'yes', 'true', '1',
'off', 'n', 'no', 'false', '0'

) (line 71)

Data type : array

A specific array of values that boolean-based arguments can understand, aided by the decideOnOrOff() helper method.

Constructor Io (line 87)

Io Io( )

creates an array $this->phpDocOptions and sets program options in it.

 [filename][tag][] = "f";
 [filename][tag][] = "-file";
 [filename][desc] "name of file to parse"

Info

Method checkIgnore (line 717)

bool checkIgnore( string $file, string $path, array $ignore, [bool $ignore_no_ext = true], [bool $ignoresymlinks = false])

Tell whether to ignore a file or a directory allows * and ? wildcards

Parameters

• string $file: just the file name of the file or directory, in the case of directories this is the last dir
• string $path: the path to consider (should be checked by realpath() before, and may be relative)
• array $ignore:
• bool $ignore_no_ext:
• bool $ignoresymlinks: Ignore symlinks?

Info

• return - true if $path should be ignored, false if it should not
• author - Greg Beaver <[email protected]>
• usedby - Io::getDirTree()

Method dirList (line 377)

array dirList( $orig_directory, [bool $hidden = false], [bool $ignore_symlinks = false], string $directory)

Parameters

• string $directory: full path to the directory you want the list of
• bool $hidden: whether to list files that begin with . like .bash_history
• bool $ignore_symlinks: whether to ignore symlinks
• $orig_directory:

Info

• return - list of files in a directory
• usedby - Io::getAllFiles()
• usedby - Io::getDirTree()

Method displayHelpMsg (line 204)

string displayHelpMsg( )

create the help message for display on the command-line

Info

• return - a string containing a help message

Method getAllFiles (line 888)

mixed getAllFiles( string $file)

Take a filename with wildcards and return all files that match the

Parameters

• string $file: a full path from the -f command-line parameter, with potential * and ? wildcards.

Info

• return - if $file contains wildcards, returns an array of matching files, otherwise returns false
• author - Greg Beaver <[email protected]>
• uses - Io::removeNonMatches()
• uses - Io::dirList()

Method getBase (line 444)

void getBase( array $filelist)

Retrieve common directory (case-insensitive in windows)

Parameters

• array $filelist: array of strings

Info

Method getDirTree (line 564)

void getDirTree( string $dir, string $base_dir, [array $ignore = array()], [boolean $hidden = false], [boolean $ignoresymlinks = false])

Parameters

• string $dir: directory
• string $base_dir: base directory
• array $ignore: array of ignored items
• boolean $hidden: the "hidden" flag
• boolean $ignoresymlinks: the "ignoresymlinks" flag

Info

• uses - setup_dirs()
• uses - Io::dirList()
• uses - Io::checkIgnore()

Method getReadmeInstallChangelog (line 537)

array getReadmeInstallChangelog( string $base, array $filelist)

Parameters

• string $base: base directory from getBase()
• array $filelist: file list from dirList()

Info

• return - array(filelist - README/INSTALL/CHANGELOG, README/INSTALL/CHANGELOG)

Method getRegExpableSearchString (line 832)

string getRegExpableSearchString( string $s)

Converts $s into a string that can be used with preg_match

Parameters

• string $s: string with wildcards ? and *

Info

• return - converts * to .*, ? to ., etc.
• author - Greg Beaver <[email protected]>

Method getTutorials (line 493)

array getTutorials( array $filelist)

Retrieve tutorial subdirectories and their contents from the list of

Parameters

• array $filelist: array of paths (strings)

Info

• return - array(filelist - tutorials, tutorials)

Method isIncludeable (line 245)

boolean isIncludeable( string $filename)

calls http://www.php.net/file_exists for each value in include_path,

Parameters

• string $filename:

Info

Method parseArgv (line 277)

array parseArgv( )

Parses $_SERVER['argv'] and creates a setup array

Info

• return - a setup array
• global - array $argv: command-line arguments
• todo - replace with Console_* ?

Method readPhpFile (line 648)

void readPhpFile( string $path, [ $quietMode = false])

Reads a file and returns it as a string Does basic error checking

Parameters

• string $path:
• $quietMode:

Info

• global - array $_phpDocumentor_cvsphpfile_exts: PHP File extensions, used to validate that $path is a PHP File
• global - array $_phpDocumentor_phpfile_exts: PHP File extensions in a CVS repository, used to validate that $path is a PHP File

Method removeNonMatches (line 859)

string|array removeNonMatches( array $dir, string $match)

Removes files from the $dir array that do not match the search string in

Parameters

• array $dir: array of filenames (full path)
• string $match: search string with wildcards

Info

• return - listing of every file in a directory that matches the search string
• author - Greg Beaver <[email protected]>
• usedby - Io::getAllFiles()

Method _setupIgnore (line 796)

void _setupIgnore( array $ignore)

Construct the $ignore array

Parameters

• array $ignore: strings of files/paths/wildcards to ignore

Info

• author - Greg Beaver <[email protected]>
• access - protected