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

Procedural File: Io.inc

Source Location: /phpDocumentor/Io.inc

Page Details

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

Link:  http://www.phpdoc.org
Link:  http://pear.php.net/PhpDocumentor
Since:  0.1
Filesource:  Source Code for this file
Version:  CVS: $Id: Io.inc,v 1.12 2006/05/23 13:09:26 cellog Exp $
Author:  Joshua Eichorn <jeichorn@phpdoc.org>
Copyright:  2000-2006 Joshua Eichorn, Gregory Beaver
License:  LGPL
Author:  Gregory Beaver <cellog@php.net>
Classes
Class Description
Io Class to handle file and user io opperations
Functions
get_include_path  [line 906]

void get_include_path( )


[ Top ]
Ioinc_mystrucsort  [line 832]

void Ioinc_mystrucsort( string $a, string $b  )

Sorting functions for the file list

Parameters:
string   $a: 
string   $b: 


[ Top ]
Ioinc_sortfiles  [line 827]

void Ioinc_sortfiles( string $a, string $b  )

Sorting functions for the file list

Parameters:
string   $a: 
string   $b: 


[ Top ]
setup_dirs  [line 875]

array setup_dirs( array $struc, array $dir, $contents  )

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')))

Parameters:
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: 

API Tags:
Return:  same as struc but with array('dir' => array(file1,file2,'subdir' => array(file1,...)))


[ Top ]
set_dir  [line 853]

array set_dir( array $dir, array $contents  )

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

$dir

Parameters:
array   $dir: 
array   $contents: 

API Tags:
Return:  processed $dir


[ Top ]


Documentation generated on Tue, 24 Oct 2006 09:23:52 -0500 by phpDocumentor 1.3.1