Inheritance diagram for TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect:

Public Member Functions
	needsExecution ()

Public Member Functions inherited from TYPO3\CMS\Install\Controller\Action\Step\AbstractStepAction
	setStepsCounter ($current, $total)

	getCurrentStep ()

	getTotalSteps ()

Public Member Functions inherited from TYPO3\CMS\Install\Controller\Action\AbstractAction
	injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManager $objectManager)

	injectView (\TYPO3\CMS\Install\View\FailsafeView $view)

	handle ()

	setToken ($token)

	setController ($controller)

	setAction ($action)

	setPostValues (array $postValues)

	setLastError (array $lastError)

	setMessages (array $messages=[])

Public Member Functions inherited from TYPO3\CMS\Install\Controller\Action\Step\StepInterface
	execute ()

Protected Member Functions
	executeAction ()

	getConfiguredOrDefaultPort ()

	isHostConfigured ()

	isConfigurationComplete ()

	isConnectionWithUnixDomainSocketPossible ()

	setDbalInputFieldsToRender ()

	getAvailableDbalDrivers ()

	getSupportedDbalDrivers ()

	getSelectedDbalDriver ()

	getConfiguredUsername ()

	getConfiguredPassword ()

	getConfiguredHost ()

	getConfiguredPort ()

	getConfiguredSocket ()

Protected Member Functions inherited from TYPO3\CMS\Install\Controller\Action\Step\AbstractStepAction
	assignSteps ()

Protected Member Functions inherited from TYPO3\CMS\Install\Controller\Action\AbstractAction
	initializeHandle ()

	executeAction ()

	isDbalEnabled ()

	getContext ()

	loadExtLocalconfDatabaseAndExtTables ()

	getHashedPassword ($password)

Additional Inherited Members
Protected Attributes inherited from TYPO3\CMS\Install\Controller\Action\Step\AbstractStepAction
	$currentStep = 0

	$totalSteps = 0

Protected Attributes inherited from TYPO3\CMS\Install\Controller\Action\AbstractAction
	$objectManager = null

	$view = null

	$controller = ''

	$action = ''

	$token = ''

	$postValues = []

	$lastError = []

	$messages = []

Detailed Description

Database connect step:

Needs execution if database credentials are not set or fail to connect
Renders fields for database connection fields
Sets database credentials in LocalConfiguration
Loads / unloads ext:dbal and ext:adodb if requested

Definition at line 26 of file DatabaseConnect.php.

Member Function Documentation

◆ executeAction()

TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect::executeAction ( )

protected

Executes the step

Returns: string Rendered content

Definition at line 218 of file DatabaseConnect.php.

◆ getAvailableDbalDrivers()

TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect::getAvailableDbalDrivers ( )

protected

Returns a list of database drivers that are available on current server.

Returns: array

Definition at line 478 of file DatabaseConnect.php.

References $driver, TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getSelectedDbalDriver(), and TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getSupportedDbalDrivers().

Referenced by TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\executeAction().

◆ getConfiguredHost()

TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect::getConfiguredHost ( )

protected

Returns configured host with port split off if given

Returns: string

Definition at line 627 of file DatabaseConnect.php.

References $GLOBALS, and $host.

Referenced by TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\executeAction(), TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getConfiguredOrDefaultPort(), and TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\isConfigurationComplete().

◆ getConfiguredOrDefaultPort()

TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect::getConfiguredOrDefaultPort ( )

protected

Render connect port and label

Returns: int Configured or default port

Definition at line 252 of file DatabaseConnect.php.

References $driver, $GLOBALS, TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getConfiguredHost(), TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getConfiguredPassword(), TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getConfiguredPort(), TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getConfiguredSocket(), TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getConfiguredUsername(), TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getSelectedDbalDriver(), and TYPO3\CMS\Install\Controller\Action\AbstractAction\isDbalEnabled().

Referenced by TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\executeAction(), and TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\isConfigurationComplete().

◆ getConfiguredPassword()

TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect::getConfiguredPassword ( )

protected

Returns configured password, if set

Returns: string

Definition at line 616 of file DatabaseConnect.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\executeAction(), and TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getConfiguredOrDefaultPort().

◆ getConfiguredPort()

TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect::getConfiguredPort ( )

protected

Returns configured port. Gets port from host value if port is not yet set.

Returns: int

Definition at line 642 of file DatabaseConnect.php.

References $GLOBALS, and $host.

Referenced by TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getConfiguredOrDefaultPort(), and TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\isConfigurationComplete().

