Class cSystemtest

Provides functions to test the system integrity

Package: Core\Backend
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Mischa Holz
Located at classes/class.systemtest.php

Methods summary
`public`	# `__construct( array $config )` Constructor to create an instance of this class. Constructor to create an instance of this class. Caches the given config array for later use. Parameters `$config` `array` $config A config array which should be similar to CONTENIDO's $cfg
`public`	# `runTests( boolean $testFileSystem = true )` Runs all available tests and stores the resuls in the messages array Runs all available tests and stores the resuls in the messages array Parameters `$testFileSystem` `boolean` $testFileSystem [optional] If this is true the file system checks will be performed too with standard settings.
`public`	# `storeResult( boolean $result, integer $severity, string $errorHeadline = "", string $errorMessage = "", string $successHeadline = "", string $successMessage = "" )` Stores a result in the messages array for later display Stores a result in the messages array for later display Parameters `$result` `boolean` $result true for success, false otherwise `$severity` `integer` $severity One one of the C_SEVERITY constants `$errorHeadline` `string` $errorHeadline [optional] The headline which will be stored in the case that $result is false `$errorMessage` `string` $errorMessage [optional] The message which will be stored in the case that $result is false `$successHeadline` `string` $successHeadline [optional] The headline which will be stored in the case that $result is true `$successMessage` `string` $successMessage [optional] The message which will be stored in the case that $result is true
`public array`	# `getResults( )` Returns the message array Returns the message array Returns `array` See `cSystemtest::$_messages`
`protected boolean\|array`	# `getFileInfo( string $sFilename )` Returns an array with information about the file, especially the file owner Returns an array with information about the file, especially the file owner The return array looks like this: array( "info" => $info, //'s' for a socket, 'l' for a symbolic link, '-' for a regular file, 'b' "block special", 'd' for a directory, 'c' "character special", 'p' FIFO pipe, 'u' for unkown "type" => $type, //A more descriptive version of $info "owner" => array( "id" => $id, //the owner id "read" => $read, //true if the owner is allowed to read the file "write" => $write //true if the owner is allowed to write the file ) "group" => array( "id" => $id, //the owner group "read" => $read, //true if the owner group is allowed to read the file "write" => $write //true if the owner group is allowed to write the file ) "others" => array( "read" => $read, //true if others are allowed to read the file "write" => $write //true if others are allowed to write the file ) ) Parameters `$sFilename` `string` $sFilename The path to the file Returns `boolean\|array` if the file can't be accessed
`protected boolean`	# `canWriteFile( string $filename )` Returns true if the file is writeable Returns true if the file is writeable Parameters `$filename` `string` $filename The path to the file Returns `boolean`
`protected boolean`	# `canWriteDir( string $dirname )` Returns true if the given file is a directory and if it is writeable Returns true if the given file is a directory and if it is writeable Parameters `$dirname` `string` $dirname The path to the directory Returns `boolean`
`protected number\|boolean`	# `getServerUID( )` Returns the current user which runs the PHP interpreter Returns the current user which runs the PHP interpreter Returns `number\|boolean` ID or false if unable to determine the user
`protected number\|boolean`	# `getServerGID( )` Returns the current group which runs the PHP interpreter Returns the current group which runs the PHP interpreter Returns `number\|boolean` ID or false if unable to determine the group
`protected integer`	# `predictCorrectFilepermissions( string $file )` Returns one of the CON_PREDICT suggestions depending on the permissions of the given file Returns one of the CON_PREDICT suggestions depending on the permissions of the given file Parameters `$file` `string` $file The path to the file Returns `integer` CON_PREDICT_*
`protected mixed`	# `getPHPIniSetting( string $setting )` Gets a PHP setting with ini_get Gets a PHP setting with ini_get Parameters `$setting` `string` $setting A PHP setting Returns `mixed` The value of the PHP setting or NULL if ini_get is disabled
`protected number`	# `getAsBytes( string $val )` Converts a string like "12M" to the correct number of bytes Converts a string like "12M" to the correct number of bytes Parameters `$val` `string` $val A string in the form of "12K", "12M" or "12G" Returns `number`
`protected array`	# `doMySQLConnect( string $host, string $username, string $password )` Connects to the database with the given settings Connects to the database with the given settings Parameters `$host` `string` $host The database host `$username` `string` $username The database user `$password` `string` $password The database user password Returns `array` with the cDB object on the first place and a bool on the second
`public integer`	# `isPHPExtensionLoaded( string $extension )` Checks if a given extension is loaded. Checks if a given extension is loaded. Parameters `$extension` `string` $extension A PHP extension Returns `integer` Returns one of the CON_EXTENSION constants
`public boolean`	# `isWindows( )` Returns true if the interpreter is run on Windows Returns true if the interpreter is run on Windows Returns `boolean`
`public boolean`	# `testPHPVersion( )` Test PHP function Test PHP function Returns `boolean` true if the test passed and false if not
`public boolean`	# `getSafeModeStatus( )` Returns `boolean` true if the test passed and false if not
`public boolean`	# `getSafeModeGidStatus( )` Returns `boolean` true if the test passed and false if not
`public boolean`	# `testXMLParserCreate( )` Returns `boolean` true if the test passed and false if not
`public boolean`	# `testFileUploadSetting( )` Returns `boolean` true if the test passed and false if not
`public boolean`	# `testMagicQuotesRuntimeSetting( )` Returns `boolean` true if the test passed and false if not
`public boolean`	# `testMagicQuotesSybaseSetting( )` Returns `boolean` true if the test passed and false if not
`public boolean`	# `testMaxExecutionTime( )` Returns `boolean` true if the test passed and false if not
`public boolean`	# `testZIPArchive( )` Returns `boolean` true if the test passed and false if not
`public boolean`	# `testMemoryLimit( )` Returns `boolean` true if the test passed and false if not
`public boolean`	# `testPHPSQLSafeMode( )` Returns `boolean` true if the test passed and false if not
`public boolean`	# `testDOMDocument( )` Returns `boolean` true if the test passed and false if not
`public boolean`	# `testPHPExtension( string $ext )` Parameters `$ext` `string` $ext Returns `boolean` true if the test passed and false if not
`public boolean`	# `testIconv( )` Returns `boolean` true if the test passed and false if not
`public boolean`	# `testGDGIFRead( )` Returns `boolean` true if the test passed and false if not
`public boolean`	# `testGDGIFWrite( )` Returns `boolean` true if the test passed and false if not
`public boolean`	# `testGDJPEGRead( )` Returns `boolean` true if the test passed and false if not
`public boolean`	# `testGDJPEGWrite( )` Returns `boolean` true if the test passed and false if not
`public boolean`	# `testGDPNGRead( )` Returns `boolean` true if the test passed and false if not
`public boolean`	# `testGDPNGWrite( )` Returns `boolean` true if the test passed and false if not
`public boolean`	# `testMySQLExtension( )` Returns `boolean` true if the test passed and false if not
`public boolean`	# `testMySQLiExtension( )` Returns `boolean` true if the test passed and false if not
`public boolean`	# `testMySQLModeStrict( string $host, string $username, string $password )` Parameters `$host` `string` $host `$username` `string` $username `$password` `string` $password Returns `boolean` true if the test passed and false if not
`public integer`	# `testMySQL( string $host, string $username, string $password )` Parameters `$host` `string` $host `$username` `string` $username `$password` `string` $password Returns `integer` 1 if the test passed and > 1 if not
`public boolean`	# `testFilesystem( boolean $testConfig = true, boolean $testFrontend = true )` Parameters `$testConfig` `boolean` $testConfig [optional] `$testFrontend` `boolean` $testFrontend [optional] Returns `boolean` true if the test passed and false if not
`protected boolean`	# `testSingleFile( string $filename, integer $severity, boolean $dir = false )` Checks a single file or directory wether it is writeable or not Checks a single file or directory wether it is writeable or not Parameters `$filename` `string` $filename The file `$severity` `integer` $severity The resulting C_SEVERITY constant should the test fail `$dir` `boolean` $dir [optional] True if the $filename is a directory Returns `boolean` Returns true if everything is fine Throws `Exception` Throws a generic Exception in the event that the permissions are wrong
`public boolean`	# `testFrontendFolderCreation( )` Returns `boolean` true if the test passed and false if not
`public integer`	# `checkOpenBasedirCompatibility( )` Checks for the open_basedir directive and returns one of the CON_BASEDIR constants Checks for the open_basedir directive and returns one of the CON_BASEDIR constants Returns `integer`
`public integer`	# `checkImageResizer( )` Checks the available image resizer classes and functions Checks the available image resizer classes and functions Returns `integer` Returns one of the CON_IMAGERESIZE constants
`public`	# `checkSetupMysql( string $setupType, string $databaseName, string $databasePrefix, string $charset = '', string $collation = '' )` Parameters `$setupType` `string` $setupType `$databaseName` `string` $databaseName `$databasePrefix` `string` $databasePrefix `$charset` `string` $charset [optional] `$collation` `string` $collation [optional]

