SilverStripe\Dev\Install\InstallRequirements
This class checks requirements Each of the requireXXX functions takes an argument which gives a user description of the test.
It's an array of 3 parts:
$description[0] - The test catetgory
$description[1] - The test title
$description[2] - The test error to show, if it goes wrong
Synopsis
class InstallRequirements
{
- // members
- protected array $errors = ;
- protected array $warnings = ;
- protected array $tests = ;
- protected array $originalIni = ;
- // methods
- public void __construct()
- public boolean checkDatabase()
- public void checkAdminConfig()
- public array check()
- protected mixed getOriginalIni()
- public void suggestPHPSetting()
- public void requirePHPSetting()
- public void suggestClass()
- public void suggestFunction()
- public void requireDateTimezone()
- public void requireMemory()
- public void getPHPMemory()
- public void listErrors()
- public void showTable()
- public void requireFunction()
- public void requireClass()
- public bool requireNoClasses()
- public void checkApacheVersion()
- public void requirePHPVersion()
- public void requireModule()
- public void requireFile()
- public void requireWriteable()
- public void requireTempFolder()
- public void requireApacheModule()
- public void requireApacheRewriteModule()
- public void requireIISRewriteModule()
- public void requireDatabaseFunctions()
- public void requireDatabaseConnection()
- public void requireDatabaseVersion()
- public void requireDatabaseServer()
- public void requireDatabaseOrCreatePermissions()
- public void requireDatabaseAlterPermissions()
- public void requireServerVariables()
- public void requirePostSupport()
- public void isRunningWebServer()
- public void testing()
- public void error()
- public void warning()
- public void hasErrors()
- public void hasWarnings()
- // Inherited methods from InstallEnvironmentAware
- protected void initBaseDir()
- protected $this setBaseDir()
- public string getBaseDir()
- public string getPublicDir()
- public bool checkModuleExists()
- protected string getProjectDir()
- protected string getProjectSrcDir()
- public bool isIIS()
- public bool isApache()
- public string|false findWebserver()
- public void testApacheRewriteExists()
- public void testIISRewriteModuleExists()
- public bool hasRewritingCapability()
- public string getDatabaseTypeNice()
- public DatabaseConfigurationHelper getDatabaseConfigurationHelper()
Hierarchy
Members
protected
- $baseDir
—
Base path - $errors
—
array
List of errors - $originalIni
—
array
Backup of original ini settings - $tests
—
array
List of tests - $warnings
—
array
List of warnings
Methods
protected
- getOriginalIni() — Get ini setting
public
- __construct()
- check() — Check everything except the database
- checkAdminConfig()
- checkApacheVersion()
- checkDatabase() — Check the database configuration. These are done one after another starting with checking the database function exists in PHP, and continuing onto more difficult checks like database permissions.
- error()
- getPHPMemory()
- hasErrors()
- hasWarnings()
- isRunningWebServer()
- listErrors()
- requireApacheModule()
- requireApacheRewriteModule()
- requireClass()
- requireDatabaseAlterPermissions()
- requireDatabaseConnection()
- requireDatabaseFunctions()
- requireDatabaseOrCreatePermissions()
- requireDatabaseServer()
- requireDatabaseVersion()
- requireDateTimezone()
- requireFile()
- requireFunction()
- requireIISRewriteModule()
- requireMemory()
- requireModule() — The same as {@link requireFile()} but does additional checks to ensure the module directory is intact.
- requireNoClasses() — Require that the given class doesn't exist
- requirePHPSetting()
- requirePHPVersion()
- requirePostSupport()
- requireServerVariables()
- requireTempFolder()
- requireWriteable()
- showTable()
- suggestClass()
- suggestFunction()
- suggestPHPSetting()
- testing()
- warning()
Inherited from SilverStripe\Dev\Install\InstallEnvironmentAware
protected
- getProjectDir() — Get project dir name.
- getProjectSrcDir() — Get src dir name for project
- initBaseDir() — Init base path, or guess if able
- setBaseDir()
public
- checkModuleExists() — Check that a module exists
- findWebserver() — Find the webserver software running on the PHP host.
- getBaseDir() — Get base path for this installation
- getDatabaseConfigurationHelper() — Get an instance of a helper class for the specific database.
- getDatabaseTypeNice() — Get "nice" database name without "Database" suffix
- getPublicDir() — Get path to public directory
- hasRewritingCapability() — Determines if the web server has any rewriting capability.
- isApache()
- isIIS() — Check if the web server is IIS and version greater than the given version.
- testApacheRewriteExists()
- testIISRewriteModuleExists()