Public Member Functions | |
| __construct ($argv=array()) | |
| check () | |
| checkVersion ($versionInfo, $displayInfo=false) | |
| download () | |
| execute () | |
| latest () | |
| log ($message) | |
| promptContinue ($prompt="Continue?") | |
| upgrade () | |
| usage () | |
Data Fields | |
| $command | |
 Data Fields inherited from CommandLineTool | |
| $argv | |
| $scriptName | |
Detailed Description
Definition at line 25 of file UpgradeTool.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| UpgradeTool::__construct | ( | $argv = array() | ) |
Constructor.
- Parameters
-
$argv array command-line arguments
Reimplemented from CommandLineTool.
Definition at line 37 of file UpgradeTool.inc.php.
References CommandLineTool\$argv, AppLocale\requireComponents(), and usage().
Member Function Documentation
◆ check()
| UpgradeTool::check | ( | ) |
Perform version check against latest available version.
Definition at line 73 of file UpgradeTool.inc.php.
References checkVersion(), and VersionCheck\getLatestVersion().
◆ checkVersion()
| 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 160 of file UpgradeTool.inc.php.
References $application, PKPApplication\get(), VersionCheck\getCurrentCodeVersion(), and VersionCheck\getCurrentDBVersion().
◆ download()
| UpgradeTool::download | ( | ) |
Download latest package.
Definition at line 111 of file UpgradeTool.inc.php.
References $application, PKPApplication\get(), VersionCheck\getLatestVersion(), and promptContinue().
◆ execute()
| UpgradeTool::execute | ( | ) |
Execute the specified command.
Definition at line 65 of file UpgradeTool.inc.php.
References $command.
◆ latest()
| UpgradeTool::latest | ( | ) |
Print information about the latest available version.
Definition at line 80 of file UpgradeTool.inc.php.
References checkVersion(), and VersionCheck\getLatestVersion().
◆ log()
| UpgradeTool::log | ( | $message | ) |
Log install message to stdout.
- Parameters
-
$message string
Definition at line 224 of file UpgradeTool.inc.php.
◆ promptContinue()
| UpgradeTool::promptContinue | ( | $prompt = "Continue?" | ) |
Prompt user for yes/no input (default no).
- Parameters
-
$prompt string
Definition at line 214 of file UpgradeTool.inc.php.
Referenced by download().
◆ upgrade()
| UpgradeTool::upgrade | ( | ) |
Run upgrade script.
Definition at line 87 of file UpgradeTool.inc.php.
◆ usage()
| UpgradeTool::usage | ( | ) |
Print command usage information.
Reimplemented from CommandLineTool.
Definition at line 52 of file UpgradeTool.inc.php.
Referenced by __construct().
Field Documentation
◆ $command
| string UpgradeTool::$command |
command to execute (check|upgrade|download)
Definition at line 31 of file UpgradeTool.inc.php.
Referenced by execute().
The documentation for this class was generated from the following file:
