expVersion
in package
This is the class expVersion
Tags
Table of Contents
- $check_site : mixed
- checkVersion() : bool
- Routine to check for installation or upgrade
- compareVersion() : bool
- Routine to compare passed versions
- dbVersion() : object
- Return an object of the current version number stored in the database.
- getDBVersion() : string
- Return a string of the current version number in the database.
- getVersion() : string
- Return a string of the current version number.
- swVersion() : object
- Return an object of the current version number of the software.
- iterateType() : int
- Routine to convert version iteration type to a rank
Properties
$check_site
private
static mixed
$check_site
= 'http://www.exponentcms.org/'
Methods
checkVersion()
Routine to check for installation or upgrade
public
static checkVersion([bool $force = false ]) : bool
Parameters
- $force : bool = false
Return values
bool —compareVersion()
Routine to compare passed versions
public
static compareVersion(object $version1, object $version2[, bool $onlypatchchk = false ]) : bool
Parameters
- $version1 : object
- $version2 : object
- $onlypatchchk : bool = false
-
returns false if major.minor.revision are equal and type is 'patch'
Return values
bool —set to true if $version1 is less than $version2
dbVersion()
Return an object of the current version number stored in the database.
public
static dbVersion() : object
Tags
Return values
object —getDBVersion()
Return a string of the current version number in the database.
public
static getDBVersion([bool $full = false ][, bool $type = false ][, bool $build = true ]) : string
Parameters
- $full : bool = false
-
Whether or not to return a full version number. If passed as true, a string in the form of '2.0.3-beta5' will be returned. Otherwise, '2.0' would be returned.
- $type : bool = false
-
Whether to include the type and interation of a full version number
- $build : bool = true
-
Whether or not to return the build date in the string.
Tags
Return values
string —getVersion()
Return a string of the current version number.
public
static getVersion([bool $full = false ][, bool $build = false ][, bool $type = true ]) : string
Parameters
- $full : bool = false
-
Whether or not to return a full version number. If passed as true, a string in the form of '2.0.3-beta5' will be returned. Otherwise, '2.0' would be returned.
- $build : bool = false
-
Whether or not to return the build date in the string.
- $type : bool = true
-
Whether to include the type and interation of a full version number
Tags
Return values
string —swVersion()
Return an object of the current version number of the software.
public
static swVersion() : object
Tags
Return values
object —iterateType()
Routine to convert version iteration type to a rank
private
static iterateType(string $type) : int
Parameters
- $type : string