"TYPO3 4.0.1: tx_coreupdates_compatversion Class Reference", "datetime" => "Sat Dec 2 19:27:04 2006", "date" => "2 Dec 2006", "doxygenversion" => "1.4.6", "projectname" => "TYPO3 4.0.1", "projectnumber" => "4.0.1" ); get_header($doxygen_vars); ?>

tx_coreupdates_compatversion Class Reference

List of all members.

Public Member Functions

 checkForUpdate (&$description)
 getUserInput ($inputPrefix)
 checkUserInput (&$customMessages)
 performUpdate (&$dbQueries, &$customMessages)
 compatVersionIsCurrent ()
 showChangesNeeded ($inputPrefix= '')

Public Attributes

 $versionNumber
 $pObj
 $userInput

Detailed Description

Contains the update class for the compatibility version. Used by the update wizard in the install tool.

Author:
Sebastian Kurfuerst <sebastian@garbage-group.de

Definition at line 32 of file class.tx_coreupdates_compatversion.php.

Member Function Documentation

tx_coreupdates_compatversion::checkForUpdate (  &$  description  ) 
 

Function which checks if update is needed. Called in the beginning of an update process.

Parameters:
string pointer to description for the update
Returns:
boolean true if update is needs to be performed, false otherwise.

Definition at line 43 of file class.tx_coreupdates_compatversion.php.

References compatVersionIsCurrent().

tx_coreupdates_compatversion::checkUserInput (  &$  customMessages  ) 
 

Checks if user input is valid

Parameters:
string pointer to output custom messages
Returns:
boolean true if user input is correct, then the update is performed. When false, return to getUserInput

Definition at line 102 of file class.tx_coreupdates_compatversion.php.

References compatVersionIsCurrent(), and t3lib_div::int_from_ver().

tx_coreupdates_compatversion::compatVersionIsCurrent (   ) 
 

checks if compatibility version is set to current version

Returns:
boolean true if compat version is equal the current version

Definition at line 164 of file class.tx_coreupdates_compatversion.php.

Referenced by checkForUpdate(), checkUserInput(), and getUserInput().

tx_coreupdates_compatversion::getUserInput (  $  inputPrefix  ) 
 

second step: get user input if needed

Parameters:
string input prefix, all names of form fields have to start with this. Append custom name in [ ... ]
Returns:
string HTML output

Definition at line 73 of file class.tx_coreupdates_compatversion.php.

References compatVersionIsCurrent(), and showChangesNeeded().

tx_coreupdates_compatversion::performUpdate (  &$  dbQueries,
&$  customMessages
) 
 

Performs the update itself

Parameters:
array pointer where to insert all DB queries made, so they can be shown to the user if wanted
string pointer to output custom messages
Returns:
boolean true if update succeeded, false otherwise

Definition at line 136 of file class.tx_coreupdates_compatversion.php.

tx_coreupdates_compatversion::showChangesNeeded (  $  inputPrefix = ''  ) 
 

show changes needed

Parameters:
string input prefix to prepend all form fields with.
Returns:
string HTML output

Definition at line 179 of file class.tx_coreupdates_compatversion.php.

References t3lib_div::int_from_ver().

Referenced by getUserInput().

The documentation for this class was generated from the following file: