Docs For Class ExtensionRequirement

Description

This StartupRequirement checks to make sure PHP has a given extension loaded (or can load it).

version: $Id: ExtensionRequirement.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/ExtensionRequirement.class.php (line 21)

StartupRequirement
   |
   --ExtensionRequirement

Variable Summary

mixed $_extension

Method Summary

ExtensionRequirement ExtensionRequirement (string $extension)

ref createWizard ()

int doUpdate ([optional $properties = null])

string getDisplayName ()

integer getStatus ()

Variables

mixed $_extension (line 23)

Methods

Constructor ExtensionRequirement (line 29)

Constructor

ExtensionRequirement ExtensionRequirement (string $extension)

string $extension: The name of the extension that must be loaded (case-sensitive)

createWizard (line 71)

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 83)

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 61)

Returns this requirement's display name.

access: public

string getDisplayName ()

Redefinition of:

StartupRequirement::getDisplayName(): Returns this requirement's display name.

getStatus (line 38)

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()