Docs For Class Io

Io (Constructor) [line 84]

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 ]

checkIgnore [line 685]

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

Return: true if $path should be ignored, false if it should not
Author: Greg Beaver <cellog@php.net>
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 ]

dirList [line 349]

array dirList(

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

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 ]

displayHelpMsg [line 201]

string displayHelpMsg(
)

create the help message for display on the command-line

Return: a string containing a help message

[ Top ]

getAllFiles [line 856]

mixed getAllFiles(
string
$file)

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

wildcards

Return: if $file contains wildcards, returns an array of matching files, otherwise returns false
Author: Greg Beaver <cellog@php.net>
Uses: Io::removeNonMatches()
Uses: Io::dirList()

Parameters:

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

[ Top ]

getBase [line 416]

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 ]

getDirTree [line 536]

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

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 ]

getReadmeInstallChangelog [line 509]

array getReadmeInstallChangelog(
string
$base, array
$filelist)

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

Parameters:

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

[ Top ]

getRegExpableSearchString [line 800]

string getRegExpableSearchString(
string
$s)

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

Return: converts * to .*, ? to ., etc.
Author: Greg Beaver <cellog@php.net>

Parameters:

string $s — string with wildcards ? and *

[ Top ]

getTutorials [line 465]

array getTutorials(
array
$filelist)

Retrieve tutorial subdirectories and their contents from the list of

files to parse

Return: array(filelist - tutorials, tutorials)

Parameters:

array $filelist — array of paths (strings)

[ Top ]

isIncludeable [line 242]

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 ]

parseArgv [line 273]

array parseArgv(
)

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

Return: a setup array
Global: array $argv: command-line arguments

[ Top ]

readPhpFile [line 616]

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

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 ]

removeNonMatches [line 827]

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

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

$match

Return: listing of every file in a directory that matches the search string
Author: Greg Beaver <cellog@php.net>
Usedby: Io::getAllFiles()

Parameters:

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

[ Top ]

_setupIgnore [line 764]

void _setupIgnore(
array
$ignore)

Construct the $ignore array

Author: Greg Beaver <cellog@php.net>
Access: protected

Parameters:

array $ignore — strings of files/paths/wildcards to ignore

[ Top ]

Class: Io

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$ignore =

$phpDocOptions =

$valid_booleans = array ( '', ' ', 'on', 'On', 'ON', 'y', 'Y', 'yes', 'Yes', 'YES', 'true', 'True', 'TRUE', '1', 'off', 'Off', 'OFF', 'n', 'N', 'no', 'No', 'NO', 'false', 'False', 'FALSE', '0' )

Method Detail

Io (Constructor) [line 84]

checkIgnore [line 685]

Parameters:

dirList [line 349]

Parameters:

displayHelpMsg [line 201]

getAllFiles [line 856]

Parameters:

getBase [line 416]

Parameters:

getDirTree [line 536]

Parameters:

getReadmeInstallChangelog [line 509]

Parameters:

getRegExpableSearchString [line 800]

Parameters:

getTutorials [line 465]

Parameters:

isIncludeable [line 242]

Parameters:

parseArgv [line 273]

readPhpFile [line 616]

Parameters:

removeNonMatches [line 827]

Parameters:

_setupIgnore [line 764]

Parameters:

$valid_booleans = array
(
'', ' ', 'on', 'On', 'ON', 'y', 'Y', 'yes', 'Yes', 'YES', 'true', 'True', 'TRUE', '1',
'off', 'Off', 'OFF', 'n', 'N', 'no', 'No', 'NO', 'false', 'False', 'FALSE', '0'
)