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

Author:	Greg Beaver <[email protected]>
Version:	CVS: $Id: common.inc.php 288074 2009-09-05 02:16:26Z ashnazg $
Copyright:	2001-2008 Gregory Beaver
See:	parserDocBlock, parserInclude, parserPage, parserClass
See:	parserDefine, parserFunction, parserMethod, parserVar
Link:	http://pear.php.net/PhpDocumentor
Link:	http://www.phpdoc.org
Todo:	CS cleanup - change package to PhpDocumentor
Todo:	CS cleanup - rename constant to TOKENIZER_EXT
Since:	1.0rc1
License:	LGPL
Filesource:	Source Code for this file

Includes

require_once ($cloneClassDir.DIRECTORY_SEPARATOR.$cloneClassFile) [line 81]

[ Top ]

Constants

PATH_DELIMITER [line 62]

PATH_DELIMITER = '/'

[ Top ]

PHPDOCUMENTOR_VER [line 49]

PHPDOCUMENTOR_VER = "1.4.3"

[ Top ]

PHPDOCUMENTOR_WEBSITE [line 53]

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

[ Top ]

PHPDOCUMENTOR_WINDOWS [line 64]

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

[ Top ]

SMART_PATH_DELIMITER [line 56]

SMART_PATH_DELIMITER = DIRECTORY_SEPARATOR

[ Top ]

tokenizer_ext [line 58]

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

[ Top ]

_IN_PHP5 [line 66]

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

[ Top ]

Functions

debug [line 266]

void debug(
string $s 
)

Debugging output

Parameters:

string

$s:

the "debug message" string to echo out

Information Tags:

Todo:

CS Cleanup - can't avoid "prefixed by package" error

[ Top ]

fancy_debug [line 279]

void fancy_debug(
string $s, mixed $v 
)

Returns a formatted var_dump for debugging purposes.

Parameters:

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

[ Top ]

phpDocumentor_ConfigFileList [line 97]

array phpDocumentor_ConfigFileList(
string $directory 
)

used in phpdoc.php and new_phpdoc.php

Parameters:

string

$directory:

a directory string

API Tags:

Return:

an array of directory contents

Information Tags:

Todo:

CS cleanup - rename function to PhpDocumentor_ConfigFileList

[ Top ]

phpDocumentor_get_class [line 304]

string phpDocumentor_get_class(
object $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

$object:

the object to get the classname for

API Tags:

Return:

the class name of the given object

Information Tags:

Todo:

CS cleanup - rename function to PhpDocumentor_get_class

[ Top ]

phpDocumentor_parse_ini_file [line 146]

array phpDocumentor_parse_ini_file(
string $filename, [bool $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
bool	$process_sections:	add an associative index for each section [in brackets]

Information Tags:

Todo:

CS cleanup - rename function to PhpDocumentor_parse_ini_file

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:16:53 -0600 by phpDocumentor 1.4.4

	phpDocumentor

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