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

Class: Io

Source Location: /phpDocumentor/Io.inc

Class Io

Class Overview

Class to handle file and user io opperations

Located in /phpDocumentor/Io.inc [line 50]



		
				Author(s):
		
		
		
Information Tags:
Version:  $Id: Io.inc 286921 2009-08-08 05:01:24Z ashnazg $

Properties

Methods

[ Top ]
Property Summary
false|array   $ignore   Format: array(array(regexp-ready string to search for whole path,
mixed   $phpDocOptions   Holds all the options that are avaible to the cmd line interface
array   $valid_booleans   A specific array of values that boolean-based arguments can understand, aided by the decideOnOrOff() helper method.

[ Top ]
Method Summary
Io   Io()   creates an array $this->phpDocOptions and sets program options in it.
bool   checkIgnore()   Tell whether to ignore a file or a directory allows * and ? wildcards
array   dirList()  
string   displayHelpMsg()   create the help message for display on the command-line
mixed   getAllFiles()   Take a filename with wildcards and return all files that match the
void   getBase()   Retrieve common directory (case-insensitive in windows)
void   getDirTree()  
array   getReadmeInstallChangelog()  
string   getRegExpableSearchString()   Converts $s into a string that can be used with preg_match
array   getTutorials()   Retrieve tutorial subdirectories and their contents from the list of
boolean   isIncludeable()   calls http://www.php.net/file_exists for each value in include_path,
array   parseArgv()   Parses $_SERVER['argv'] and creates a setup array
void   readPhpFile()   Reads a file and returns it as a string Does basic error checking
string|array   removeNonMatches()   Removes files from the $dir array that do not match the search string in
void   _setupIgnore()   Construct the $ignore array

[ Top ]
Properties
false|array   $ignore [line 63]

Format: array(array(regexp-ready string to search for whole path,

regexp-ready string to search for basename of ignore strings),...)


[ Top ]
mixed   $phpDocOptions [line 57]

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

and to the different web interfaces


[ Top ]
array   $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


[ Top ]
Methods
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 ]
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

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?

API Tags:
Return:  true if $path should be ignored, false if it should not
Usedby:  Io::getDirTree()

Information Tags:
Author:  Greg Beaver <cellog@php.net>

[ Top ]
dirList  [line 377]

  array dirList( $orig_directory, [bool $hidden = false], [bool $ignore_symlinks = false], string $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: 

API Tags:
Return:  list of files in a directory
Usedby:  Io::getAllFiles()
Usedby:  Io::getDirTree()


[ Top ]
displayHelpMsg  [line 204]

  string displayHelpMsg( )

create the help message for display on the command-line


API Tags:
Return:  a string containing a help message


[ Top ]
getAllFiles  [line 888]

  mixed getAllFiles( string $file  )

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

wildcards

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

API Tags:
Return:  if $file contains wildcards, returns an array of matching files, otherwise returns false
Uses:  Io::removeNonMatches()
Uses:  Io::dirList()

Information Tags:
Author:  Greg Beaver <cellog@php.net>

[ Top ]
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:

  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  [line 564]

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

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

API Tags:
Uses:  setup_dirs()
Uses:  Io::dirList()
Uses:  Io::checkIgnore()


[ Top ]
getReadmeInstallChangelog  [line 537]

  array getReadmeInstallChangelog( string $base, array $filelist  )

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

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


[ Top ]
getRegExpableSearchString  [line 832]

  string getRegExpableSearchString( string $s  )

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

Parameters:
string   $s:  string with wildcards ? and *

API Tags:
Return:  converts * to .*, ? to ., etc.

Information Tags:
Author:  Greg Beaver <cellog@php.net>

[ Top ]
getTutorials  [line 493]

  array getTutorials( array $filelist  )

Retrieve tutorial subdirectories and their contents from the list of

files to parse

Parameters:
array   $filelist:  array of paths (strings)

API Tags:
Return:  array(filelist - tutorials, tutorials)


[ Top ]
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 ]
parseArgv  [line 277]

  array parseArgv( )

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


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

Information Tags:
Todo:  replace with Console_* ?

[ Top ]
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

Parameters:
string   $path: 
   $quietMode: 

API 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


[ Top ]
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

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

API Tags:
Return:  listing of every file in a directory that matches the search string
Usedby:  Io::getAllFiles()

Information Tags:
Author:  Greg Beaver <cellog@php.net>

[ Top ]
_setupIgnore  [line 796]

  void _setupIgnore( array $ignore  )

Construct the $ignore array

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

API Tags:
Access:  protected

Information Tags:
Author:  Greg Beaver <cellog@php.net>

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:20:30 -0600 by phpDocumentor 1.4.4