Docs For Class Io

constructor Io [line 87]

Io Io(
)

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"

[ Top ]

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
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?

[ Top ]

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
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

[ Top ]

method displayHelpMsg [line 204]

string displayHelpMsg(
)

create the help message for display on the command-line

Tags:

return:

a string containing a help message

[ Top ]

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
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.

[ Top ]

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

[ Top ]

method getDirTree [line 564]

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

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

[ Top ]

method getReadmeInstallChangelog [line 537]

array getReadmeInstallChangelog(
string
$base, array
$filelist)

Tags:

return:

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

Parameters:

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

[ Top ]

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.
author:	Greg Beaver <[email protected]>

Parameters:

string

string with wildcards ? and *

[ Top ]

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)

[ Top ]

method isIncludeable [line 245]

boolean isIncludeable(
string
$filename)

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

[ Top ]

method parseArgv [line 277]

array parseArgv(
)

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

Tags:

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

[ Top ]

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:

string	$path
	$quietMode

[ Top ]

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
author:	Greg Beaver <[email protected]>
usedby:	Io::getAllFiles()

Parameters:

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

[ Top ]

method _setupIgnore [line 796]

void _setupIgnore(
array
$ignore)

Construct the $ignore array

Tags:

author:	Greg Beaver <[email protected]>
access:	protected

Parameters:

array

$ignore

strings of files/paths/wildcards to ignore

[ Top ]

Class: Io

Class Overview

Author(s):

Version:

Variables

Methods

Class Details

Tags:

Class Variables

$ignore =

$phpDocOptions =

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

Class Methods

constructor Io [line 87]

method checkIgnore [line 717]

Tags:

Parameters:

method dirList [line 377]

Tags:

Parameters:

method displayHelpMsg [line 204]

Tags:

method getAllFiles [line 888]

Tags:

Parameters:

method getBase [line 444]

Parameters:

method getDirTree [line 564]

Tags:

Parameters:

method getReadmeInstallChangelog [line 537]

Tags:

Parameters:

method getRegExpableSearchString [line 832]

Tags:

Parameters:

method getTutorials [line 493]

Tags:

Parameters:

method isIncludeable [line 245]

Parameters:

method parseArgv [line 277]

Tags:

method readPhpFile [line 648]

Tags:

Parameters:

method removeNonMatches [line 859]

Tags:

Parameters:

method _setupIgnore [line 796]

Tags:

Parameters:

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

)