class InstallEvents extends InstallEvents

Class InstallEvents

Properties

xm_groups read-only $mod

Methods

__construct(Controller $mod, string $oldRevision)

InstallEvents constructor.

afterModuleUpdate($old_revision, $module, $instance_id)

No description

afterTableUpdate($old_revision, $module, $instance_id)

No description

beforeTableUpdate($old_revision, $module, $instance_id)

Called before SQL tranformations are applied to the database

initializeAfterInstall($old_revision, $module, $instance_id)

No description

bool
isVersionGreaterThan(string $version, int $oldRevision = null)

Returns true if the given old revision relates to an newer version then the given version.

bool
isVersionLessThan(string $version, int $oldRevision = null)

Returns true if the given old revision relates to an older version then the given version.

string
revisionToXelosVersion(int $revision)

Return XELOS version for the supplied build number in PHP style notation e.g. 7.1.5 for use with version_compare()

Details

in InstallEvents at line 25
__construct(Controller $mod, string $oldRevision)

InstallEvents constructor.

Parameters

Controller $mod
string $oldRevision

at line 159
afterModuleUpdate($old_revision, $module, $instance_id)

No description

Parameters

$old_revision
$module
$instance_id

Exceptions

UnexpectedValueException

at line 24
afterTableUpdate($old_revision, $module, $instance_id)

No description

Parameters

$old_revision
$module
$instance_id

Exceptions

Exception

in InstallEvents at line 46
beforeTableUpdate($old_revision, $module, $instance_id)

Called before SQL tranformations are applied to the database

Parameters

$old_revision
$module
$instance_id

at line 34
initializeAfterInstall($old_revision, $module, $instance_id)

No description

Parameters

$old_revision
$module
$instance_id

Exceptions

Exception

in InstallEvents at line 103
bool isVersionGreaterThan(string $version, int $oldRevision = null)

Returns true if the given old revision relates to an newer version then the given version.

Parameters

string $version

Standard Version Format e.g. 8.0.1

int $oldRevision

Internal Build Revision Number e.g. 80123

Return Value

bool

in InstallEvents at line 89
bool isVersionLessThan(string $version, int $oldRevision = null)

Returns true if the given old revision relates to an older version then the given version.

Parameters

string $version

Standard Version Format e.g. 8.0.1

int $oldRevision

Internal Build Revision Number e.g. 80123

Return Value

bool

in InstallEvents at line 76
final string revisionToXelosVersion(int $revision)

Return XELOS version for the supplied build number in PHP style notation e.g. 7.1.5 for use with version_compare()

Parameters

int $revision

Build Number

Return Value

string

XELOS version as in 7.1.0