File/phpDocumentor/Io.inc

Description

File and input handling routines

This class parses command-line options, and works with files to generate lists of files to parse based on the ignore/include options

phpDocumentor :: automatic documentation generator

PHP versions 4 and 5

Copyright (c) 2000-2006 Joshua Eichorn, Gregory Beaver

LICENSE:

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Classes
Class Description
 class Io Class to handle file and user io opperations
Functions
get_include_path (line 987)
void get_include_path ()
Ioinc_mystrucsort (line 913)

Sorting functions for the file list

void Ioinc_mystrucsort (string $a, string $b)
  • string $a
  • string $b
Ioinc_sortfiles (line 908)

Sorting functions for the file list

void Ioinc_sortfiles (string $a, string $b)
  • string $a
  • string $b
setup_dirs (line 956)

Recursively move contents of $struc into associative array

The contents of $struc have many indexes like 'dir/subdir/subdir2'. This function converts them to array('dir' => array('subdir' => array('subdir2')))

  • return: same as struc but with array('dir' => array(file1,file2,'subdir' => array(file1,...)))
  • usedby: Io::getDirTree()
array setup_dirs (array $struc, array $dir,  $contents)
  • array $struc: struc is array('dir' => array of files in dir,'dir/subdir' => array of files in dir/subdir,...)
  • array $dir: array form of 'dir/subdir/subdir2' array('dir','subdir','subdir2')
  • $contents
set_dir (line 934)

Recursively add all the subdirectories of $contents to $dir without erasing anything in

$dir

  • return: processed $dir
array set_dir (array $dir, array $contents)
  • array $dir
  • array $contents

Documentation generated on Mon, 05 Dec 2011 21:39:35 -0600 by phpDocumentor 1.4.4