TYPO3\CMS\Install\Controller\Action\Step\StepInterface Interface Reference

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

Public Member Functions
	execute ()
	needsExecution ()
	setStepsCounter ($current, $total)
	getCurrentStep ()
	getTotalSteps ()

Detailed Description

Interface implemented by single steps

Definition at line 22 of file StepInterface.php.

Member Function Documentation

execute()

TYPO3\CMS\Install\Controller\Action\Step\StepInterface::execute

(

)

Execute a step

Returns

array<>

getCurrentStep()

TYPO3\CMS\Install\Controller\Action\Step\StepInterface::getCurrentStep

(

)

Gets current position

Returns

int

Implemented in TYPO3\CMS\Install\Controller\Action\Step\AbstractStepAction.

getTotalSteps()

TYPO3\CMS\Install\Controller\Action\Step\StepInterface::getTotalSteps

(

)

Gets total steps

Returns

int

Implemented in TYPO3\CMS\Install\Controller\Action\Step\AbstractStepAction.

needsExecution()

TYPO3\CMS\Install\Controller\Action\Step\StepInterface::needsExecution

(

)

Whether this step must be executed

Returns

bool TRUE if this step needs to be executed

Implemented in TYPO3\CMS\Install\Controller\Action\Step\DatabaseConnect, TYPO3\CMS\Install\Controller\Action\Step\DefaultConfiguration, TYPO3\CMS\Install\Controller\Action\Step\DatabaseSelect, TYPO3\CMS\Install\Controller\Action\Step\DatabaseData, and TYPO3\CMS\Install\Controller\Action\Step\EnvironmentAndFolders.

setStepsCounter()

TYPO3\CMS\Install\Controller\Action\Step\StepInterface::setStepsCounter	(		$current,
			$total
	)

Tell the action which position it has in the list of actions

Parameters

int	$current	The current position
int	$total	The total number of steps

Returns

void

Implemented in TYPO3\CMS\Install\Controller\Action\Step\AbstractStepAction.