Public Member Functions
	__construct (private readonly LateBootService $lateBootService, private readonly ConfigurationManager $configurationManager, private readonly PermissionsCheck $databasePermissionsCheck, private readonly Registry $registry, private readonly SchemaMigrator $schemaMigrator,)

array	setDefaultConnectionSettings (array $values)

array	getDatabaseConfigurationFromEnvironment ()

	isValidDbHost (string $name)

	isValidDbPort (int $number)

	isValidDbName (string $name)

	getBackendUserPasswordValidationErrors (string $password)

array	getDatabaseList ()

	checkDatabaseSelect ()

	createDatabase (string $name)

	isDatabaseConnectSuccessful ()

bool	isDatabaseConfigurationComplete ()

	getDatabaseConfiguredMysqliSocket ()

	getDatabaseConfiguredPdoMysqlSocket ()

	createNewDatabase (string $dbName)

	checkExistingDatabase (string $dbName)

FlashMessage[]	importDatabaseData ()

	checkRequiredDatabasePermissions ()

	checkDatabaseRequirementsForDriver (string $databaseDriverName)

	getDriverOptions ()

	markWizardsDone (ContainerInterface $container)

Protected Attributes
array	$validDrivers

Private Member Functions
	getDefaultSocketFor (string $phpIniSetting)

Detailed Description

Service class helping to manage database related settings and operations required to set up TYPO3

This class is only meant to be used within EXT:install and is not part of the TYPO3 Core API.

@phpstan-import-type Params from DriverManager

Definition at line 51 of file SetupDatabaseService.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Install\Service\SetupDatabaseService::__construct	(	private readonly LateBootService	$lateBootService,
		private readonly ConfigurationManager	$configurationManager,
		private readonly PermissionsCheck	$databasePermissionsCheck,
		private readonly Registry	$registry,
		private readonly SchemaMigrator	$schemaMigrator
	)

Definition at line 60 of file SetupDatabaseService.php.

Member Function Documentation

◆ checkDatabaseRequirementsForDriver()

TYPO3\CMS\Install\Service\SetupDatabaseService::checkDatabaseRequirementsForDriver ( string $databaseDriverName )

Definition at line 563 of file SetupDatabaseService.php.

References TYPO3\CMS\Install\SystemEnvironment\DatabaseCheck\retrieveDatabaseDriverClassByDriverName().

◆ checkDatabaseSelect()

TYPO3\CMS\Install\Service\SetupDatabaseService::checkDatabaseSelect ( )

Definition at line 324 of file SetupDatabaseService.php.

References $GLOBALS, and TYPO3\CMS\Core\Database\ConnectionPool\DEFAULT_CONNECTION_NAME.

◆ checkExistingDatabase()

TYPO3\CMS\Install\Service\SetupDatabaseService::checkExistingDatabase ( string $dbName )

Checks whether an existing database on the default connection can be used for a TYPO3 installation. The database name is only persisted to the local configuration if the database is empty.

Parameters

string $dbName ‪name of the database

Definition at line 471 of file SetupDatabaseService.php.

References $GLOBALS, and TYPO3\CMS\Core\Database\ConnectionPool\DEFAULT_CONNECTION_NAME.

◆ checkRequiredDatabasePermissions()

TYPO3\CMS\Install\Service\SetupDatabaseService::checkRequiredDatabasePermissions ( )

Definition at line 545 of file SetupDatabaseService.php.

◆ createDatabase()

TYPO3\CMS\Install\Service\SetupDatabaseService::createDatabase ( string $name )

Parameters

string $name

Exceptions

DBALException

Definition at line 348 of file SetupDatabaseService.php.

References TYPO3\CMS\Core\Database\ConnectionPool\DEFAULT_CONNECTION_NAME, and TYPO3\CMS\Core\Database\Platform\PlatformInformation\getDatabaseCreateStatementWithCharset().

Referenced by TYPO3\CMS\Install\Service\SetupDatabaseService\createNewDatabase().

◆ createNewDatabase()

TYPO3\CMS\Install\Service\SetupDatabaseService::createNewDatabase ( string $dbName )

Creates a new database on the default connection

Parameters

string $dbName ‪name of database

Definition at line 444 of file SetupDatabaseService.php.

References TYPO3\CMS\Install\Service\SetupDatabaseService\createDatabase().

