Precheck
in package
Class Precheck
Tags
Table of Contents
- $configuration : KeyValueCollection
- Found configuration values.
- $dangerousToolsGlobs : array<string|int, mixed>
- Collection of globs to find dangerous tools like 'adminer' or 'dumper'.
- $db : CI_DB_query_builder
- Database query builder.
- $defaultLanguages : array<string|int, mixed>
- Array of known languages (mostly the default installed ones).
- $maxMysqlVersion : string
- Minimum MySQL version required.
- $maxPhpVersion : string
- Maximum PHP version required.
- $minMysqlVersion : string
- Minimum MySQL version required.
- $minPhpVersion : string
- Minimum PHP version required.
- $settings : KeyValueCollection
- Collection of variables used.
- $shopVersion : string
- Found shop version.
- $usermodGlobPattern : string
- Glob search pattern for usermods.
- __construct() : mixed
- Precheck constructor.
- getActiveTemplate() : string
- Returns the name of the currently used template.
- getAdditionalTemplates() : array<string|int, mixed>
- Returns an array of additional installed templates (template name).
- getDangerousTools() : array<string|int, mixed>
- Returns an array with dangerous tools installed.
- getForeignLanguages() : array<string|int, mixed>
- Returns the installed foreign languages.
- getForeignModules() : array<string|int, mixed>
- Returns the installed foreign languages.
- getForeignOrderTotalModules() : array<string|int, mixed>
- Returns an array of foreign installed order total modules.
- getForeignPaymentModules() : array<string|int, mixed>
- Returns an array of foreign installed payment modules.
- getForeignShippingModules() : array<string|int, mixed>
- Returns an array of foreign installed shipping modules.
- getMobileCandyUsermods() : array<string|int, mixed>
- Returns an array of MobileCandy usermods found.
- getMysqlVersion() : string
- Returns the running MySQL version number.
- getPhpVersion() : string
- Returns the running PHP version number.
- getServerAddress() : string
- Returns the server address.
- getServerOs() : string
- Returns the server's operating system.
- getServerPath() : string
- Returns the server path.
- getShopUrl() : string
- Returns the shop's URL.
- getShopVersion() : string
- Returns the installed shop version.
- getUserComponents() : array<string|int, mixed>
- Returns an array of custom user components.
- getUsermods() : array<string|int, mixed>
- Returns an array of usermods found.
- hasGlobalUsermodDir() : bool
- Determines if there is a global usermod directory.
- isCurlEnabled() : bool
- Determines if cUrl is available on this platform.
- isInstalledMobileCandy() : bool
- Determines if the MobileCandy template is installed.
- isMySqlVersionAboveMinimum() : bool
- Determines if the installed MySQL version is above the minimum version required.
- isMySqlVersionBelowMaximum() : bool
- Determines if the installed MySQL version is below the maximum version required.
- isPhpVersionAboveMinimum() : bool
- Determines if the installed PHP version is above the minimum version required.
- isPhpVersionBelowMaximum() : bool
- Determines if the installed PHP version is below the maximum version required.
- isUsingWindowsOs() : bool
- Determines if the server is running on windows operating system.
- _checkSettings() : mixed
- Verifies that the settings collection parameter contains all necessary entries.
- _getConfigurationValues() : KeyValueCollection
- Loads the configuration from the database and returns it as collection.
- _hasForeignModuleCatenoShopsync() : bool
- Determines if the foreign module Cateno Shopsync is installed.
- _hasForeignModuleEstelcoPdfCatalog() : bool
- Determines if the foreign module PDF Katalog (Estelco) is installed.
- _hasForeignModuleJtlWawiConnector() : bool
- Determines if the foreign module JTL Wawi Connector is installed.
- _hasForeignModuleOrgamax() : bool
- Determines if the foreign module Orgamax is installed.
- _recursiveGlobSearch() : array<string|int, mixed>
- Performs a recursive glob search.
Properties
$configuration
Found configuration values.
protected
KeyValueCollection
$configuration
$dangerousToolsGlobs
Collection of globs to find dangerous tools like 'adminer' or 'dumper'.
protected
array<string|int, mixed>
$dangerousToolsGlobs
$db
Database query builder.
protected
CI_DB_query_builder
$db
$defaultLanguages
Array of known languages (mostly the default installed ones).
protected
array<string|int, mixed>
$defaultLanguages
$maxMysqlVersion
Minimum MySQL version required.
protected
string
$maxMysqlVersion
= ''
$maxPhpVersion
Maximum PHP version required.
protected
string
$maxPhpVersion
= ''
$minMysqlVersion
Minimum MySQL version required.
protected
string
$minMysqlVersion
= ''
$minPhpVersion
Minimum PHP version required.
protected
string
$minPhpVersion
= ''
$settings
Collection of variables used.
protected
KeyValueCollection
$settings
$shopVersion
Found shop version.
protected
string
$shopVersion
= ''
$usermodGlobPattern
Glob search pattern for usermods.
protected
string
$usermodGlobPattern
Methods
__construct()
Precheck constructor.
public
__construct(CI_DB_query_builder $db, KeyValueCollection $settings) : mixed
Parameters
- $db : CI_DB_query_builder
-
Database query builder.
- $settings : KeyValueCollection
-
Settings key value collection (see #_checkSettings).
Return values
mixed —getActiveTemplate()
Returns the name of the currently used template.
public
getActiveTemplate() : string
Tags
Return values
string —getAdditionalTemplates()
Returns an array of additional installed templates (template name).
public
getAdditionalTemplates() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDangerousTools()
Returns an array with dangerous tools installed.
public
getDangerousTools() : array<string|int, mixed>
Return values
array<string|int, mixed> —getForeignLanguages()
Returns the installed foreign languages.
public
getForeignLanguages() : array<string|int, mixed>
Return values
array<string|int, mixed> —getForeignModules()
Returns the installed foreign languages.
public
getForeignModules() : array<string|int, mixed>
Return values
array<string|int, mixed> —getForeignOrderTotalModules()
Returns an array of foreign installed order total modules.
public
getForeignOrderTotalModules(array<string|int, mixed> $defaultModules) : array<string|int, mixed>
Parameters
- $defaultModules : array<string|int, mixed>
-
List of default order total modules (note, that a file path has to be relative to the order_total directory).
Tags
Return values
array<string|int, mixed> —getForeignPaymentModules()
Returns an array of foreign installed payment modules.
public
getForeignPaymentModules(array<string|int, mixed> $defaultModules) : array<string|int, mixed>
Parameters
- $defaultModules : array<string|int, mixed>
-
List of default payment modules (note, that a file path has to be relative to the payment directory).
Tags
Return values
array<string|int, mixed> —getForeignShippingModules()
Returns an array of foreign installed shipping modules.
public
getForeignShippingModules(array<string|int, mixed> $defaultModules) : array<string|int, mixed>
Parameters
- $defaultModules : array<string|int, mixed>
-
List of default shipping modules (note, that a file path has to be relative to the shipping directory).
Tags
Return values
array<string|int, mixed> —getMobileCandyUsermods()
Returns an array of MobileCandy usermods found.
public
getMobileCandyUsermods() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getMysqlVersion()
Returns the running MySQL version number.
public
getMysqlVersion() : string
Return values
string —getPhpVersion()
Returns the running PHP version number.
public
getPhpVersion() : string
Return values
string —getServerAddress()
Returns the server address.
public
getServerAddress() : string
Return values
string —getServerOs()
Returns the server's operating system.
public
getServerOs() : string
Return values
string —getServerPath()
Returns the server path.
public
getServerPath() : string
Return values
string —getShopUrl()
Returns the shop's URL.
public
getShopUrl() : string
Return values
string —getShopVersion()
Returns the installed shop version.
public
getShopVersion() : string
Return values
string —getUserComponents()
Returns an array of custom user components.
public
getUserComponents() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUsermods()
Returns an array of usermods found.
public
getUsermods() : array<string|int, mixed>
Return values
array<string|int, mixed> —hasGlobalUsermodDir()
Determines if there is a global usermod directory.
public
hasGlobalUsermodDir() : bool
Return values
bool —isCurlEnabled()
Determines if cUrl is available on this platform.
public
isCurlEnabled() : bool
Return values
bool —isInstalledMobileCandy()
Determines if the MobileCandy template is installed.
public
isInstalledMobileCandy() : bool
Tags
Return values
bool —isMySqlVersionAboveMinimum()
Determines if the installed MySQL version is above the minimum version required.
public
isMySqlVersionAboveMinimum() : bool
If true, the result is positive.
Return values
bool —isMySqlVersionBelowMaximum()
Determines if the installed MySQL version is below the maximum version required.
public
isMySqlVersionBelowMaximum() : bool
If true, the result is positive.
Return values
bool —isPhpVersionAboveMinimum()
Determines if the installed PHP version is above the minimum version required.
public
isPhpVersionAboveMinimum() : bool
If true, the result is positive.
Return values
bool —isPhpVersionBelowMaximum()
Determines if the installed PHP version is below the maximum version required.
public
isPhpVersionBelowMaximum() : bool
If true, the result is positive.
Return values
bool —isUsingWindowsOs()
Determines if the server is running on windows operating system.
public
isUsingWindowsOs() : bool
Return values
bool —_checkSettings()
Verifies that the settings collection parameter contains all necessary entries.
protected
_checkSettings(KeyValueCollection $settings) : mixed
Needed keys are:
- shopVersion (Current shop version - coming from release info)
- DIR_FS_CATALOG (Value from configure.php)
- HTTP_SERVER (Value from configure.php)
- DIR_WS_CATALOG (Value from configure.php)
Parameters
- $settings : KeyValueCollection
Tags
Return values
mixed —_getConfigurationValues()
Loads the configuration from the database and returns it as collection.
protected
_getConfigurationValues() : KeyValueCollection
Tags
Return values
KeyValueCollection —_hasForeignModuleCatenoShopsync()
Determines if the foreign module Cateno Shopsync is installed.
protected
_hasForeignModuleCatenoShopsync() : bool
Tags
Return values
bool —_hasForeignModuleEstelcoPdfCatalog()
Determines if the foreign module PDF Katalog (Estelco) is installed.
protected
_hasForeignModuleEstelcoPdfCatalog() : bool
Tags
Return values
bool —_hasForeignModuleJtlWawiConnector()
Determines if the foreign module JTL Wawi Connector is installed.
protected
_hasForeignModuleJtlWawiConnector() : bool
Tags
Return values
bool —_hasForeignModuleOrgamax()
Determines if the foreign module Orgamax is installed.
protected
_hasForeignModuleOrgamax() : bool
Tags
Return values
bool —_recursiveGlobSearch()
Performs a recursive glob search.
protected
_recursiveGlobSearch(string $pattern, int $flags) : array<string|int, mixed>
Parameters
- $pattern : string
-
Glob search pattern.
- $flags : int
-
Glob search flags.