[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]

Class: Io

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/

Class Overview

Class to handle file and user io opperations



  • $Id$



Inherited Variables

Inherited Methods

Class Details

[line 50]
Class to handle file and user io opperations

[ Top ]

Class Variables

$ignore =

[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

[ Top ]

$phpDocOptions =

[line 57]

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

and to the different web interfaces

Type:   mixed

[ Top ]

$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

Type:   array

[ Top ]

Method Detail

Io (Constructor)   [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 ]

checkIgnore   [line 721]

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


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

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


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

[ Top ]

displayHelpMsg   [line 208]

string displayHelpMsg( )

create the help message for display on the command-line
  • Return: a string containing a help message

[ Top ]

getAllFiles   [line 892]

mixed getAllFiles( string $file)

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



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

[ Top ]

getBase   [line 448]

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:

  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"


array   $filelist     array of strings

[ Top ]

getDirTree   [line 568]

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


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

array getReadmeInstallChangelog( string $base, array $filelist)



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

[ Top ]

getRegExpableSearchString   [line 836]

string getRegExpableSearchString( string $s)

Converts $s into a string that can be used with preg_match
  • Return: converts * to .*, ? to ., etc.
  • Author: Greg Beaver <>


string   $s     string with wildcards ? and *

[ Top ]

getTutorials   [line 497]

array getTutorials( array $filelist)

Retrieve tutorial subdirectories and their contents from the list of

files to parse

  • Return: array(filelist - tutorials, tutorials)


array   $filelist     array of paths (strings)

[ Top ]

isIncludeable   [line 249]

boolean isIncludeable( string $filename)

calls for each value in include_path,

then calls when it finds the file


string   $filename     

[ Top ]

parseArgv   [line 281]

array parseArgv( )

Parses $_SERVER['argv'] and creates a setup array
  • Return: a setup array
  • Global: array $argv: command-line arguments
  • Todo: replace with Console_* ?

[ Top ]

readPhpFile   [line 652]

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

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

file extensions are set in

  • 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


string   $path     

[ Top ]

removeNonMatches   [line 863]

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

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



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

[ Top ]

_setupIgnore   [line 800]

void _setupIgnore( array $ignore)

Construct the $ignore array


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

[ Top ]

Documentation generated on Sun, 02 Sep 2012 00:02:06 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.