Common information needed by all portions of the application

phpDocumentor :: automatic documentation generator

PHP versions 4 and 5

Copyright (c) 2001-2008 Gregory Beaver


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

 require_once ($cloneClassDir.DIRECTORY_SEPARATOR.$cloneClassFile) (line 81)
PATH_DELIMITER = '/' (line 62)
PHPDOCUMENTOR_VER = "1.4.3" (line 49)
PHPDOCUMENTOR_WINDOWS = substr(PHP_OS,0,3)=='WIN' (line 64)
tokenizer_ext = extension_loaded('tokenizer')&&version_compare(phpversion(),"4.3.0",">=") (line 58)
_IN_PHP5 = phpversion()=='5.0.0RC1-dev'||phpversion()=='5.0.0RC2-dev'||version_compare(phpversion(),'5.0.0','ge') (line 66)
debug (line 266)

Debugging output

  • todo: CS Cleanup - can't avoid "prefixed by package" error
void debug (string $s)
  • string $s: the "debug message" string to echo out
fancy_debug (line 279)

Returns a formatted var_dump for debugging purposes.

void fancy_debug (string $s, mixed $v)
  • string $s: string to display
  • mixed $v: unlimited number of variables to display with var_dump()
phpDocumentor_ConfigFileList (line 97)

used in phpdoc.php and new_phpdoc.php

  • return: an array of directory contents
  • todo: CS cleanup - rename function to PhpDocumentor_ConfigFileList
array phpDocumentor_ConfigFileList (string $directory)
  • string $directory: a directory string
phpDocumentor_get_class (line 304)

Returns a lower-cased version of get_class for PHP 5

get_class() returns case as declared in the file in PHP 5

  • return: the class name of the given object
  • todo: CS cleanup - rename function to PhpDocumentor_get_class
string phpDocumentor_get_class (object $object)
  • object $object: the object to get the classname for
phpDocumentor_parse_ini_file (line 146)

Parse an .ini file

Works like, except it will take a section like:


and return an associative array(MYVAR => array(value1, value2, value3))

  • todo: CS cleanup - rename function to PhpDocumentor_parse_ini_file
array phpDocumentor_parse_ini_file (string $filename, [bool $process_sections = false])
  • string $filename: full path to the ini file
  • bool $process_sections: add an associative index for each section [in brackets]

Documentation generated on Mon, 05 Dec 2011 21:02:41 -0600 by phpDocumentor 1.4.4