TYPO3 API  SVNRelease
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
tx_install Class Reference
Inheritance diagram for tx_install:
Inheritance graph
[legend]
Collaboration diagram for tx_install:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 tx_install ()
 checkPassword ()
 loginForm ()
 init ()
 stepOutput ()
 checkTheConfig ()
 typo3conf_edit ()
 phpinformation ()
 cleanupManager ()
 generateConfigForm ($type='')
 getDefaultConfigArrayComments ($string, $mainArray=array(), $commentArray=array())
 checkConfiguration ()
 checkExtensions ()
 checkDirs ()
 checkImageMagick ($paths)
 _checkImageMagickGifCapability ($path)
 _checkImageMagick_getVersion ($file, $path)
 checkDatabase ()
 setupGeneral ($cmd='')
 writeToLocalconf_control ($lines='', $showOutput=TRUE)
 outputExitBasedOnStep ($content)
 setLabelValueArray ($arr, $type)
 getDatabaseList ()
 setupGeneralCalculate ()
 isTTF ()
 isGD ()
 isGIF ()
 isJPG ()
 isPNG ()
 ImageTypes ()
 getGDSoftwareInfo ()
 generallyAboutConfiguration ()
 checkTheImageProcessing ()
 isExtensionEnabled ($ext, $headCode, $short)
 displayTwinImage ($imageFile, $IMcommands=array(), $note='')
 formatImCmds ($arr)
 imagemenu ()
 checkTheDatabase ()
 updateWizard ()
 updateWizard_parts ($action)
 getUpgradeObjInstance ($className, $identifier)
 isBackendAdminUser ()
 isBasicComplete ($tLabel)
 generateUpdateDatabaseForm ($type, $arr_update, $arr_remove, $action_type)
 getUpdateDbFormWrap ($action_type, $content, $label='Write to database')
 displayFields ($arr, $pre=0, $label='')
 displayFieldComp ($arr, $arr_db)
 displaySuggestions ($arr, $excludeList='')
 compareDatabaseAndTCA ($FDsrc, $TCA, $onlyFields=0)
 compareTCAandDatabase ($TCA, $FDcomp)
 suggestFieldDefinition ($fieldInfo)
 getItemArrayType ($arr)
 getItemBlobSize ($len)
 suggestTCAFieldDefinition ($fieldName, $fieldInfo)
 includeTCA ()
 message ($head, $short_string='', $long_string='', $type=0, $force=0)
 printSection ($head, $short_string, $long_string, $type)
 printAll ()
 outputWrapper ($content)
 output ($content)
 menu ()
 stepHeader ()
 securityRisk ()
 alterPasswordForm ()
 copyright ()
 messageBasicFinished ()
 setScriptName ($type)
 getBackupFilename ($filename)
 generateUpdateDatabaseForm_checkboxes ($arr, $label, $checked=1, $iconDis=0, $currentValue=array(), $cVfullMsg=0)
 viewArray ($incomingValue)
 createEncryptionKey ($keyLength=96)
 addErrorMessage ($messageText)

Public Attributes

 $templateFilePath = 'typo3/sysext/install/Resources/Private/Templates/'
 $template
 $javascript
 $stylesheets
 $markers = array()
 $messages = array()
 $errorMessages = array()
 $mailMessage = ''
 $action = ''
 $scriptSelf = 'index.php'
 $updateIdentity = 'TYPO3 Install Tool'
 $headerStyle = ''
 $setAllCheckBoxesByDefault = 0
 $allowFileEditOutsite_typo3conf_dir = 0
 $INSTALL = array()
 $checkIMlzw = 0
 $checkIM = 0
 $dumpImCommands = 1
 $mode = ''
 $step = 0
 $totalSteps = 4
 $passwordOK = 0
 $silent = 1
 $sections = array()
 $fatalError = 0
 $sendNoCacheHeaders = 1
 $config_array
 $typo3temp_path = ''
 $menuitems

Protected Member Functions

 getMissingPhpModules ()
 getNextUpdadeWizardInstance ($currentObj)
 outputErrorAndExit ($content, $title= 'Install Tool error')

Protected Attributes

 $session = NULL
 $formProtection = NULL
 $requiredPhpModules

Detailed Description

Definition at line 173 of file class.tx_install.php.


Member Function Documentation

tx_install::_checkImageMagick_getVersion ( file,
path 
)

Extracts the version number for ImageMagick

Parameters:
string$fileThe program name to execute in order to find out the version number
string$pathPath for the above program
Returns:
string Version number of the found ImageMagick instance

Definition at line 3119 of file class.tx_install.php.

References $GLOBALS, t3lib_utility_Command\exec(), and t3lib_div\imageMagickCommand().

Referenced by checkImageMagick().

tx_install::_checkImageMagickGifCapability ( path)

Checking GIF-compression capabilities of ImageMagick install