◆ getBackendUserPasswordValidationErrors()

TYPO3\CMS\Install\Service\SetupDatabaseService::getBackendUserPasswordValidationErrors ( string $password )

Definition at line 255 of file SetupDatabaseService.php.

References $GLOBALS, and TYPO3\CMS\Core\PasswordPolicy\NEW_USER_PASSWORD.

◆ getDatabaseConfigurationFromEnvironment()

array TYPO3\CMS\Install\Service\SetupDatabaseService::getDatabaseConfigurationFromEnvironment ( )

Try to fetch db credentials from a .env file and see if connect works

Returns: ‪array Empty array if no file is found or connect is not successful, else working credentials

Definition at line 213 of file SetupDatabaseService.php.

Referenced by TYPO3\CMS\Install\Service\SetupDatabaseService\getDriverOptions(), and TYPO3\CMS\Install\Service\SetupDatabaseService\setDefaultConnectionSettings().

◆ getDatabaseConfiguredMysqliSocket()

TYPO3\CMS\Install\Service\SetupDatabaseService::getDatabaseConfiguredMysqliSocket ( )

Returns configured socket, if set.

Definition at line 410 of file SetupDatabaseService.php.

References TYPO3\CMS\Install\Service\SetupDatabaseService\getDefaultSocketFor().

Referenced by TYPO3\CMS\Install\Service\SetupDatabaseService\getDriverOptions().

◆ getDatabaseConfiguredPdoMysqlSocket()

TYPO3\CMS\Install\Service\SetupDatabaseService::getDatabaseConfiguredPdoMysqlSocket ( )

Returns configured socket, if set.

Definition at line 418 of file SetupDatabaseService.php.

References TYPO3\CMS\Install\Service\SetupDatabaseService\getDefaultSocketFor().

Referenced by TYPO3\CMS\Install\Service\SetupDatabaseService\getDriverOptions().

◆ getDatabaseList()

array TYPO3\CMS\Install\Service\SetupDatabaseService::getDatabaseList ( )

Returns list of available databases (with access-check based on username/password)

Returns: ‪array List of available databases

Exceptions

DBALException

Definition at line 275 of file SetupDatabaseService.php.

References $GLOBALS, and TYPO3\CMS\Core\Database\ConnectionPool\DEFAULT_CONNECTION_NAME.

◆ getDefaultSocketFor()

TYPO3\CMS\Install\Service\SetupDatabaseService::getDefaultSocketFor ( string $phpIniSetting )

private

Returns configured socket, if set.

Definition at line 426 of file SetupDatabaseService.php.

References $GLOBALS, and TYPO3\CMS\Core\Database\ConnectionPool\DEFAULT_CONNECTION_NAME.

Referenced by TYPO3\CMS\Install\Service\SetupDatabaseService\getDatabaseConfiguredMysqliSocket(), and TYPO3\CMS\Install\Service\SetupDatabaseService\getDatabaseConfiguredPdoMysqlSocket().

◆ getDriverOptions()

TYPO3\CMS\Install\Service\SetupDatabaseService::getDriverOptions ( )

Definition at line 586 of file SetupDatabaseService.php.

References $GLOBALS, TYPO3\CMS\Core\Database\ConnectionPool\DEFAULT_CONNECTION_NAME, TYPO3\CMS\Install\Service\SetupDatabaseService\getDatabaseConfigurationFromEnvironment(), TYPO3\CMS\Install\Service\SetupDatabaseService\getDatabaseConfiguredMysqliSocket(), TYPO3\CMS\Install\Service\SetupDatabaseService\getDatabaseConfiguredPdoMysqlSocket(), TYPO3\CMS\Install\SystemEnvironment\DatabaseCheck\isMysqli(), TYPO3\CMS\Install\SystemEnvironment\DatabaseCheck\isPdoMysql(), TYPO3\CMS\Install\SystemEnvironment\DatabaseCheck\isPdoPgsql(), and TYPO3\CMS\Install\SystemEnvironment\DatabaseCheck\isPdoSqlite().

◆ importDatabaseData()

FlashMessage [] TYPO3\CMS\Install\Service\SetupDatabaseService::importDatabaseData ( )

Create tables and import static rows

Returns: ‪FlashMessage[]

Definition at line 512 of file SetupDatabaseService.php.

