$ignore =
[line 63]
Format: array(array(regexp-ready string to search for whole path,
regexp-ready string to search for basename of ignore strings),...)
$phpDocOptions =
[line 57]
Holds all the options that are avaible to the cmd line interface
and to the different web interfaces
$valid_booleans = array
(
'', ' ', 'on', 'y', 'yes', 'true', '1',
'off', 'n', 'no', 'false', '0'
)
[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
constructor 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"
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
Tags:
return: true if $path should be ignored, false if it should not
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?
method dirList [line 377]
array dirList(
$orig_directory, [bool
$hidden = false], [bool
$ignore_symlinks = false], string
$directory)
Tags:
return: list of files in a 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
method displayHelpMsg [line 204]
create the help message for display on the command-line
Tags:
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
wildcards
Tags:
return: if $file contains wildcards, returns an array of matching files, otherwise returns false
Parameters:
string
$file
a full path from the -f command-line parameter, with potential * and ? wildcards.
method getBase [line 444]
void getBase(
array
$filelist)
Retrieve common directory (case-insensitive in windows)
takes the list of files, and returns the subdirectory they share in common, so in this list:
array(
"/dir1/dir2/subdir/dir3/filename.ext",
"/dir1/dir2/subdir/dir4/filename.ext",
"/dir1/dir2/mydir/dir5/filename.ext");
getBase will return "/dir1/dir2"
Parameters:
array
$filelist
array of strings
method getDirTree [line 564]
void getDirTree(
string
$dir, string
$base_dir, [array
$ignore = array()], [boolean
$hidden = false], [boolean
$ignoresymlinks = false])
Tags:
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
method getReadmeInstallChangelog [line 537]
array getReadmeInstallChangelog(
string
$base, array
$filelist)
Tags:
return: array(filelist - README/INSTALL/CHANGELOG, README/INSTALL/CHANGELOG)
Parameters:
method getRegExpableSearchString [line 832]
string getRegExpableSearchString(
string
$s)
Converts $s into a string that can be used with preg_match
Tags:
return: converts * to .*, ? to ., etc.
Parameters:
string
$s
string with wildcards ? and *
method getTutorials [line 493]
array getTutorials(
array
$filelist)
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)
method isIncludeable [line 245]
method 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_* ?
method readPhpFile [line 648]
void readPhpFile(
string
$path, [
$quietMode = false])
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:
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
$match
Tags:
return: listing of every file in a directory that matches the search string
Parameters:
array
$dir
array of filenames (full path)
string
$match
search string with wildcards
method _setupIgnore [line 796]
void _setupIgnore(
array
$ignore)
Construct the $ignore array
Tags:
Parameters:
array
$ignore
strings of files/paths/wildcards to ignore