Parameters:
string$pathPath of ImageMagick installation
Returns:
string Type of compression

Definition at line 3074 of file class.tx_install.php.

References t3lib_utility_Command\exec(), and t3lib_div\imageMagickCommand().

tx_install::addErrorMessage ( messageText)

Adds an error message that should be displayed.

Parameters:
string$messageTextthe text of the message to display, must not be empty

Definition at line 8453 of file class.tx_install.php.

tx_install::alterPasswordForm ( )

Generates the form to alter the password of the Install Tool

Returns:
string HTML of the form

Definition at line 8053 of file class.tx_install.php.

References $content, $markers, $template, t3lib_parsehtml\getSubpart(), and t3lib_parsehtml\substituteMarkerArray().

Referenced by init(), and isBasicComplete().

tx_install::checkConfiguration ( )

Checking php.ini configuration and set appropriate messages and flags.

Returns:
void

Definition at line 2244 of file class.tx_install.php.

References t3lib_div\getBytesFromSizeMeasurement(), t3lib_utility_PhpOptions\isSafeModeEnabled(), t3lib_utility_PhpOptions\isSqlSafeModeEnabled(), message(), t3lib_div\testInt(), t3lib_div\trimExplode(), and t3lib_div\validIP().

Referenced by checkTheConfig().

tx_install::checkDatabase ( )

Checks database username/password/host/database

Returns:
void

Definition at line 3157 of file class.tx_install.php.

References $GLOBALS, t3lib_extMgm\isLoaded(), and message().

Referenced by checkTheConfig(), and init().

tx_install::checkDirs ( )

Checking and testing that the required writable directories are writable.

Returns:
void

Definition at line 2842 of file class.tx_install.php.

References $GLOBALS, message(), and t3lib_div\mkdir().

Referenced by checkTheConfig().

tx_install::checkExtensions ( )

Checking php extensions, specifically GDLib and Freetype

Returns:
void

Definition at line 2720 of file class.tx_install.php.

References getGDSoftwareInfo(), t3lib_div\getIndpEnv(), isGD(), isGIF(), isJPG(), isPNG(), isTTF(), and message().

Referenced by checkTheConfig().

tx_install::checkImageMagick ( paths)

Checking for existing ImageMagick installs.

This tries to find available ImageMagick installations and tries to find the version numbers by executing "convert" without parameters. If the ->checkIMlzw is set, LZW capabilities of the IM installs are check also.

Parameters:
array$pathsPossible ImageMagick paths
Returns:
void

Definition at line 2955 of file class.tx_install.php.

References _checkImageMagick_getVersion(), t3lib_parsehtml\getSubpart(), message(), t3lib_parsehtml\substituteMarkerArray(), and t3lib_parsehtml\substituteSubpart().

Referenced by checkTheConfig().

tx_install::checkPassword ( )

Returns true if submitted password is ok.

If password is ok, set session as "authorized".

Returns:
boolean true if the submitted password was ok and session was authorized, false otherwise

Definition at line 409 of file class.tx_install.php.

References $GLOBALS, t3lib_div\_GP(), and t3lib_div\getIndpEnv().

Referenced by tx_install().

tx_install::checkTheConfig ( )

Calling the functions that checks the system

Returns:
void

Definition at line 1295 of file class.tx_install.php.

References $GLOBALS, checkConfiguration(), checkDatabase(), checkDirs(), checkExtensions(), checkImageMagick(), and t3lib_utility_PhpOptions\isSafeModeEnabled().

Referenced by init(), and stepOutput().

tx_install::checkTheDatabase ( )
tx_install::checkTheImageProcessing ( )

jesus.TIF: IBM/LZW jesus.GIF: Save for web, 32 colors jesus.JPG: Save for web, 30 quality jesus.PNG: Save for web, PNG-24 jesus.tga 24 bit TGA file jesus.pcx jesus.bmp 24 bit BMP file jesus_ps6.PDF: PDF w/layers and vector data typo3logo.ai: Illustrator 8 file pdf_from_imagemagick.PDF PDF-file made by Acrobat Distiller from InDesign PS-file

Imagemagick

  • Read formats
  • Write png, gif, jpg

Problems may arise from the use of safe_mode (eg. png) In safemode you will automatically execute the program convert in the safe_mode_exec_path no matter what other path you specify check fileexist before anything...

  • compare gif size
  • scaling (by stdgraphic)
  • combining (by stdgraphic)

GDlib:

  • create from:....
  • ttf text

From TypoScript: (GD only, GD+IM, IM)

Returns:
void

Definition at line 4360 of file class.tx_install.php.

References $GLOBALS, displayTwinImage(), t3lib_extMgm\extPath(), t3lib_div\formatSize(), getGDSoftwareInfo(), t3lib_div\gif_compress(), imagemenu(), isExtensionEnabled(), t3lib_div\makeInstance(), message(), t3lib_div\milliseconds(), output(), outputWrapper(), and printAll().

