Class Precheck

Package: Precheck
Category: System
Located at Precheck/Precheck.inc.php

Methods summary

`public`	# `__construct( CI_DB_query_builder $db, KeyValueCollection $settings )` Precheck constructor. Precheck constructor. Parameters `$db` Database query builder. `$settings` Settings key value collection (see #_checkSettings).
`protected`	# `_checkSettings( KeyValueCollection $settings )` Verifies that the settings collection parameter contains all necessary entries. Verifies that the settings collection parameter contains all necessary entries. 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` Throws InvalidArgumentException On missing key. Protected
`protected KeyValueCollection`	# `_getConfigurationValues( )` Loads the configuration from the database and returns it as collection. Loads the configuration from the database and returns it as collection. Returns `KeyValueCollection` Protected
`protected array`	# `_recursiveGlobSearch( string $pattern, integer $flags = 0 )` Performs a recursive glob search. Performs a recursive glob search. Parameters `$pattern` Glob search pattern. `$flags` Glob search flags. Returns array Protected
`protected boolean`	# `_hasForeignModuleOrgamax( )` Determines if the foreign module Orgamax is installed. Determines if the foreign module Orgamax is installed. Returns boolean Protected
`protected boolean`	# `_hasForeignModuleEstelcoPdfCatalog( )` Determines if the foreign module PDF Katalog (Estelco) is installed. Determines if the foreign module PDF Katalog (Estelco) is installed. Returns boolean Protected
`protected boolean`	# `_hasForeignModuleJtlWawiConnector( )` Determines if the foreign module JTL Wawi Connector is installed. Determines if the foreign module JTL Wawi Connector is installed. Returns boolean Protected
`protected boolean`	# `_hasForeignModuleCatenoShopsync( )` Determines if the foreign module Cateno Shopsync is installed. Determines if the foreign module Cateno Shopsync is installed. Returns boolean Protected
`protected boolean`	# `_hasForeignModuleOpenCart( )` Determines if the foreign module Open Cart (Offene Warenkörbe) is installed. Determines if the foreign module Open Cart (Offene Warenkörbe) is installed. Returns boolean Protected
`protected boolean`	# `_hasForeignModuleIndivStyleBlog( )` Determines if the foreign module Blog (Indiv Style) is installed. Determines if the foreign module Blog (Indiv Style) is installed. Returns boolean Protected
`protected boolean`	# `_hasForeignModuleIndivStyleFreeProducts( )` Determines if the foreign module Gratisartikel (Indiv Style) - Free products is installed. Determines if the foreign module Gratisartikel (Indiv Style) - Free products is installed. Returns boolean Protected
`protected boolean`	# `_hasForeignModuleIndivStyleOpenCart( )` Determines if the foreign module Offene Warenkörbe (Indiv Style) - Open cart is installed. Determines if the foreign module Offene Warenkörbe (Indiv Style) - Open cart is installed. Returns boolean Protected
`public string`	# `getShopUrl( )` Returns the shop's URL. Returns the shop's URL. Returns string
`public string`	# `getShopVersion( )` Returns the installed shop version. Returns the installed shop version. Returns string
`public string`	# `getServerAddress( )` Returns the server address. Returns the server address. Returns string
`public string`	# `getServerOs( )` Returns the server's operating system. Returns the server's operating system. Returns string
`public string`	# `getPhpVersion( )` Returns the running PHP version number. Returns the running PHP version number. Returns string
`public string`	# `getMysqlVersion( )` Returns the running MySQL version number. Returns the running MySQL version number. Returns string
`public boolean`	# `isCurlEnabled( )` Determines if cUrl is available on this platform. Determines if cUrl is available on this platform. Returns boolean
`public string`	# `getActiveTemplate( )` Returns the name of the currently used template. Returns the name of the currently used template. Returns string
`public array`	# `getAdditionalTemplates( )` Returns an array of additional installed templates (template name). Returns an array of additional installed templates (template name). Returns array
`public array`	# `getUsermods( )` Returns an array of usermods found. Returns an array of usermods found. Returns array
`public boolean`	# `isInstalledMobileCandy( )` Determines if the MobileCandy template is installed. Determines if the MobileCandy template is installed. Returns boolean
`public array`	# `getMobileCandyUsermods( )` Returns an array of MobileCandy usermods found. Returns an array of MobileCandy usermods found. Returns array
`public boolean`	# `hasGlobalUsermodDir( )` Determines if there is a global usermod directory. Determines if there is a global usermod directory. Returns boolean
`public array`	# `getUserComponents( )` Returns an array of custom user components. Returns an array of custom user components. Returns array
`public array`	# `getForeignPaymentModules( array $defaultModules )` Returns an array of foreign installed payment modules. Returns an array of foreign installed payment modules. Parameters `$defaultModules` List of default payment modules (note, that a file path has to be relative to the payment directory). Returns array Throws InvalidArgumentException On empty array.
`public array`	# `getForeignShippingModules( array $defaultModules )` Returns an array of foreign installed shipping modules. Returns an array of foreign installed shipping modules. Parameters `$defaultModules` List of default shipping modules (note, that a file path has to be relative to the shipping directory). Returns array Throws InvalidArgumentException On empty array.
`public array`	# `getForeignOrderTotalModules( array $defaultModules )` Returns an array of foreign installed order total modules. Returns an array of foreign installed order total modules. Parameters `$defaultModules` List of default order total modules (note, that a file path has to be relative to the order_total directory). Returns array Throws InvalidArgumentException On empty array.
`public array`	# `getForeignModules( )` Returns the installed foreign languages. Returns the installed foreign languages. Returns array
`public array`	# `getForeignLanguages( )` Returns the installed foreign languages. Returns the installed foreign languages. Returns array
`public array`	# `getDangerousTools( )` Returns an array with dangerous tools installed. Returns an array with dangerous tools installed. Returns array
`public boolean`	# `isPhpVersionAboveMinimum( )` Determines if the installed PHP version is above the minimum version required. If true, the result is positive. Determines if the installed PHP version is above the minimum version required. If true, the result is positive. Returns boolean
`public boolean`	# `isPhpVersionBelowMaximum( )` Determines if the installed PHP version is below the maximum version required. If true, the result is positive. Determines if the installed PHP version is below the maximum version required. If true, the result is positive. Returns boolean
`public boolean`	# `isUsingWindowsOs( )` Determines if the server is running on windows operating system. Determines if the server is running on windows operating system. Returns boolean
`public boolean`	# `isMySqlVersionAboveMinimum( )` Determines if the installed MySQL version is above the minimum version required. If true, the result is positive. Determines if the installed MySQL version is above the minimum version required. If true, the result is positive. Returns boolean
`public boolean`	# `isMySqlVersionBelowMaximum( )` Determines if the installed MySQL version is below the maximum version required. If true, the result is positive. Determines if the installed MySQL version is below the maximum version required. If true, the result is positive. Returns boolean

