TYPO3\CMS\Install\Updates\InitialDatabaseSchemaUpdate Class Reference

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

Public Member Functions
	__construct ()
	checkForUpdate (&$description)
	getUserInput ($inputPrefix)
	performUpdate (array &$dbQueries, &$customMessages)
Public Member Functions inherited from TYPO3\CMS\Install\Updates\AbstractDatabaseSchemaUpdate
	__construct ()
Public Member Functions inherited from TYPO3\CMS\Install\Updates\AbstractUpdate
	getTitle ()
	setTitle ($title)
	getIdentifier ()
	setIdentifier ($identifier)
	shouldRenderWizard ()
	shouldRenderNextButton ()
	checkIfTableExists ($table)
	checkForUpdate (&$description)
	performUpdate (array &$dbQueries, &$customMessages)

Additional Inherited Members
Public Attributes inherited from TYPO3\CMS\Install\Updates\AbstractUpdate
	$pObj
	$userInput
	$versionNumber
Protected Member Functions inherited from TYPO3\CMS\Install\Updates\AbstractDatabaseSchemaUpdate
	getDatabaseDifferences ()
Protected Member Functions inherited from TYPO3\CMS\Install\Updates\AbstractUpdate
	markWizardAsDone ($confValue=1)
	isWizardDone ()
	getDatabaseConnection ()
Protected Attributes inherited from TYPO3\CMS\Install\Updates\AbstractDatabaseSchemaUpdate
	$title
	$schemaMigrationService
	$expectedSchemaService
	$objectManager
Protected Attributes inherited from TYPO3\CMS\Install\Updates\AbstractUpdate
	$title
	$identifier

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! Contains the update class to create tables, fields and keys to comply to the database schema

Author

Stephan Großberndt steph.nosp@m.an@g.nosp@m.rossb.nosp@m.ernd.nosp@m.t.de

Definition at line 22 of file InitialDatabaseSchemaUpdate.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Install\Updates\InitialDatabaseSchemaUpdate::__construct

(

)

Constructor function.

Definition at line 27 of file InitialDatabaseSchemaUpdate.php.

Member Function Documentation

checkForUpdate()

TYPO3\CMS\Install\Updates\InitialDatabaseSchemaUpdate::checkForUpdate

(

&

$description

)

Checks if an update is needed

Parameters

string

&$description

The description for the update

Returns

bool TRUE if an update is needed, FALSE otherwise

Definition at line 38 of file InitialDatabaseSchemaUpdate.php.

References TYPO3\CMS\Install\Updates\AbstractDatabaseSchemaUpdate\getDatabaseDifferences().

getUserInput()

TYPO3\CMS\Install\Updates\InitialDatabaseSchemaUpdate::getUserInput

(

$inputPrefix

)

Second step: Show tables, fields and keys to be created

Parameters

string

$inputPrefix

input prefix, all names of form fields have to start with this. Append custom name in [ ... ]

Returns

string HTML output

Definition at line 54 of file InitialDatabaseSchemaUpdate.php.

References $result, $sql, and TYPO3\CMS\Install\Updates\AbstractDatabaseSchemaUpdate\getDatabaseDifferences().

performUpdate()

TYPO3\CMS\Install\Updates\InitialDatabaseSchemaUpdate::performUpdate	(	array &	$dbQueries,
		&	$customMessages
	)

Performs the database update.

Parameters

array	&$dbQueries	Queries done in this update
mixed	&$customMessages	Custom messages

Returns

bool TRUE on success, FALSE on error

Definition at line 141 of file InitialDatabaseSchemaUpdate.php.

References $GLOBALS, and TYPO3\CMS\Install\Updates\AbstractDatabaseSchemaUpdate\getDatabaseDifferences().