Referenced by init().

tx_install::cleanupManager ( )

Provides a tool cleaning up various tables in the database

Returns:
void
Author:
Robert Lemke <rl@robertlemke.de>
Todo:
Add more functionality ...

Definition at line 1663 of file class.tx_install.php.

References $action, $content, $GLOBALS, $markers, $template, t3lib_div\getFilesInDir(), t3lib_install\getListOfTables(), t3lib_parsehtml\getSubpart(), message(), output(), outputWrapper(), printAll(), t3lib_parsehtml\substituteMarkerArray(), t3lib_parsehtml\substituteSubpart(), and t3lib_div\testInt().

Referenced by init().

tx_install::compareDatabaseAndTCA ( FDsrc,
TCA,
onlyFields = 0 
)

Compares an array with field definitions with $TCA array

Parameters:
array$FDsrcField definition source
array$TCAThe TCA array
boolean$onlyFields
Returns:
array

Definition at line 7171 of file class.tx_install.php.

References $TCA, and suggestTCAFieldDefinition().

Referenced by checkTheDatabase().

tx_install::compareTCAandDatabase ( TCA,
FDcomp 
)

Compares the $TCA array with a field definition array

Parameters:
array$TCAThe TCA
array$FDcompField definition comparison
Returns:
array

Definition at line 7230 of file class.tx_install.php.

References $TCA, and suggestFieldDefinition().

Referenced by checkTheDatabase().

tx_install::copyright ( )

Generate HTML for the copyright

Returns:
string HTML of the copyright

Definition at line 8085 of file class.tx_install.php.

References $content.

Referenced by outputWrapper().

tx_install::createEncryptionKey ( keyLength = 96)

Returns a newly created TYPO3 encryption key with a given length.

Parameters:
integer$keyLengthDesired key length
Returns:
string The encryption key

Definition at line 8442 of file class.tx_install.php.

References t3lib_div\generateRandomBytes().

Referenced by tx_dbal_installtool\createConnectionForm(), and stepOutput().

tx_install::displayFieldComp ( arr,
arr_db 
)

Generates an HTML table with comparison between database and $TCA Used in 'Database analyzer > Compare with $TCA'

Parameters:
array$arrDescription of the table with fieldname and fieldcontent
array$arr_dbThe actual content of a field in the database
Returns:
string HTML of the table

Definition at line 7019 of file class.tx_install.php.

References $template, t3lib_parsehtml\getSubpart(), t3lib_parsehtml\substituteMarkerArray(), and t3lib_parsehtml\substituteSubpart().

Referenced by checkTheDatabase().

tx_install::displayFields ( arr,
pre = 0,
label = '' 
)

Generates an HTML table for the setup of database tables Used in 'Database analyzer > Compare with $TCA'

Parameters:
array$arrDescription of the table with fieldname and fieldcontent
boolean$preTRUE if the field content needs to be wrapped with a
 tag
 
string$label
The header label
 
Returns:
 string HTML of the table

Definition at line 6961 of file class.tx_install.php.

References $template, t3lib_parsehtml\getSubpart(), t3lib_parsehtml\substituteMarkerArray(), and t3lib_parsehtml\substituteSubpart().

Referenced by checkTheDatabase().

tx_install::displaySuggestions ( arr,
excludeList = '' 
)

Generates an HTML table with $TCA suggestions looking at the type of field Used in 'Database analyzer > Compare with $TCA'

Parameters:
array$arrDescription of the table with fieldname and fieldcontent
string$excludeListComma separated list of fields which should be excluded from this table
Returns:
string HTML of the table

Definition at line 7090 of file class.tx_install.php.

References $row, $template, t3lib_parsehtml\getSubpart(), t3lib_div\inList(), t3lib_parsehtml\substituteMarkerArray(), and t3lib_parsehtml\substituteSubpart().

Referenced by checkTheDatabase().

tx_install::displayTwinImage ( imageFile,
IMcommands = array(),
note = '' 
)

Generate the HTML after reading and converting images Displays the verification and the converted image if succeeded Adds error messages if needed

Parameters:
string$imageFileThe file name of the converted image
array$IMcommandsThe ImageMagick commands used
string$noteAdditional note for image operation
Returns:
array Contains content and highest error level

Definition at line 5146 of file class.tx_install.php.

References $content, $template, t3lib_extMgm\extPath(), t3lib_extMgm\extRelPath(), formatImCmds(), t3lib_div\formatSize(), t3lib_parsehtml\getSubpart(), t3lib_div\intInRange(), t3lib_parsehtml\substituteMarkerArray(), and t3lib_parsehtml\substituteSubpart().

Referenced by checkTheImageProcessing().

tx_install::formatImCmds ( arr)

Format ImageMagick commands for use in HTML

Parameters:
array$arrThe ImageMagick commands
Returns:
string The formatted commands

