Docs For Class StartupRequirement

Description

A startup requirement is part of the application install/update system. A requirement class has the ability to check to make sure that the environment for running said program is OK, or to make updates to settings, database tables, etc to adjust for changes or program updates.

version: $Id: StartupRequirement.interface.php,v 1.8 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/StartupRequirement.interface.php (line 23)

Direct descendents

Class	Description
ExtensionRequirement	This StartupRequirement checks to make sure PHP has a given extension loaded (or can load it).
HarmoniVersionRequirement	This StartupRequirement checks to make sure we are running a certain version of Harmoni, or newer.
PHPConfigValueRequirement	A StartupRequirement that checks the value of a PHP config option. If the check fails, it will output an error message.

Method Summary

ref createWizard ()

int doUpdate ([optional $properties = null])

string getDisplayName ()

integer getStatus ()

Methods

createWizard (line 50)

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

return: object
access: public

ref createWizard ()

Redefined in descendants as:

ExtensionRequirement::createWizard() : Returns a Wizard object containing fields for user input to complete installation process.
HarmoniVersionRequirement::createWizard() : Returns a Wizard object containing fields for user input to complete installation process.
PHPConfigValueRequirement::createWizard() : Returns a Wizard object containing fields for user input to complete installation process.

doUpdate (line 61)

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 values gotten from the Wizard as created by StartupRequirement::createWizard().

Redefined in descendants as:

ExtensionRequirement::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.
HarmoniVersionRequirement::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.
PHPConfigValueRequirement::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 40)

Returns this requirement's display name.

access: public

string getDisplayName ()

Redefined in descendants as:

ExtensionRequirement::getDisplayName() : Returns this requirement's display name.
HarmoniVersionRequirement::getDisplayName() : Returns this requirement's display name.
PHPConfigValueRequirement::getDisplayName() : Returns this requirement's display name.

getStatus (line 30)

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

access: public

integer getStatus ()

Redefined in descendants as:

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