◆ getConfiguredSocket()

TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect::getConfiguredSocket ( )

protected

Returns configured socket, if set

Returns: string|NULL

Definition at line 658 of file DatabaseConnect.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getConfiguredOrDefaultPort(), TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\isConfigurationComplete(), and TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\isConnectionWithUnixDomainSocketPossible().

◆ getConfiguredUsername()

TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect::getConfiguredUsername ( )

protected

Returns configured username, if set

Returns: string

Definition at line 605 of file DatabaseConnect.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\executeAction(), and TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getConfiguredOrDefaultPort().

◆ getSelectedDbalDriver()

TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect::getSelectedDbalDriver ( )

protected

Get selected dbal driver if any

Returns: string Dbal driver or empty string if not yet selected

Definition at line 553 of file DatabaseConnect.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\loadExtension(), and TYPO3\CMS\Core\Utility\ExtensionManagementUtility\unloadExtension().

Referenced by TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\executeAction(), TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getAvailableDbalDrivers(), TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getConfiguredOrDefaultPort(), and TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\setDbalInputFieldsToRender().

◆ getSupportedDbalDrivers()

TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect::getSupportedDbalDrivers ( )

protected

Returns a list of DBAL supported database drivers, with a user-friendly name and any PHP module dependency.

Returns: array

Definition at line 521 of file DatabaseConnect.php.

Referenced by TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getAvailableDbalDrivers().

◆ isConfigurationComplete()

TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect::isConfigurationComplete ( )

protected

Check LocalConfiguration.php for required database settings:

'host' is mandatory and must not be empty
'port' OR 'socket' is mandatory, but may be empty
'username' and 'password' are mandatory, but may be empty

Returns: bool TRUE if required settings are present

Definition at line 340 of file DatabaseConnect.php.

References $GLOBALS, TYPO3\CMS\Core\Utility\GeneralUtility\cmpIP(), TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getConfiguredHost(), TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getConfiguredOrDefaultPort(), TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getConfiguredPort(), TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getConfiguredSocket(), TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\isConnectionWithUnixDomainSocketPossible(), TYPO3\CMS\Core\Utility\GeneralUtility\isFirstPartOfStr(), and TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\isHostConfigured().

Referenced by TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\needsExecution().

◆ isConnectionWithUnixDomainSocketPossible()

TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect::isConnectionWithUnixDomainSocketPossible ( )

protected

Test if a unix domain socket can be opened. This does not authenticate but only tests if a connect is successful.

Returns: bool TRUE on success

Definition at line 412 of file DatabaseConnect.php.

References TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getConfiguredSocket().

Referenced by TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\isConfigurationComplete().

◆ isHostConfigured()

TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect::isHostConfigured ( )

protected

Check LocalConfiguration.php for required database settings:

'host' is mandatory and must not be empty
'port' OR 'socket' is mandatory, but may be empty

Returns: bool TRUE if host is set

Definition at line 317 of file DatabaseConnect.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\isConfigurationComplete(), and TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\needsExecution().

◆ needsExecution()

TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect::needsExecution ( )

Step needs to be executed if database connection is not successful.

Exceptions

Implements TYPO3\CMS\Install\Controller\Action\Step\StepInterface.

Definition at line 198 of file DatabaseConnect.php.

References TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\isConfigurationComplete(), TYPO3\CMS\Install\Controller\Action\AbstractAction\isDbalEnabled(), and TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\isHostConfigured().

◆ setDbalInputFieldsToRender()

TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect::setDbalInputFieldsToRender ( )

protected

Render fields required for successful connect based on dbal driver selection. Hint: There is a code duplication in handle() and this method. This is done by intention to keep this code area easy to maintain and understand.

Returns: void

Definition at line 441 of file DatabaseConnect.php.

References $driver, $GLOBALS, and TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\getSelectedDbalDriver().

Referenced by TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect\executeAction().

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ executeAction()

◆ getAvailableDbalDrivers()

◆ getConfiguredHost()

◆ getConfiguredOrDefaultPort()

◆ getConfiguredPassword()

◆ getConfiguredPort()

◆ getConfiguredSocket()

◆ getConfiguredUsername()

◆ getSelectedDbalDriver()

◆ getSupportedDbalDrivers()

◆ isConfigurationComplete()

◆ isConnectionWithUnixDomainSocketPossible()

◆ isHostConfigured()

◆ needsExecution()

◆ setDbalInputFieldsToRender()