Definition at line 5359 of file class.tx_install.php.

Referenced by displayTwinImage().

tx_install::generallyAboutConfiguration ( )

Returns general information about configuration of TYPO3.

Returns:
string HTML with the general information

Definition at line 4290 of file class.tx_install.php.

Referenced by init().

tx_install::generateConfigForm ( type = '')

Creating the form for editing the TYPO3_CONF_VARS options.

Parameters:
string$typeIf get_form, display form, otherwise checks and store in localconf.php
Returns:
void

Definition at line 2003 of file class.tx_install.php.

References $GLOBALS, $template, $TYPO3_CONF_VARS, getDefaultConfigArrayComments(), t3lib_parsehtml\getSubpart(), and message().

Referenced by init().

tx_install::generateUpdateDatabaseForm ( type,
arr_update,
arr_remove,
action_type 
)

Generate the contents for the form for 'Database Analyzer' when the 'COMPARE' still contains errors

Parameters:
string$typeget_form if the form needs to be generated
array$arr_updateThe tables/fields which needs an update
array$arr_removeThe tables/fields which needs to be removed
string$action_typeThe action type
Returns:
string HTML for the form

Definition at line 6895 of file class.tx_install.php.

References $content, generateUpdateDatabaseForm_checkboxes(), getUpdateDbFormWrap(), and t3lib_extMgm\isLoaded().

Referenced by checkTheDatabase().

tx_install::generateUpdateDatabaseForm_checkboxes ( arr,
label,
checked = 1,
iconDis = 0,
currentValue = array(),
cVfullMsg = 0 
)

Creates a table which checkboxes for updating database.

Parameters:
array$arrArray of statements (key / value pairs where key is used for the checkboxes)
string$labelLabel for the table.
boolean$checkedIf set, then checkboxes are set by default.
boolean$iconDisIf set, then icons are shown.
array$currentValueArray of "current values" for each key/value pair in $arr. Shown if given.
boolean$cVfullMsgIf set, will show the prefix "Current value" if $currentValue is given.
Returns:
string HTML table with checkboxes for update. Must be wrapped in a form.

Reimplemented from t3lib_install.

Definition at line 8180 of file class.tx_install.php.

References $content, t3lib_parsehtml\getSubpart(), t3lib_parsehtml\substituteMarkerArray(), and t3lib_parsehtml\substituteSubpart().

Referenced by generateUpdateDatabaseForm().

tx_install::getBackupFilename ( filename)

Return the filename that will be used for the backup. It is important that backups of PHP files still stay as a PHP file, otherwise they could be viewed un-parsed in clear-text.

Parameters:
string$filenameFull path to a file
Returns:
string The name of the backup file (again, including the full path)

Definition at line 8159 of file class.tx_install.php.

tx_install::getDatabaseList ( )

Returns the list of available databases (with access-check based on username/password)

Returns:
array List of available databases

Definition at line 4024 of file class.tx_install.php.

References $GLOBALS.

Referenced by setupGeneral(), and stepOutput().

tx_install::getDefaultConfigArrayComments ( string,
mainArray = array(),
commentArray = array() 
)

Make an array of the comments in the t3lib/config_default.php file

Parameters:
string$stringThe contents of the config_default.php file
array$mainArray
array$commentArray
Returns:
array

Definition at line 2192 of file class.tx_install.php.

Referenced by generateConfigForm().

tx_install::getGDSoftwareInfo ( )

Returns general information about GDlib

Returns:
string HTML with GD lib information

Definition at line 4270 of file class.tx_install.php.

Referenced by checkExtensions(), and checkTheImageProcessing().

tx_install::getItemArrayType ( arr)

Check if field needs to be varchar or int Private

Parameters:
array$arr
Returns:
string The definition

Definition at line 7342 of file class.tx_install.php.

References t3lib_div\testInt().

Referenced by suggestFieldDefinition().

tx_install::getItemBlobSize ( len)

Defines the blob size of an item by a given length Private

Parameters:
integer$lenThe length
Returns:
string The blob definition

Definition at line 7369 of file class.tx_install.php.

Referenced by suggestFieldDefinition().

tx_install::getMissingPhpModules ( ) [protected]

Checks if the essential PHP modules are loaded

Returns:
array list of modules which are missing

Definition at line 4164 of file class.tx_install.php.

References $GLOBALS, $module, and t3lib_div\getUserObj().

Referenced by tx_install().

tx_install::getNextUpdadeWizardInstance ( currentObj) [protected]

Returns the next upgrade wizard object.

Used to show the link/button to the next upgrade wizard

Parameters:
object$currentObjcurrent Upgrade Wizard Object
Returns:
mixed Upgrade Wizard instance or FALSE

Definition at line 6822 of file class.tx_install.php.

References $GLOBALS, and getUpgradeObjInstance().

Referenced by updateWizard_parts().

