Class: Io

Source Location: /phpDocumentor/Io.inc

Class Overview [line 50]


Class to handle file and user io opperations

Author(s):

Version:

  • $Id: Io.inc 286921 2009-08-08 05:01:24Z ashnazg $

Copyright:

Variables

Constants

Methods


Inherited Variables

Inherited Constants

Inherited Methods



Class Details

Class to handle file and user io opperations

Tags:

[ 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

Overrides:

[ Top ]

$phpDocOptions

[line 57]

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

and to the different web interfaces

Type: mixed

Overrides:

[ 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

Overrides:

[ Top ]


Class Methods

Io

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:

[ Top ]

checkIgnore

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:

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

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

[line 377]

Tags:

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

string displayHelpMsg( )

[line 204]

create the help message for display on the command-line

Tags:

  • return - a string containing a help message

Parameters:

[ Top ]

getAllFiles

mixed getAllFiles( string $file)

[line 888]

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

wildcards

Tags:

Parameters:

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

[ Top ]

getBase

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

[ Top ]

getDirTree

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

[line 564]

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

[ Top ]

getReadmeInstallChangelog

array getReadmeInstallChangelog( string $base, array $filelist)

[line 537]

Tags:

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

Parameters:

[ Top ]

getRegExpableSearchString

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 <cellog@php.net>

Parameters:

  • string $s - string with wildcards ? and *

[ Top ]

getTutorials

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)

[ Top ]

isIncludeable

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 -

[ Top ]

parseArgv

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:

[ Top ]

readPhpFile

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 -

[ Top ]

removeNonMatches

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:

Parameters:

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

[ Top ]

_setupIgnore

void _setupIgnore( array $ignore)

[line 796]

Construct the $ignore array

Tags:

Parameters:

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

[ Top ]


Class Constants


Documentation generated on Tue, 06 Dec 2011 07:08:05 -0600 by phpDocumentor 1.4.4