Procedural File: common.inc.php

Source Location: /phpDocumentor/common.inc.php

Page Details

Common information needed by all portions of the application

phpDocumentor :: automatic documentation generator

PHP versions 4 and 5

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://pear.php.net/PhpDocumentor
See:	parserDocBlock, parserInclude, parserPage, parserClass
See:	parserDefine, parserFunction, parserMethod, parserVar
Since:	1.0rc1
Link:	http://www.phpdoc.org
Filesource:	Source Code for this file
Copyright:	2001-2006 Gregory Beaver
License:	LGPL
Version:	CVS: $Id: common.inc.php,v 1.7 2006/10/18 18:52:12 cellog Exp $
Author:	Greg Beaver <[email protected]>

Includes

require_once (__FILE__) [line 67]

[ Top ]

require_once ('PhpDocumentor/phpDocumentor/clone5.inc.php') [line 59]

[ Top ]

require_once ('PhpDocumentor/phpDocumentor/clone.inc.php') [line 61]

[ Top ]

require_once (__FILE__) [line 65]

[ Top ]

Constants

PATH_DELIMITER [line 52]

PATH_DELIMITER = '/'

[ Top ]

PHPDOCUMENTOR_VER [line 43]

PHPDOCUMENTOR_VER = "@VER@"

phpDocumentor version

[ Top ]

PHPDOCUMENTOR_WEBSITE [line 48]

PHPDOCUMENTOR_WEBSITE = "http://www.phpdoc.org"

phpDocumentor version

[ Top ]

PHPDOCUMENTOR_WINDOWS [line 53]

PHPDOCUMENTOR_WINDOWS = substr(PHP_OS,0,3)=='WIN'

[ Top ]

SMART_PATH_DELIMITER [line 49]

SMART_PATH_DELIMITER = DIRECTORY_SEPARATOR

[ Top ]

tokenizer_ext [line 50]

tokenizer_ext = extension_loaded('tokenizer')&&version_compare(phpversion(),"4.3.0",">=")

[ Top ]

_IN_PHP5 [line 54]

_IN_PHP5 = phpversion()=='5.0.0RC1-dev'||phpversion()=='5.0.0RC2-dev'||version_compare(phpversion(),'5.0.0','ge')

[ Top ]

Functions

debug [line 221]

void debug(
 $s 
)

Debugging output

Parameters:

$s:

[ Top ]

fancy_debug [line 232]

void fancy_debug(
string $s, mixed $v, mixed $v... 
)

Returns a formatted var_dump for debugging purposes.

Parameters:

string	$s:	string to display
mixed	$v:	variable to display with var_dump()
mixed	$v...:	unlimited number of additional variables to display with var_dump()

[ Top ]

phpDocumentor_ConfigFileList [line 76]

void phpDocumentor_ConfigFileList(
 $directory 
)

used in phpdoc.php and new_phpdoc.php

Parameters:

$directory:

[ Top ]

phpDocumentor_get_class [line 254]

void phpDocumentor_get_class(
 $object 
)

Returns a lower-cased version of get_class for PHP 5

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

Parameters:

$object:

[ Top ]

phpDocumentor_parse_ini_file [line 124]

array phpDocumentor_parse_ini_file(
string $filename, [boolean $process_sections = false] 
)

Parse an .ini file

Works like http://www.php.net/parse_ini_file, except it will take a section like:

 [MYVAR]
 value1
 value2
 value3

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

Parameters:

string	$filename:	full path to the ini file
boolean	$process_sections:	add an associative index for each section [in brackets]

[ Top ]

Documentation generated on Tue, 24 Oct 2006 09:21:15 -0500 by phpDocumentor 1.3.1

	phpDocumentor

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