UPDATE.php
WIKINDX : Bibliographic Management system.
Tags
Table of Contents
- needUpdate() : bool
- Check if the current WIKINDX data (db and files) need an upgrade
- existsTableVersion() : bool
- Check if 'version' table that stores the version number of the db schema exists
- getCoreInternalVersion() : float
- Return the internal version stored in the database of the core
- setCoreInternalVersion() : mixed
- Write an internal version in the database of a component or the core
- getPluginInternalVersion() : float
- Return the internal version stored in the database of a plugin
- setPluginInternalVersion() : mixed
- Write an internal version in the database of a plugin
- existsSuperadminAccount() : bool
- Check if 'users' table has not been filled with the superadmin account
- getConfigContactEmail() : float
- Return the configContactEmail depending on the software version
- logonCheckUpgradeDB() : bool
- Initial logon to the system when upgrading the database.
Functions
needUpdate()
Check if the current WIKINDX data (db and files) need an upgrade
needUpdate(object $dbo) : bool
Parameters
- $dbo : object
-
An SQL object
Return values
bool —existsTableVersion()
Check if 'version' table that stores the version number of the db schema exists
existsTableVersion(object $dbo) : bool
Check also the old names of the version table.
This function is used only during the upgrade process.
Parameters
- $dbo : object
-
An SQL object
Return values
bool —getCoreInternalVersion()
Return the internal version stored in the database of the core
getCoreInternalVersion(object $dbo) : float
This function is used only during the upgrade process, and the value should be looked up in the field regardless of the version.
Parameters
- $dbo : object
-
An SQL object
Return values
float —setCoreInternalVersion()
Write an internal version in the database of a component or the core
setCoreInternalVersion(object $dbo[, string $version = NULL ]) : mixed
This function is used only during the upgrade process, and the value should be written in the field regardless of the version.
If $version is NULL, the version number used it 0.0.
Parameters
- $dbo : object
-
An SQL object
- $version : string = NULL
-
(Default is NULL)
Return values
mixed —getPluginInternalVersion()
Return the internal version stored in the database of a plugin
getPluginInternalVersion(object $dbo, string $ComponentId) : float
This function is used only during the upgrade process, and the value should be looked up in the field regardless of the version.
Parameters
- $dbo : object
-
An SQL object
- $ComponentId : string
-
Id of a component or 'core' for the WIKINDX core
Return values
float —setPluginInternalVersion()
Write an internal version in the database of a plugin
setPluginInternalVersion(object $dbo, string $ComponentId[, string $version = NULL ]) : mixed
This function is used only during the upgrade process, and the value should be written in the field regardless of the version.
If $version is NULL, the version number used it 0.0.
Parameters
- $dbo : object
-
An SQL object
- $ComponentId : string
-
Id of a component or 'core' for the WIKINDX core
- $version : string = NULL
-
(Default is NULL)
Return values
mixed —existsSuperadminAccount()
Check if 'users' table has not been filled with the superadmin account
existsSuperadminAccount(object $dbo) : bool
This function is used only during the upgrade process.
Parameters
- $dbo : object
-
An SQL object
Return values
bool —getConfigContactEmail()
Return the configContactEmail depending on the software version
getConfigContactEmail(object $dbo) : float
This function is used only during the upgrade process, and the value should be looked up in the field regardless of the version.
Parameters
- $dbo : object
-
An SQL object
Return values
float —logonCheckUpgradeDB()
Initial logon to the system when upgrading the database.
logonCheckUpgradeDB(object $dbo, string $username, string $password) : bool
Parameters
- $dbo : object
-
An SQL object
- $username : string
- $password : string
Return values
bool —TRUE if able to authenticate