tx_install::getUpdateDbFormWrap ( action_type,
content,
label = 'Write to database' 
)

Form wrap for 'Database Analyzer' when the 'COMPARE' still contains errors

Parameters:
string$action_typeThe action type
string$contentThe form content
string$labelThe submit button label
Returns:
string HTML of the form

Definition at line 6928 of file class.tx_install.php.

References $content, t3lib_parsehtml\getSubpart(), and t3lib_parsehtml\substituteMarkerArray().

Referenced by checkTheDatabase(), and generateUpdateDatabaseForm().

tx_install::getUpgradeObjInstance ( className,
identifier 
)

Creates instance of an upgrade object, setting the pObj, versionNumber and pObj

Parameters:
string$classNameThe class name
string$identifierThe identifier of upgrade object - needed to fetch user input
Returns:
object Newly instanciated upgrade object

Definition at line 6806 of file class.tx_install.php.

References t3lib_div\getUserObj(), and t3lib_div\int_from_ver().

Referenced by getNextUpdadeWizardInstance(), and updateWizard_parts().

tx_install::imagemenu ( )

Generate the menu for the test menu in 'image processing'

Returns:
string The HTML for the test menu

Definition at line 5378 of file class.tx_install.php.

References $items, $markers, $menuitems, $template, t3lib_parsehtml\getSubpart(), t3lib_parsehtml\substituteMarkerArray(), and t3lib_parsehtml\substituteSubpart().

Referenced by checkTheImageProcessing().

tx_install::ImageTypes ( )

Return the image types supported by this PHP build

Returns:
integer A bit-field corresponding to the image formats supported by the version of GD linked into PHP. The following bits are returned, IMG_GIF | IMG_JPG | IMG_PNG | IMG_WBMP | IMG_XPM.

Definition at line 4261 of file class.tx_install.php.

Referenced by isGIF(), isJPG(), and isPNG().

tx_install::includeTCA ( )

Includes TCA

Returns:
void

Definition at line 7523 of file class.tx_install.php.

References $GLOBALS, $TCA, and t3lib_div\loadTCA().

Referenced by checkTheDatabase().

tx_install::init ( )
tx_install::isBackendAdminUser ( )

Check if at lease one backend admin user has been created

Returns:
integer Amount of backend users in the database

Definition at line 6846 of file class.tx_install.php.

References $GLOBALS.

Referenced by isBasicComplete().

tx_install::isBasicComplete ( tLabel)

Check if the basic settings are complete Only used by 1-2-3 mode

Parameters:
string$tLabelThe header for the message
Returns:
boolean TRUE if complete

Definition at line 6857 of file class.tx_install.php.

References alterPasswordForm(), t3lib_install\getListOfTables(), isBackendAdminUser(), message(), messageBasicFinished(), and securityRisk().

Referenced by checkTheDatabase().

tx_install::isExtensionEnabled ( ext,
headCode,
short 
)

Check if image file extension is enabled Adds error message to the message array

Parameters:
string$extThe image file extension
string$headCodeThe header for the message
string$shortThe short description for the message
Returns:
boolean TRUE if extension is enabled

Definition at line 5123 of file class.tx_install.php.

References $GLOBALS, t3lib_div\inList(), and message().

Referenced by checkTheImageProcessing().

tx_install::isGD ( )

Check if GD module is available by checking the function imagecreate

Returns:
boolean TRUE if GD is available

Definition at line 4211 of file class.tx_install.php.

Referenced by checkExtensions().

tx_install::isGIF ( )

Check if GIF functions are available

Returns:
boolean TRUE if GIF functions are available

Definition at line 4225 of file class.tx_install.php.

References t3lib_extMgm\extPath(), and ImageTypes().

Referenced by checkExtensions(), and isTTF().

tx_install::isJPG ( )

Check if JPG functions are available

Returns:
boolean TRUE if JPEG functions are available

Definition at line 4238 of file class.tx_install.php.

References ImageTypes().

Referenced by checkExtensions().

tx_install::isPNG ( )

Check if PNG functions are available

Returns:
boolean TRUE if PNG functions are available

Definition at line 4249 of file class.tx_install.php.

References t3lib_extMgm\extPath(), and ImageTypes().

Referenced by checkExtensions().

tx_install::isTTF ( )

Returns true if TTF lib is installed.

Returns:
boolean TRUE if TrueType support

Definition at line 4134 of file class.tx_install.php.

References t3lib_div\_GP(), t3lib_div\freetypeDpiComp(), and isGIF().

Referenced by checkExtensions().

tx_install::loginForm ( )

Create the HTML for the login form

Reads and fills the template. Substitutes subparts when wrong password has been given or the session has expired

Returns:
void

Definition at line 456 of file class.tx_install.php.

