Class: Io

[line 63]

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

regexp-ready string to search for basename of ignore strings),...)

Type: false|array

Overrides:

[line 57]

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

and to the different web interfaces

Type: mixed

Overrides:

[line 71]

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

Use lowercase letters always, to simplify string comparisons

Type: array

Overrides:

Io Io( )

[line 87]

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

Array is in the format of:

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

Parameters:

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

[line 717]

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

Tags:

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

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?

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

[line 377]

Tags:

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

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 -

string displayHelpMsg( )

[line 204]

create the help message for display on the command-line

Tags:

• return - a string containing a help message

Parameters:

mixed getAllFiles( string $file)

[line 888]

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

wildcards

Tags:

• 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()

Parameters:

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

void getBase( array $filelist)

[line 444]

Retrieve common directory (case-insensitive in windows)

takes the list of files, and returns the subdirectory they share in common, so in this list:

1.  array(
2.  "/dir1/dir2/subdir/dir3/filename.ext",
3.  "/dir1/dir2/subdir/dir4/filename.ext",
4.  "/dir1/dir2/mydir/dir5/filename.ext");

getBase will return "/dir1/dir2"

Parameters:

• array $filelist - array of strings

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

[line 564]

Tags:

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

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

array getReadmeInstallChangelog( string $base, array $filelist)

[line 537]

Tags:

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

Parameters:

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

string getRegExpableSearchString( string $s)

[line 832]

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

Tags:

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

Parameters:

• string $s - string with wildcards ? and *

array getTutorials( array $filelist)

[line 493]

Retrieve tutorial subdirectories and their contents from the list of

files to parse

Tags:

• return - array(filelist - tutorials, tutorials)

Parameters:

• array $filelist - array of paths (strings)

boolean isIncludeable( string $filename)

[line 245]

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

then calls http://www.php.net/is_readable when it finds the file

Parameters:

• string $filename -

array parseArgv( )

[line 277]

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

Tags:

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

Parameters:

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

[line 648]

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

file extensions are set in phpdoc.inc

Tags:

• 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

Parameters:

• string $path -
• $quietMode -

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

[line 859]

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

$match

Tags:

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

Parameters:

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

void _setupIgnore( array $ignore)

[line 796]

Construct the $ignore array

Tags:

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

Parameters:

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