clean_modstate
extends upgradescript
in package
This is the class clean_modstate
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
- generic description of upgrade script
- name() : string
- name/title of upgrade script
- needed() : bool
- additional test(s) to see if upgrade script should be run
- prioritize() : bool
- Comparison function to prioritize upgrade scripts
- upgrade() : string
- reads in and corrects the modstate table, esp. since it has no index and allows duplicate entries we will assume that all old school modules have been upgraded at this point
Properties
$optional
public
mixed
$optional
= \false
$priority
public
mixed
$priority
= 98
$from_version
protected
mixed
$from_version
= '0.0.0'
$to_version
protected
mixed
$to_version
= '2.2.2'
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()
generic description of upgrade script
public
description() : string
Return values
string —name()
name/title of upgrade script
public
static name() : string
Return values
string —needed()
additional test(s) to see if upgrade script should be run
public
needed() : bool
Return values
bool —prioritize()
Comparison function to prioritize upgrade scripts
public
static prioritize( $a, $b) : bool
Parameters
Return values
bool —upgrade()
reads in and corrects the modstate table, esp. since it has no index and allows duplicate entries we will assume that all old school modules have been upgraded at this point
public
upgrade() : string