upgradeTool Class Reference
[Tools]

CLI tool for upgrading OJS. More...

Inheritance diagram for upgradeTool:

List of all members.

Public Member Functions
	check ()
	checkVersion ($versionInfo, $displayInfo=false)
	download ()
	execute ()
	latest ()
	log ($message)
	patch ()
	promptContinue ($prompt="Continue?")
	upgrade ()
	upgradeTool ($argv=array())
	usage ()

---

Detailed Description

CLI tool for upgrading OJS.

Note: Some functions require fopen wrappers to be enabled.

Definition at line 28 of file upgrade.php.

---

Member Function Documentation

upgradeTool.check

(

)

Perform version check against latest available version.

Definition at line 73 of file upgrade.php.

References checkVersion(), and VersionCheck.getLatestVersion().

upgradeTool.checkVersion	(	$	versionInfo,
		$	displayInfo = false
	)

Perform version check.

Parameters:

	$versionInfo	array latest version info
	$displayInfo	boolean just display info, don't perform check

Definition at line 243 of file upgrade.php.

References VersionCheck.getCurrentCodeVersion(), VersionCheck.getCurrentDBVersion(), VersionCheck.getPatch(), and VersionCheck.getVersionCheckUrl().

Referenced by check(), latest(), and patch().

upgradeTool.download

(

)

Download latest package/patch.

Definition at line 186 of file upgrade.php.

References VersionCheck.getLatestVersion(), VersionCheck.getPatch(), VersionCheck.getVersionCheckUrl(), and promptContinue().

upgradeTool.execute

(

)

Execute the specified command.

Definition at line 65 of file upgrade.php.

Referenced by upgrade().

upgradeTool.latest

(

)

Print information about the latest available version.

Definition at line 80 of file upgrade.php.

References checkVersion(), and VersionCheck.getLatestVersion().

upgradeTool.log

(

$

message

)

Log install message to stdout.

Parameters:

$message

string

Definition at line 308 of file upgrade.php.

upgradeTool.patch

(

)

Apply patch to update code to latest version.

Definition at line 123 of file upgrade.php.

References checkVersion(), VersionCheck.getLatestVersion(), VersionCheck.getPatch(), and promptContinue().

upgradeTool.promptContinue

(

$

prompt = "Continue?"

)

Prompt user for yes/no input (default no).

Parameters:

$prompt

string

Definition at line 298 of file upgrade.php.

Referenced by download(), and patch().

upgradeTool.upgrade

(

)

Run upgrade script.

Definition at line 87 of file upgrade.php.

References execute().

upgradeTool.upgradeTool

(

$

argv = array()

)

Constructor.

Parameters:

$argv

array command-line arguments

Definition at line 37 of file upgrade.php.

References CommandLineTool.$argv, and usage().

upgradeTool.usage

(

)

Print command usage information.

Reimplemented from CommandLineTool.

Definition at line 51 of file upgrade.php.

Referenced by upgradeTool().

---

The documentation for this class was generated from the following file:

• tools/upgrade.php