Docs for page Setup.inc.php

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

Tags:

author:	Gregory Beaver <[email protected]>
version:	CVS: $Id: Setup.inc.php 319351 2011-11-16 17:35:30Z ashnazg $
copyright:	2002-2006 Gregory Beaver
link:	http://pear.php.net/PhpDocumentor
link:	http://www.phpdoc.org
since:	1.2
license:	LGPL

Includes:

array $interface [line 74]

$interface is either 'web' or is not set at all

Default value:

$_GET['interface']

string $phpDocumentor_DefaultCategoryName [line 94]

default package name, set using -dn --defaultcategoryname

Tags:

name:

$phpDocumentor_DefaultCategoryName

Default value:

'default'

string $phpDocumentor_DefaultPackageName [line 87]

default package name, set using -dn --defaultpackagename

Tags:

name:

$phpDocumentor_DefaultPackageName

Default value:

'default'

array $_phpDocumentor_setting [line 79]

$_phpDocumentor_setting is either the value from the web interface, or is set up by Io::parseArgv()

Default value:

$_GET['setting']

checkForBugCondition [line 973]

void checkForBugCondition(
string $php_version, [string $php_bug_number = 'none'], [string $pear_bug_number = 'none'])

Crash in case of known, dangerous bug condition

Checks the PHP version that is executing PhpDocumentor, in case a known PHP/PEAR bug condition could be triggered by the PhpDocumentor execution.

Parameters

string	$php_version	the PHP version that contains the bug
string	$php_bug_number	the PHP bug number (if any)
string	$pear_bug_number	the PEAR bug number (if any)

[ Top ]

decideOnOrOff [line 932]

boolean decideOnOrOff(
[string $value_to_guess = 'NO VALUE WAS PASSED'])

Fuzzy logic to interpret the boolean args' intent

Tags:

return:

our best guess of the value's boolean intent

Parameters

string

$value_to_guess

the command-line option to analyze

[ Top ]

phpDocumentor_out [line 953]

void phpDocumentor_out(
 $string)

Print parse information if quiet setting is off

Parameters

$string

[ Top ]

Procedural File: Setup.inc.php

Classes:

Page Details:

Tags:

Includes:

array $interface [line 74]

string $phpDocumentor_DefaultCategoryName [line 94]

Tags:

string $phpDocumentor_DefaultPackageName [line 87]

Tags:

array $_phpDocumentor_setting [line 79]

checkForBugCondition [line 973]

Parameters

decideOnOrOff [line 932]

Tags:

Parameters

phpDocumentor_out [line 953]

Parameters