upgradescript
in package
This is the abstract class upgradescript
Tags
Table of Contents
- $optional : mixed
- $priority : mixed
- $from_version : mixed
- $to_version : mixed
- checkVersion() : bool
- This routine should simply test version number (upgrade script requirements vs database version) to see if upgrade script should be run
- description() : string
- The generic description of upgrade script
- name() : string
- The name/title of upgrade script
- needed() : bool
- This routine should perform additional test(s) to see if upgrade script should be run (files/tables exist, etc...)
- prioritize() : bool
- Comparison function to prioritize upgrade scripts
- upgrade() : string
- The main routine of upgrade script which is run to upgrade Exponent
Properties
$optional
public
mixed
$optional
= \false
$priority
public
mixed
$priority
= 50
$from_version
protected
mixed
$from_version
= '9999.99.99'
$to_version
protected
mixed
$to_version
= '9999.99.99'
Methods
checkVersion()
This routine should simply test version number (upgrade script requirements vs database version) to see if upgrade script should be run
public
checkVersion(object $version) : bool
Parameters
- $version : object
Return values
bool —description()
The generic description of upgrade script
public
description() : string
Return values
string —name()
The name/title of upgrade script
public
static name() : string
Return values
string —needed()
This routine should perform additional test(s) to see if upgrade script should be run (files/tables exist, etc...)
public
needed() : bool
Return values
bool —prioritize()
Comparison function to prioritize upgrade scripts
public
static prioritize( $a, $b) : bool
Parameters
Return values
bool —upgrade()
The main routine of upgrade script which is run to upgrade Exponent
public
upgrade() : string