Constants summary
`string`	`CON_SETUP_MIN_PHP_VERSION`	`'5.3'`	# The minimal PHP version The minimal PHP version
`integer`	`C_SEVERITY_NONE`	`1`	# Messages have no influence on the result of the system integrity Messages have no influence on the result of the system integrity
`integer`	`C_SEVERITY_INFO`	`2`	# Messages are only to inform the user about something. Messages are only to inform the user about something.
`integer`	`C_SEVERITY_WARNING`	`3`	# Messages about settings which aren't correct, but CONTENIDO might work anyway Messages about settings which aren't correct, but CONTENIDO might work anyway
`integer`	`C_SEVERITY_ERROR`	`4`	# Messages about settings which aren't correct. CONTENIDO won't work Messages about settings which aren't correct. CONTENIDO won't work
`integer`	`CON_PREDICT_SUFFICIENT`	`1`	# Possible result of cSystemtest::predictCorrectFilePermissions() The filepermissions are okay Possible result of cSystemtest::predictCorrectFilePermissions() The filepermissions are okay
`integer`	`CON_PREDICT_NOTPREDICTABLE`	`2`	# Possible result of cSystemtest::predictCorrectFilePermissions() The filepermissions are not predictable (we can't figure the server UID) Possible result of cSystemtest::predictCorrectFilePermissions() The filepermissions are not predictable (we can't figure the server UID)
`integer`	`CON_PREDICT_CHANGEPERM_SAMEOWNER`	`3`	# Possible result of cSystemtest::predictCorrectFilePermissions() The filepermissions for the owner have to be changed Possible result of cSystemtest::predictCorrectFilePermissions() The filepermissions for the owner have to be changed
`integer`	`CON_PREDICT_CHANGEPERM_SAMEGROUP`	`4`	# Possible result of cSystemtest::predictCorrectFilePermissions() The filepermissions for the group have to be changed Possible result of cSystemtest::predictCorrectFilePermissions() The filepermissions for the group have to be changed
`integer`	`CON_PREDICT_CHANGEPERM_OTHERS`	`5`	# Possible result of cSystemtest::predictCorrectFilePermissions() The filepermissions for others should be changed Possible result of cSystemtest::predictCorrectFilePermissions() The filepermissions for others should be changed
`integer`	`CON_PREDICT_CHANGEUSER`	`6`	# Possible result of cSystemtest::predictCorrectFilePermissions() The owner of the file should be changed Possible result of cSystemtest::predictCorrectFilePermissions() The owner of the file should be changed
`integer`	`CON_PREDICT_CHANGEGROUP`	`7`	# Possible result of cSystemtest::predictCorrectFilePermissions() The group of the file should be changed Possible result of cSystemtest::predictCorrectFilePermissions() The group of the file should be changed
`integer`	`CON_PREDICT_WINDOWS`	`8`	# Possible result of cSystemtest::predictCorrectFilePermissions() The filepermissions are unpredictable because Windows Possible result of cSystemtest::predictCorrectFilePermissions() The filepermissions are unpredictable because Windows
`integer`	`CON_BASEDIR_NORESTRICTION`	`1`	# Possible result of cSystemtest::checkOpenBaseDir(). No restrictions Possible result of cSystemtest::checkOpenBaseDir(). No restrictions
`integer`	`CON_BASEDIR_DOTRESTRICTION`	`2`	# Possible result of cSystemtest::checkOpenBaseDir(). The Basedir is set to ".". CONTENIDO won't work Possible result of cSystemtest::checkOpenBaseDir(). The Basedir is set to ".". CONTENIDO won't work
`integer`	`CON_BASEDIR_RESTRICTIONSUFFICIENT`	`3`	# Possible result of cSystemtest::checkOpenBaseDir(). Open basedir is in effect but CONTENIDO works anyway Possible result of cSystemtest::checkOpenBaseDir(). Open basedir is in effect but CONTENIDO works anyway
`integer`	`CON_BASEDIR_INCOMPATIBLE`	`4`	# Possible result of cSystemtest::checkOpenBaseDir(). Open basedir is in effect and CONTENIDO doesn't work with it Possible result of cSystemtest::checkOpenBaseDir(). Open basedir is in effect and CONTENIDO doesn't work with it
`integer`	`CON_EXTENSION_AVAILABLE`	`1`	# Possible result of cSystemtest::isPHPExtensionLoaded() The extension is loaded Possible result of cSystemtest::isPHPExtensionLoaded() The extension is loaded
`integer`	`CON_EXTENSION_UNAVAILABLE`	`2`	# Possible result of cSystemtest::isPHPExtensionLoaded() The extension is not loaded Possible result of cSystemtest::isPHPExtensionLoaded() The extension is not loaded
`integer`	`CON_EXTENSION_CANTCHECK`	`3`	# Possible result of cSystemtest::isPHPExtensionLoaded() It was unable to check wether the extension is loaded or not Possible result of cSystemtest::isPHPExtensionLoaded() It was unable to check wether the extension is loaded or not
`integer`	`CON_IMAGERESIZE_GD`	`1`	# Possible result of cSystemtest::checkImageResizer() GD is available for image resizing Possible result of cSystemtest::checkImageResizer() GD is available for image resizing
`integer`	`CON_IMAGERESIZE_IMAGEMAGICK`	`2`	# Possible result of cSystemtest::checkImageResizer() ImageMagick is available for image resizing Possible result of cSystemtest::checkImageResizer() ImageMagick is available for image resizing
`integer`	`CON_IMAGERESIZE_CANTCHECK`	`3`	# Possible result of cSystemtest::checkImageResizer() It was unable to check which extension is available for image resizing Possible result of cSystemtest::checkImageResizer() It was unable to check which extension is available for image resizing
`integer`	`CON_IMAGERESIZE_NOTHINGAVAILABLE`	`4`	# Possible result of cSystemtest::checkImageResizer() No fitting extension is available Possible result of cSystemtest::checkImageResizer() No fitting extension is available
`integer`	`CON_MYSQL_OK`	`1`	# Possible result of cSystemtest::testMySQL() Everything works fine with the given settings Possible result of cSystemtest::testMySQL() Everything works fine with the given settings
`integer`	`CON_MYSQL_STRICT_MODE`	`2`	# Possible result of cSystemtest::testMySQL() Strict mode is activated. CONTENIDO won't work Possible result of cSystemtest::testMySQL() Strict mode is activated. CONTENIDO won't work
`integer`	`CON_MYSQL_CANT_CONNECT`	`3`	# Possible result of cSystemtest::testMySQL() Strict mode is activated. CONTENIDO won't work Possible result of cSystemtest::testMySQL() Strict mode is activated. CONTENIDO won't work

Properties summary
`protected array`	`$_messages`		# The test results which are stored for display. Every array element is an assoicative array like this: $_messages[$i] = array( "result" => $result, //true or false, success or no success "severity" => $severity, //one of the C_SEVERITY constants "headline" => $headline, //the headline of the message "message" => $message //the message ); The test results which are stored for display. Every array element is an assoicative array like this: $_messages[$i] = array( "result" => $result, //true or false, success or no success "severity" => $severity, //one of the C_SEVERITY constants "headline" => $headline, //the headline of the message "message" => $message //the message );
`protected array`	`$_config`		# The stored config array The stored config array

Packages

Classes

Functions

Class cSystemtest

Parameters

Parameters

Parameters

Returns

See

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Throws

Returns

Returns

Returns

Parameters