Properties summary

`protected string`	`$minPhpVersion` Minimum PHP version required. Minimum PHP version required.	# `''`
`protected string`	`$maxPhpVersion` Maximum PHP version required. Maximum PHP version required.	# `''`
`protected string`	`$minMysqlVersion` Minimum MySQL version required. Minimum MySQL version required.	# `''`
`protected string`	`$maxMysqlVersion` Minimum MySQL version required. Minimum MySQL version required.	# `''`
`protected array`	`$dangerousToolsGlobs` Collection of globs to find dangerous tools like 'adminer' or 'dumper'. Collection of globs to find dangerous tools like 'adminer' or 'dumper'.	#
`protected CI_DB_query_builder`	`$db` Database query builder. Database query builder.	#
`protected KeyValueCollection`	`$settings` Collection of variables used. Collection of variables used.	#
`protected KeyValueCollection`	`$configuration` Found configuration values. Found configuration values.	#
`protected string`	`$shopVersion` Found shop version. Found shop version.	# `''`
`protected array`	`$defaultLanguages` Array of known languages (mostly the default installed ones). Array of known languages (mostly the default installed ones).	#
`protected string`	`$usermodGlobPattern` Glob search pattern for usermods. Glob search pattern for usermods.	#

Packages

Classes

Class Precheck

Methods summary

Parameters

Parameters

Throws

Protected

Returns

Protected

Parameters

Returns

Protected

Returns

Protected

Returns

Protected

Returns

Protected

Returns

Protected

Returns

Protected

Returns

Protected

Returns

Protected

Returns

Protected

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Properties summary