References $content, $GLOBALS, $markers, $template, t3lib_div\_GP(), t3lib_parsehtml\getSubpart(), output(), outputWrapper(), t3lib_parsehtml\substituteMarkerArray(), and t3lib_parsehtml\substituteSubpart().

Referenced by tx_install().

tx_install::menu ( )

Generates the main menu

Returns:
string HTML of the main menu

Definition at line 7929 of file class.tx_install.php.

References $items, $markers, t3lib_parsehtml\getSubpart(), t3lib_parsehtml\substituteMarkerArray(), and t3lib_parsehtml\substituteSubpart().

Referenced by outputWrapper().

tx_install::message ( head,
short_string = '',
long_string = '',
type = 0,
force = 0 
)

Setting a message in the message-log and sets the fatalError flag if error type is 3.

Parameters:
string$headSection header
string$short_stringA short description
string$long_stringA long (more detailed) description
integer$type-1=OK sign, 0=message, 1=notification, 2=warning, 3=error
boolean$forcePrint message also in "Advanced" mode (not only in 1-2-3 mode)
Returns:
void

Definition at line 7567 of file class.tx_install.php.

References printSection().

Referenced by checkConfiguration(), checkDatabase(), checkDirs(), checkExtensions(), checkImageMagick(), checkTheDatabase(), checkTheImageProcessing(), cleanupManager(), generateConfigForm(), init(), isBasicComplete(), isExtensionEnabled(), and updateWizard_parts().

tx_install::messageBasicFinished ( )

Generate HTML for the message that the basic setup has been finished

Returns:
string HTML of the message

Definition at line 8111 of file class.tx_install.php.

Referenced by isBasicComplete(), and stepOutput().

tx_install::output ( content)

Sends the page to the client.

Parameters:
string$contentThe HTML page
Returns:
void

Definition at line 7918 of file class.tx_install.php.

References $content, and $GLOBALS.

Referenced by checkTheDatabase(), checkTheImageProcessing(), cleanupManager(), init(), loginForm(), outputExitBasedOnStep(), and updateWizard().

tx_install::outputErrorAndExit ( content,
title = 'Install Tool error' 
) [protected]

Outputs an error and dies. Should be used by all errors that occur before even starting the install tool process.

Parameters:
stringThe content of the error
Returns:
void

Definition at line 7878 of file class.tx_install.php.

References $content, $javascript, $markers, $template, and t3lib_parsehtml\substituteMarkerArray().

Referenced by tx_install().

tx_install::outputExitBasedOnStep ( content)

If in 1-2-3 mode, send a redirect header response with the action and exit otherwise send output to output() function

Parameters:
string$contentThe HTML to output
Returns:
void

Definition at line 3971 of file class.tx_install.php.

References $content, output(), outputWrapper(), and t3lib_utility_Http\redirect().

Referenced by writeToLocalconf_control().

tx_install::outputWrapper ( content)

This wraps and returns the main content of the page into proper html-code.

Parameters:
string$contentThe page content
Returns:
string The full HTML page

Definition at line 7689 of file class.tx_install.php.

References $content, $GLOBALS, copyright(), t3lib_div\createVersionNumberedFilename(), t3lib_utility_Client\getBrowserInfo(), t3lib_div\getIndpEnv(), t3lib_parsehtml\getSubpart(), menu(), t3lib_parsehtml\substituteMarkerArray(), and t3lib_parsehtml\substituteSubpart().

Referenced by checkTheDatabase(), checkTheImageProcessing(), cleanupManager(), init(), loginForm(), outputExitBasedOnStep(), and updateWizard().

tx_install::phpinformation ( )

Outputs system information

Returns:
void

Definition at line 1551 of file class.tx_install.php.

Referenced by init().

tx_install::printAll ( )

This prints all the messages in the ->section array

Returns:
string HTML of all the messages

Definition at line 7649 of file class.tx_install.php.

References $content, $sections, $template, t3lib_parsehtml\getSubpart(), t3lib_parsehtml\substituteMarkerArray(), and t3lib_parsehtml\substituteSubpart().

Referenced by checkTheDatabase(), checkTheImageProcessing(), cleanupManager(), init(), and updateWizard().

tx_install::printSection ( head,
short_string,
long_string,
type 
)

This "prints" a section with a message to the ->sections array

Parameters:
string$headSection header
string$short_stringA short description
string$long_stringA long (more detailed) description
integer$type-1=OK sign, 0=message, 1=notification, 2=warning , 3=error
Returns:
void

Definition at line 7589 of file class.tx_install.php.

References $content, $markers, $template, t3lib_parsehtml\getSubpart(), t3lib_parsehtml\substituteMarkerArray(), and t3lib_parsehtml\substituteSubpart().

Referenced by message().

tx_install::securityRisk ( )

Generate HTML for the security risk message

Returns:
string HTML for the security risk message

Definition at line 8026 of file class.tx_install.php.

Referenced by init(), isBasicComplete(), and stepOutput().

