TYPO3\CMS\Install\Report\InstallStatusReport Class Reference

Inheritance diagram for TYPO3\CMS\Install\Report\InstallStatusReport:

Public Member Functions
	__construct (bool $useMarkup=true)
Status[]	getStatus ()

Protected Member Functions
Status	getFileSystemStatus ()
array	getIncompleteWizards ()
Status	getRemainingUpdatesStatus ()
Status	getNewVersionStatus ()
	wrapList (array $items, int $style)
	wrapItems (array $items, string $before, string $after)
LanguageService	getLanguageService ()

Protected Attributes
const	WRAP_FLAT = 1
const	WRAP_NESTED = 2
	$useMarkup

Detailed Description

Provides an installation status report.

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

Definition at line 33 of file InstallStatusReport.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Install\Report\InstallStatusReport::__construct

(

bool

$useMarkup = true

)

Definition at line 40 of file InstallStatusReport.php.

References TYPO3\CMS\Install\Report\InstallStatusReport\$useMarkup.

Member Function Documentation

getFileSystemStatus()

Status TYPO3\CMS\Install\Report\InstallStatusReport::getFileSystemStatus ( )

protected

Checks for several directories being writable.

Returns

‪Status Indicates status of the file system

Definition at line 64 of file InstallStatusReport.php.

References $GLOBALS, TYPO3\CMS\Reports\Status\ERROR, TYPO3\CMS\Core\Core\Environment\getBackendPath(), TYPO3\CMS\Core\Core\Environment\getExtensionsPath(), TYPO3\CMS\Core\Core\Environment\getLabelsPath(), TYPO3\CMS\Install\Report\InstallStatusReport\getLanguageService(), TYPO3\CMS\Core\Core\Environment\getProjectPath(), TYPO3\CMS\Core\Core\Environment\getPublicPath(), TYPO3\CMS\Core\Core\Environment\getVarPath(), TYPO3\CMS\Core\Core\Environment\isComposerMode(), TYPO3\CMS\Core\Utility\GeneralUtility\mkdir(), TYPO3\CMS\Reports\Status\OK, and TYPO3\CMS\Reports\Status\WARNING.

Referenced by TYPO3\CMS\Install\Report\InstallStatusReport\getStatus().

getIncompleteWizards()

array TYPO3\CMS\Install\Report\InstallStatusReport::getIncompleteWizards ( )

protected

Returns all incomplete update wizards.

Fetches all wizards that are not marked "done" in the registry and filters out the ones that should not be rendered (= no upgrade required).

Returns

‪array

Definition at line 167 of file InstallStatusReport.php.

Referenced by TYPO3\CMS\Install\Report\InstallStatusReport\getRemainingUpdatesStatus().

getLanguageService()

LanguageService TYPO3\CMS\Install\Report\InstallStatusReport::getLanguageService ( )

protected

Returns

‪LanguageService

Definition at line 342 of file InstallStatusReport.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Install\Report\InstallStatusReport\getFileSystemStatus(), TYPO3\CMS\Install\Report\InstallStatusReport\getNewVersionStatus(), and TYPO3\CMS\Install\Report\InstallStatusReport\getRemainingUpdatesStatus().

getNewVersionStatus()

Status TYPO3\CMS\Install\Report\InstallStatusReport::getNewVersionStatus ( )

protected

Checks if there is a new minor TYPO3 version to update to.

Returns

‪Status Represents whether there is a new version available online

Definition at line 211 of file InstallStatusReport.php.

References TYPO3\CMS\Reports\Status\ERROR, TYPO3\CMS\Install\Report\InstallStatusReport\getLanguageService(), TYPO3\CMS\Reports\Status\NOTICE, TYPO3\CMS\Reports\Status\OK, TYPO3\CMS\Reports\Status\WARNING, and TYPO3\CMS\Install\Report\InstallStatusReport\wrapList().

Referenced by TYPO3\CMS\Install\Report\InstallStatusReport\getStatus().

getRemainingUpdatesStatus()

Status TYPO3\CMS\Install\Report\InstallStatusReport::getRemainingUpdatesStatus ( )

protected

Checks if there are still updates to perform

Returns

‪Status Represents whether the installation is completely updated yet

Definition at line 185 of file InstallStatusReport.php.

References TYPO3\CMS\Install\Report\InstallStatusReport\getIncompleteWizards(), TYPO3\CMS\Install\Report\InstallStatusReport\getLanguageService(), TYPO3\CMS\Reports\Status\OK, and TYPO3\CMS\Reports\Status\WARNING.

Referenced by TYPO3\CMS\Install\Report\InstallStatusReport\getStatus().

getStatus()

Status [] TYPO3\CMS\Install\Report\InstallStatusReport::getStatus

(

)

Compiles a collection of system status checks as a status report.

Returns

‪Status[]

Implements TYPO3\CMS\Reports\StatusProviderInterface.

Definition at line 50 of file InstallStatusReport.php.

References TYPO3\CMS\Install\Report\InstallStatusReport\getFileSystemStatus(), TYPO3\CMS\Install\Report\InstallStatusReport\getNewVersionStatus(), and TYPO3\CMS\Install\Report\InstallStatusReport\getRemainingUpdatesStatus().

wrapItems()

TYPO3\CMS\Install\Report\InstallStatusReport::wrapItems ( array  $items, string  $before, string  $after  )

protected

Definition at line 329 of file InstallStatusReport.php.

Referenced by TYPO3\CMS\Install\Report\InstallStatusReport\wrapList().

wrapList()

TYPO3\CMS\Install\Report\InstallStatusReport::wrapList ( array  $items, int  $style  )

protected

Definition at line 312 of file InstallStatusReport.php.

References TYPO3\CMS\Install\Report\InstallStatusReport\wrapItems().

Referenced by TYPO3\CMS\Install\Report\InstallStatusReport\getNewVersionStatus().

Member Data Documentation

$useMarkup

TYPO3\CMS\Install\Report\InstallStatusReport::$useMarkup

protected

Definition at line 38 of file InstallStatusReport.php.

Referenced by TYPO3\CMS\Install\Report\InstallStatusReport\__construct().

WRAP_FLAT

const TYPO3\CMS\Install\Report\InstallStatusReport::WRAP_FLAT = 1

protected

Definition at line 35 of file InstallStatusReport.php.

WRAP_NESTED

const TYPO3\CMS\Install\Report\InstallStatusReport::WRAP_NESTED = 2

protected

Definition at line 36 of file InstallStatusReport.php.