Class PHPConfigValueRequirement

Description

A StartupRequirement that checks the value of a PHP config option. If the check fails, it will output an error message.

  • version: $Id: PHPConfigValueRequirement.class.php,v 1.6 2007/09/19 14:04:50 adamfranco Exp $
  • license: GNU General Public License (GPL)
  • copyright: Copyright © 2005, Middlebury College

Located in /polyphony/main/library/StartupCheck/CommonRequirements/PHPConfigValueRequirement.class.php (line 42)

StartupRequirement
   |
   --PHPConfigValueRequirement
Variable Summary
mixed $_key
mixed $_opt
mixed $_value
Method Summary
PHPConfigValueRequirement PHPConfigValueRequirement (string $key, mixed $value, [optional $opt = PHPINI_EQUAL])
ref createWizard ()
int doUpdate ([optional $properties = null])
string getDisplayName ()
integer getStatus ()
Variables
mixed $_key (line 44)
mixed $_opt (line 46)
mixed $_value (line 45)
Methods
Constructor PHPConfigValueRequirement (line 54)

Constructor

PHPConfigValueRequirement PHPConfigValueRequirement (string $key, mixed $value, [optional $opt = PHPINI_EQUAL])
  • string $key: The php.ini option to look for (ie, 'register_globals')
  • mixed $value: The value that is required.
  • optional $opt: int $opt An optional flag specifying how we should check the requirement. Options are: PHPINI_EQUAL (check for $key=$value, except for booleans), PHPINI_GREATER (check for $key>$value), PHPINI_LESS (check for $key<$value), PHPINI_BOOLEAN (will make sure the $key is true or false, depending on $value, which can be: "on", "off", true, false, 0, 1, "yes", "no", case insensitive)
createWizard (line 148)

Returns a Wizard object containing fields for user input to complete installation process.

  • return: object
  • access: public
ref createWizard ()

Redefinition of:
StartupRequirement::createWizard()
Returns a Wizard object containing fields for user input to complete installation process.
doUpdate (line 160)

Tells the requirement class to perform its update/install operation. If user input is required, it is passed in the form of a WizardStep containing field values.

  • return: Returns the new status of this requirement after attempting update.
  • access: public
int doUpdate ([optional $properties = null])
  • optional $properties: array $properties An array of WizardProperty objects corresponding to the Wizard as created by createWizard().

Redefinition of:
StartupRequirement::doUpdate()
Tells the requirement class to perform its update/install operation. If user input is required, it is passed in the form of a WizardStep containing field values.
getDisplayName (line 138)

Returns this requirement's display name.

  • access: public
string getDisplayName ()

Redefinition of:
StartupRequirement::getDisplayName()
Returns this requirement's display name.
getStatus (line 83)

Checks the environment and returns a status value. Return value is one of STARTUP_STATUS_* defines.

  • access: public
integer getStatus ()

Redefinition of:
StartupRequirement::getStatus()
Checks the environment and returns a status value. Return value is one of STARTUP_STATUS_* defines.

Inherited Methods

Inherited From StartupRequirement

StartupRequirement::createWizard()
StartupRequirement::doUpdate()
StartupRequirement::getDisplayName()
StartupRequirement::getStatus()

Documentation generated on Wed, 19 Sep 2007 10:25:30 -0400 by phpDocumentor 1.3.0RC3