tx_install::setLabelValueArray ( arr,
type 
)

This appends something to value in the input array based on $type. Private.

Parameters:
array$arr
integer$type
Returns:
array

Definition at line 3987 of file class.tx_install.php.

Referenced by setupGeneral().

tx_install::setScriptName ( type)

Make the url of the script according to type, mode and step

Parameters:
string$typeThe type
Returns:
string The url

Definition at line 8147 of file class.tx_install.php.

References $value.

Referenced by init().

tx_install::setupGeneral ( cmd = '')

Prints form for updating localconf.php or updates localconf.php depending on $cmd

Parameters:
string$cmdIf "get_form" it outputs the form. Default is to write "localconf.php" based on input in ->INSTALL[localconf.php] array and flag ->setLocalconf
Returns:
string Form HTML

Definition at line 3260 of file class.tx_install.php.

References $GLOBALS, $TYPO3_CONF_VARS, $typo_db, $typo_db_host, $typo_db_password, $typo_db_username, $value, getDatabaseList(), t3lib_parsehtml\getSubpart(), t3lib_div\getUserObj(), setLabelValueArray(), setupGeneralCalculate(), t3lib_install\setValueInLocalconfFile(), t3lib_parsehtml\substituteMarkerArray(), t3lib_parsehtml\substituteSubpart(), and writeToLocalconf_control().

Referenced by init().

tx_install::setupGeneralCalculate ( )

Calculates the suggested setup that should be written to localconf.php

If safe_mode

  • disable_exec_function = 1
  • im = 0

if PNG/GIF/GD

  • disable gdlib if nothing
    • select png/gif if only one of them is available, else PNG/GIF selector, defaulting to GIF
  • (safe_mode is on)
    • im_path (default to 4.2.9, preferable with LZW) im_ver5-flag is set based on im_path being 4.2.9 or 5+
    • im_path_lzw (default to LZW version, pref. 4.2.9)
Returns:
array Suggested setup

Definition at line 4048 of file class.tx_install.php.

Referenced by setupGeneral().

tx_install::stepHeader ( )

Generates the step header for 1-2-3 mode, the numbers at the top

Returns:
string HTML for the step header

Definition at line 7978 of file class.tx_install.php.

References $content, $template, t3lib_parsehtml\getSubpart(), t3lib_parsehtml\substituteMarkerArray(), and t3lib_parsehtml\substituteSubpart().

Referenced by stepOutput().

tx_install::stepOutput ( )
tx_install::suggestFieldDefinition ( fieldInfo)

Suggests a field definition for a TCA config array.

Parameters:
array$fieldInfoInfo of a field
Returns:
string The suggestion

Definition at line 7261 of file class.tx_install.php.

References getItemArrayType(), getItemBlobSize(), and t3lib_div\intInRange().

Referenced by compareTCAandDatabase().

tx_install::suggestTCAFieldDefinition ( fieldName,
fieldInfo 
)

Should suggest a TCA configuration for a specific field.

Parameters:
string$fieldNameThe field name
string$fieldInfoThe field information
Returns:
string Suggested TCA configuration

Definition at line 7380 of file class.tx_install.php.

Referenced by compareDatabaseAndTCA().

tx_install::tx_install ( )
tx_install::typo3conf_edit ( )

Editing files in typo3conf directory (or elsewhere if enabled)

Returns:
void

Definition at line 1334 of file class.tx_install.php.

References t3lib_div\validPathStr().

Referenced by init().

tx_install::updateWizard ( )

Generates update wizard

Returns:
void

Definition at line 6433 of file class.tx_install.php.

References $action, t3lib_extMgm\getCacheFilePrefix(), output(), outputWrapper(), printAll(), t3lib_extMgm\removeCacheFiles(), and updateWizard_parts().

Referenced by init().

tx_install::updateWizard_parts ( action)

Implements the steps for the update wizard

Parameters:
string$actionWhich should be done.
Returns:
void

Definition at line 6449 of file class.tx_install.php.

References $action, $content, $GLOBALS, $markers, $query, getNextUpdadeWizardInstance(), t3lib_parsehtml\getSubpart(), getUpgradeObjInstance(), message(), t3lib_parsehtml\substituteMarkerArray(), and t3lib_parsehtml\substituteSubpart().

Referenced by updateWizard().

tx_install::viewArray ( incomingValue)

Returns HTML-code, which is a visual representation of a multidimensional array Returns false if $array_in is not an array

Parameters:
mixed$incomingValueArray to view
Returns:
string HTML output

Definition at line 8387 of file class.tx_install.php.

References $content, $items, $value, t3lib_parsehtml\getSubpart(), t3lib_parsehtml\substituteMarkerArray(), and t3lib_parsehtml\substituteSubpart().

tx_install::writeToLocalconf_control ( lines = '',
showOutput = TRUE 
)

Writes or returns lines from localconf.php

