Docs For Class HarmoniVersionRequirement

Description

This StartupRequirement checks to make sure we are running a certain version of Harmoni, or newer.

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

StartupRequirement
   |
   --HarmoniVersionRequirement

Variable Summary

mixed $_harmoni

mixed $_version

mixed $_versionStr

Method Summary

HarmoniVersionRequirement HarmoniVersionRequirement (ref $harmoni, string $version)

ref createWizard ()

int doUpdate ([optional $properties = null])

string getDisplayName ()

integer getStatus ()

Variables

mixed $_harmoni (line 23)

mixed $_version (line 24)

mixed $_versionStr (line 25)

Methods

Constructor HarmoniVersionRequirement (line 32)

Constructor

HarmoniVersionRequirement HarmoniVersionRequirement (ref $harmoni, string $version)

string $version: The harmoni version string, ie, "1.5.2".
ref $harmoni: object $harmoni A reference to a {$link Harmoni} object.

createWizard (line 86)

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

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

Returns this requirement's display name.

access: public

string getDisplayName ()

Redefinition of:

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

getStatus (line 46)

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