TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate Class Reference

Inheritance diagram for TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate:

Public Member Functions
	__construct ()
string	getIdentifier ()
string	getTitle ()
string	getDescription ()
bool	updateNecessary ()
	setOutput (OutputInterface $output)
string[]	getPrerequisites ()
bool	executeUpdate ()
Confirmation	getConfirmation ()

Protected Member Functions
array	getUnneededCommandLineUsers ()

Protected Attributes
OutputInterface	$output
Confirmation	$confirmation

Detailed Description

Remove all backend users starting with cli

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

Definition at line 27 of file CommandLineBackendUserRemovalUpdate.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate::__construct

(

)

Definition at line 37 of file CommandLineBackendUserRemovalUpdate.php.

References TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate\getUnneededCommandLineUsers().

Member Function Documentation

executeUpdate()

bool TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate::executeUpdate

(

)

Performs the database update to set all be_users starting with CLI* to deleted

Returns

‪bool

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 109 of file CommandLineBackendUserRemovalUpdate.php.

References TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate\getUnneededCommandLineUsers().

getConfirmation()

Confirmation TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate::getConfirmation

(

)

Return a confirmation message instance

Returns

‪Confirmation

Implements TYPO3\CMS\Install\Updates\ConfirmableInterface.

Definition at line 173 of file CommandLineBackendUserRemovalUpdate.php.

References TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate\$confirmation.

getDescription()

string TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate::getDescription

(

)

Returns

‪string Longer description of this updater

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 65 of file CommandLineBackendUserRemovalUpdate.php.

getIdentifier()

string TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate::getIdentifier

(

)

Returns

‪string Unique identifier of this updater

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 49 of file CommandLineBackendUserRemovalUpdate.php.

getPrerequisites()

string [] TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate::getPrerequisites

(

)

Returns

‪string[] All new fields and tables must exist

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 97 of file CommandLineBackendUserRemovalUpdate.php.

getTitle()

string TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate::getTitle

(

)

Returns

‪string Title of this updater

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 57 of file CommandLineBackendUserRemovalUpdate.php.

getUnneededCommandLineUsers()

array TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate::getUnneededCommandLineUsers ( )

protected

Find all backend users starting with CLI that are not deleted yet.

Returns

‪array a list of uids

Definition at line 138 of file CommandLineBackendUserRemovalUpdate.php.

Referenced by TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate\__construct(), TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate\executeUpdate(), and TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate\updateNecessary().

setOutput()

TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate::setOutput

(

OutputInterface

$output

)

Parameters

OutputInterface

$output

Implements TYPO3\CMS\Install\Updates\ChattyInterface.

Definition at line 89 of file CommandLineBackendUserRemovalUpdate.php.

References TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate\$output.

updateNecessary()

bool TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate::updateNecessary

(

)

Checks if an update is needed

Returns

‪bool Whether an update is needed (TRUE) or not (FALSE)

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 76 of file CommandLineBackendUserRemovalUpdate.php.

References TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate\getUnneededCommandLineUsers().

Member Data Documentation

$confirmation

Confirmation TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate::$confirmation

protected

Definition at line 35 of file CommandLineBackendUserRemovalUpdate.php.

Referenced by TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate\getConfirmation().

$output

OutputInterface TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate::$output

protected

Definition at line 31 of file CommandLineBackendUserRemovalUpdate.php.

Referenced by TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate\setOutput().