Parameters:
array$linesArray of lines to write back to localconf.php. Possibly
boolean$showOutputIf TRUE then print what has been done.
Returns:
mixed If $lines is not an array it will return an array with the lines from localconf.php. Otherwise it will return a status string, either "continue" (updated) or "nochange" (not updated)
See also:
parent::writeToLocalconf_control()

Reimplemented from t3lib_install.

Definition at line 3889 of file class.tx_install.php.

References $content, $markers, $messages, $template, t3lib_parsehtml\getSubpart(), outputExitBasedOnStep(), t3lib_parsehtml\substituteMarkerArray(), and t3lib_parsehtml\substituteSubpart().

Referenced by setupGeneral().


Member Data Documentation

tx_install::$action = ''

Definition at line 182 of file class.tx_install.php.

Referenced by cleanupManager(), updateWizard(), and updateWizard_parts().

tx_install::$allowFileEditOutsite_typo3conf_dir = 0

Definition at line 188 of file class.tx_install.php.

tx_install::$checkIM = 0

Definition at line 192 of file class.tx_install.php.

tx_install::$checkIMlzw = 0

Definition at line 191 of file class.tx_install.php.

tx_install::$config_array
Initial value:
 array( 
        'gd'=>0,
        'gd_gif'=>0,
        'gd_png'=>0,
        'gd_jpg'=>0,
        'freetype' => 0,
        'safemode' => 0,
        'dir_typo3temp' => 0,
        'dir_temp' => 0,
        'im_versions' => array(),
        'im' => 0,
        'sql.safe_mode_user' => '',
        'mysqlConnect' => 0,
        'no_database' => 0
    )

Definition at line 204 of file class.tx_install.php.

tx_install::$dumpImCommands = 1

Definition at line 193 of file class.tx_install.php.

tx_install::$errorMessages = array()

Definition at line 180 of file class.tx_install.php.

tx_install::$fatalError = 0

Definition at line 202 of file class.tx_install.php.

tx_install::$formProtection = NULL [protected]

Definition at line 232 of file class.tx_install.php.

tx_install::$headerStyle = ''

Definition at line 185 of file class.tx_install.php.

tx_install::$INSTALL = array()

Definition at line 190 of file class.tx_install.php.

tx_install::$javascript

Definition at line 176 of file class.tx_install.php.

Referenced by outputErrorAndExit().

tx_install::$mailMessage = ''

Definition at line 181 of file class.tx_install.php.

tx_install::$markers = array()
tx_install::$menuitems
Initial value:
 array(
        'config' => 'Basic Configuration',
        'database' => 'Database Analyser',
        'update' => 'Upgrade Wizard',
        'images' => 'Image Processing',
        'extConfig' => 'All Configuration',
        'cleanup' => 'Clean up',
        'phpinfo' => 'phpinfo()',
        'typo3conf_edit' => 'Edit files in typo3conf/',
        'about' => 'About',
        'logout' => 'Logout from Install Tool',
    )

Definition at line 234 of file class.tx_install.php.

Referenced by imagemenu().

tx_install::$messages = array()

Reimplemented from t3lib_install.

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

Referenced by writeToLocalconf_control().

tx_install::$mode = ''

Definition at line 194 of file class.tx_install.php.

tx_install::$passwordOK = 0

Definition at line 199 of file class.tx_install.php.

tx_install::$requiredPhpModules [protected]
Initial value:
 array(
        'filter',
        'gd',
        'json',
        'mysql',
        'pcre',
        'session',
        'SPL',
        'standard',
        'xml',
        'zlib'
    )

Definition at line 248 of file class.tx_install.php.

tx_install::$scriptSelf = 'index.php'

Definition at line 183 of file class.tx_install.php.

tx_install::$sections = array()

Definition at line 201 of file class.tx_install.php.

Referenced by printAll().

tx_install::$sendNoCacheHeaders = 1

Definition at line 203 of file class.tx_install.php.

tx_install::$session = NULL [protected]

Definition at line 225 of file class.tx_install.php.

tx_install::$setAllCheckBoxesByDefault = 0

Definition at line 186 of file class.tx_install.php.

tx_install::$silent = 1

Definition at line 200 of file class.tx_install.php.

tx_install::$step = 0

Definition at line 195 of file class.tx_install.php.

tx_install::$stylesheets

Definition at line 177 of file class.tx_install.php.

tx_install::$template
tx_install::$templateFilePath = 'typo3/sysext/install/Resources/Private/Templates/'

Definition at line 174 of file class.tx_install.php.

tx_install::$totalSteps = 4

Definition at line 196 of file class.tx_install.php.

tx_install::$typo3temp_path = ''

Definition at line 219 of file class.tx_install.php.

tx_install::$updateIdentity = 'TYPO3 Install Tool'

Reimplemented from t3lib_install.

Definition at line 184 of file class.tx_install.php.


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