◆ isDatabaseConfigurationComplete()

bool TYPO3\CMS\Install\Service\SetupDatabaseService::isDatabaseConfigurationComplete ( )

Check system/settings.php for required database settings:

‪'username' and 'password' are mandatory, but may be empty
‪if 'driver' is pdo_sqlite and 'path' is set, its ok, too

Returns: ‪bool TRUE if required settings are present

Definition at line 389 of file SetupDatabaseService.php.

References $GLOBALS, and TYPO3\CMS\Core\Database\ConnectionPool\DEFAULT_CONNECTION_NAME.

◆ isDatabaseConnectSuccessful()

TYPO3\CMS\Install\Service\SetupDatabaseService::isDatabaseConnectSuccessful ( )

Test connection with given credentials and return exception message if exception thrown

Definition at line 368 of file SetupDatabaseService.php.

References TYPO3\CMS\Core\Database\ConnectionPool\DEFAULT_CONNECTION_NAME.

◆ isValidDbHost()

TYPO3\CMS\Install\Service\SetupDatabaseService::isValidDbHost ( string $name )

Definition at line 240 of file SetupDatabaseService.php.

Referenced by TYPO3\CMS\Install\Service\SetupDatabaseService\setDefaultConnectionSettings().

◆ isValidDbName()

TYPO3\CMS\Install\Service\SetupDatabaseService::isValidDbName ( string $name )

Definition at line 250 of file SetupDatabaseService.php.

Referenced by TYPO3\CMS\Install\Service\SetupDatabaseService\setDefaultConnectionSettings().

◆ isValidDbPort()

TYPO3\CMS\Install\Service\SetupDatabaseService::isValidDbPort ( int $number )

Definition at line 245 of file SetupDatabaseService.php.

Referenced by TYPO3\CMS\Install\Service\SetupDatabaseService\setDefaultConnectionSettings().

◆ markWizardsDone()

TYPO3\CMS\Install\Service\SetupDatabaseService::markWizardsDone ( ContainerInterface $container )

Definition at line 699 of file SetupDatabaseService.php.

◆ setDefaultConnectionSettings()

array TYPO3\CMS\Install\Service\SetupDatabaseService::setDefaultConnectionSettings ( array $values )

Parameters

array $values

Returns: ‪array

Definition at line 72 of file SetupDatabaseService.php.

References TYPO3\CMS\Core\Core\Environment\getConfigPath(), TYPO3\CMS\Install\Service\SetupDatabaseService\getDatabaseConfigurationFromEnvironment(), TYPO3\CMS\Core\Core\Environment\getProjectPath(), TYPO3\CMS\Core\Core\Environment\getPublicPath(), TYPO3\CMS\Core\Core\Environment\getVarPath(), TYPO3\CMS\Install\Service\SetupDatabaseService\isValidDbHost(), TYPO3\CMS\Install\Service\SetupDatabaseService\isValidDbName(), TYPO3\CMS\Install\Service\SetupDatabaseService\isValidDbPort(), and TYPO3\CMS\Core\Utility\GeneralUtility\mkdir_deep().

Member Data Documentation

◆ $validDrivers

array TYPO3\CMS\Install\Service\SetupDatabaseService::$validDrivers

protected

Initial value:

= [
        'mysqli',
        'pdo_mysql',
        'pdo_pgsql',
        'pdo_sqlite',
    ]

Definition at line 53 of file SetupDatabaseService.php.

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkDatabaseRequirementsForDriver()

◆ checkDatabaseSelect()

◆ checkExistingDatabase()

◆ checkRequiredDatabasePermissions()

◆ createDatabase()

◆ createNewDatabase()

◆ getBackendUserPasswordValidationErrors()

◆ getDatabaseConfigurationFromEnvironment()

◆ getDatabaseConfiguredMysqliSocket()

◆ getDatabaseConfiguredPdoMysqlSocket()

◆ getDatabaseList()

◆ getDefaultSocketFor()

◆ getDriverOptions()

◆ importDatabaseData()

◆ isDatabaseConfigurationComplete()

◆ isDatabaseConnectSuccessful()

◆ isValidDbHost()

◆ isValidDbName()

◆ isValidDbPort()

◆ markWizardsDone()

◆ setDefaultConnectionSettings()

Member Data Documentation

◆ $validDrivers