Documentation

CRM_Upgrade_Incremental_General
in package

This class contains generic upgrade logic which runs regardless of version.

Table of Contents

Constants

MIN_INSTALL_MARIADB_VER  = '10.2'
The minimum MariaDB version required to install Civi.
MIN_INSTALL_MYSQL_VER  = '5.7'
The minimum MySQL version required to install Civi.
MIN_INSTALL_PHP_VER  = '7.4.0'
The minimum PHP version required to install Civi.
MIN_RECOMMENDED_MARIADB_VER  = '10.4'
The minimum recommended MariaDB version.
MIN_RECOMMENDED_MYSQL_VER  = '5.7'
The minimum recommended MySQL version.
MIN_RECOMMENDED_PHP_VER  = '8.1.0'
The minimum recommended PHP version.
RECOMMENDED_PHP_VER  = '8.3.0'
The recommended PHP version.

Methods

setPreUpgradeMessage()  : mixed
Compute any messages which should be displayed before upgrade.
updateMessageTemplate()  : mixed
Perform any message template updates. 5.0+.
isExtensionInstalled()  : bool

Constants

MIN_INSTALL_MARIADB_VER

The minimum MariaDB version required to install Civi.

public mixed MIN_INSTALL_MARIADB_VER = '10.2'

MIN_INSTALL_MYSQL_VER

The minimum MySQL version required to install Civi.

public mixed MIN_INSTALL_MYSQL_VER = '5.7'

MIN_INSTALL_PHP_VER

The minimum PHP version required to install Civi.

public mixed MIN_INSTALL_PHP_VER = '7.4.0'

The minimum recommended MariaDB version.

public mixed MIN_RECOMMENDED_MARIADB_VER = '10.4'

A site running an earlier version will be encouraged to upgrade.

The minimum recommended MySQL version.

public mixed MIN_RECOMMENDED_MYSQL_VER = '5.7'

A site running an earlier version will be encouraged to upgrade.

The minimum recommended PHP version.

public mixed MIN_RECOMMENDED_PHP_VER = '8.1.0'

A site running an earlier version will be told to upgrade.

The recommended PHP version.

public mixed RECOMMENDED_PHP_VER = '8.3.0'

The point release will be dropped in recommendations unless it's .1 or higher.

Methods

setPreUpgradeMessage()

Compute any messages which should be displayed before upgrade.

public static setPreUpgradeMessage(string &$preUpgradeMessage, mixed $currentVer, mixed $latestVer) : mixed
Parameters
$preUpgradeMessage : string

alterable.

$currentVer : mixed
$latestVer : mixed

updateMessageTemplate()

Perform any message template updates. 5.0+.

public static updateMessageTemplate(mixed &$message, mixed $version) : mixed
Parameters
$message : mixed
$version : mixed

isExtensionInstalled()

private static isExtensionInstalled(string $key) : bool
Parameters
$key : string
Return values
bool

        
On this page

Search results