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 ()
 check_mail ($cmd='')
 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)

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 Attributes

 $session = NULL

Detailed Description

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

Member Function Documentation

tx_install::_checkImageMagick_getVersion ( $  file,
$  path 
)

Extracts the version number for ImageMagick

Parameters:
string $file The program name to execute in order to find out the version number
string $path Path for the above program
Returns:
string Version number of the found ImageMagick instance

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

Referenced by checkImageMagick().

tx_install::_checkImageMagickGifCapability ( $  path  ) 

Checking GIF-compression capabilities of ImageMagick install

Parameters:
string $path Path of ImageMagick installation
Returns:
string Type of compression

Definition at line 3018 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 7878 of file class.tx_install.php.

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

Referenced by init(), and isBasicComplete().

tx_install::check_mail ( $  cmd = ''  ) 

Check if PHP function mail() works

Parameters:
string $cmd If "get_form" then a formfield for the mail-address is shown. If not, it's checked if "check_mail" was in the INSTALL array and if so a test mail is sent to the recipient given.
Returns:
string The mail form if it is requested with get_form

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

References $markers, $template, t3lib_parsehtml::getSubpart(), t3lib_div::makeInstance(), message(), t3lib_div::plainMailEncoded(), t3lib_parsehtml::substituteMarkerArray(), and t3lib_parsehtml::substituteSubpart().

Referenced by checkConfiguration(), and init().

tx_install::checkConfiguration (  ) 

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

Returns:
void

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

References $TCA, $TYPO3_CONF_VARS, check_mail(), t3lib_div::getBytesFromSizeMeasurement(), 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 3101 of file class.tx_install.php.

Referenced by checkTheConfig(), and init().

tx_install::checkDirs (  ) 

Checking and testing that the required writable directories are writable.

Returns:
void

Definition at line 2787 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 2665 of file class.tx_install.php.

References getGDSoftwareInfo(), 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 $paths Possible ImageMagick paths
Returns:
void

Definition at line 2900 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 361 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 1242 of file class.tx_install.php.

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

Referenced by init(), and stepOutput().

tx_install::checkTheDatabase (  ) 

The Database Analyzer

Returns:
void

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

References $content, $GLOBALS, $res, $TCA, t3lib_div::_GP(), compareDatabaseAndTCA(), compareTCAandDatabase(), displayFieldComp(), displayFields(), displaySuggestions(), t3lib_div::fixed_lgd_cs(), t3lib_div::formatSize(), generateUpdateDatabaseForm(), t3lib_install::getCreateTables(), t3lib_install::getDatabaseExtra(), t3lib_install::getFieldDefinitions_database(), t3lib_install::getFieldDefinitions_fileContent(), t3lib_div::getFilesInDir(), t3lib_install::getListOfTables(), t3lib_install::getStatementArray(), t3lib_parsehtml::getSubpart(), t3lib_install::getTableInsertStatements(), getUpdateDbFormWrap(), t3lib_install::getUpdateSuggestions(), includeTCA(), t3lib_div::inList(), t3lib_div::intInRange(), isBasicComplete(), t3lib_extMgm::isLoaded(), menu(), message(), output(), outputWrapper(), t3lib_install::performUpdateQueries(), printAll(), t3lib_utility_Http::redirect(), t3lib_parsehtml::substituteMarkerArray(), t3lib_parsehtml::substituteSubpart(), and t3lib_div::testInt().

Referenced by init().

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

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...

GDlib:

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

Returns:
void

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

References $GLOBALS, displayTwinImage(), t3lib_extMgm::extPath(), t3lib_div::formatSize(), t3lib_div::gif_compress(), imagemenu(), isExtensionEnabled(), t3lib_div::makeInstance(), menu(), 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 1602 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 $FDsrc Field definition source
array $TCA The TCA array
boolean $onlyFields
Returns:
array

Definition at line 7037 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 $TCA The TCA
array $FDcomp Field definition comparison
Returns:
array

Definition at line 7096 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 7907 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 $keyLength Desired key length
Returns:
string The encryption key

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

References t3lib_div::generateRandomBytes().

Referenced by 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 $arr Description of the table with fieldname and fieldcontent
array $arr_db The actual content of a field in the database
Returns:
string HTML of the table

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

References $TCA, $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 $arr Description of the table with fieldname and fieldcontent
boolean $pre TRUE 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 6827 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 $arr Description of the table with fieldname and fieldcontent
string $excludeList Comma separated list of fields which should be excluded from this table
Returns:
string HTML of the table

Definition at line 6956 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 $imageFile The file name of the converted image
array $IMcommands The ImageMagick commands used
string $note Additional note for image operation
Returns:
array Contains content and highest error level

Definition at line 5075 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(), message(), t3lib_parsehtml::substituteMarkerArray(), and t3lib_parsehtml::substituteSubpart().

Referenced by checkTheImageProcessing().

tx_install::formatImCmds ( $  arr  ) 

Format ImageMagick commands for use in HTML

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

Definition at line 5288 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 4217 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 $type If get_form, display form, otherwise checks and store in localconf.php
Returns:
void

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

References $content, $GLOBALS, $markers, $template, $TYPO3_CONF_VARS, $value, t3lib_div::_GP(), t3lib_install::checkForBadString(), t3lib_div::fixed_lgd_cs(), getDefaultConfigArrayComments(), t3lib_parsehtml::getSubpart(), message(), t3lib_install::setValueInLocalconfFile(), t3lib_parsehtml::substituteMarkerArray(), t3lib_parsehtml::substituteSubpart(), and writeToLocalconf_control().

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 $type get_form if the form needs to be generated
array $arr_update The tables/fields which needs an update
array $arr_remove The tables/fields which needs to be removed
string $action_type The action type
Returns:
string HTML for the form

Definition at line 6761 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 $arr Array of statements (key / value pairs where key is used for the checkboxes)
string $label Label for the table.
boolean $checked If set, then checkboxes are set by default.
boolean $iconDis If set, then icons are shown.
array $currentValue Array of "current values" for each key/value pair in $arr. Shown if given.
boolean $cVfullMsg If 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 8002 of file class.tx_install.php.

References $content, $key, t3lib_parsehtml::getSubpart(), message(), 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 $filename Full path to a file
Returns:
string The name of the backup file (again, including the full path)

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

Referenced by typo3conf_edit().

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 3979 of file class.tx_install.php.

Referenced by tx_dbal_installtool::createDatabaseForm(), 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 $string The contents of the config_default.php file
array $mainArray
array $commentArray
Returns:
array

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

References $TYPO3_CONF_VARS.

Referenced by generateConfigForm().

tx_install::getGDSoftwareInfo (  ) 

Returns general information about GDlib

Returns:
string HTML with GD lib information

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

Referenced by checkExtensions().

tx_install::getItemArrayType ( $  arr  ) 

Check if field needs to be varchar or int Private

Parameters:
array $arr
Returns:
string The definition

Definition at line 7208 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 $len The length
Returns:
string The blob definition

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

Referenced by suggestFieldDefinition().

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

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

Parameters:
string $action_type The action type
string $content The form content
string $label The submit button label
Returns:
string HTML of the form

Definition at line 6794 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 $className The class name
string $identifier The identifier of upgrade object - needed to fetch user input
Returns:
object Newly instanciated upgrade object

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

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

Referenced by 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 5307 of file class.tx_install.php.

References $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 4188 of file class.tx_install.php.

tx_install::includeTCA (  ) 

Includes TCA

Returns:
void

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

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

Referenced by checkTheDatabase().

tx_install::init (  ) 

Calling function that checks system, IM, GD, dirs, database and lets you alter localconf.php

This method is called from init.php to start the Install Tool.

Returns:
void

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

References $content, $enableInstallToolFile, $markers, $TCA, $template, alterPasswordForm(), check_mail(), checkDatabase(), checkTheConfig(), checkTheDatabase(), checkTheImageProcessing(), cleanupManager(), t3lib_div::debug(), exit, generallyAboutConfiguration(), generateConfigForm(), t3lib_parsehtml::getSubpart(), message(), OS, output(), outputWrapper(), phpinformation(), printAll(), t3lib_utility_Http::redirect(), securityRisk(), setupGeneral(), stepOutput(), t3lib_parsehtml::substituteMarkerArray(), typo3conf_edit(), and updateWizard().

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 6712 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 $tLabel The header for the message
Returns:
boolean TRUE if complete

Definition at line 6723 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 $ext The image file extension
string $headCode The header for the message
string $short The short description for the message
Returns:
boolean TRUE if extension is enabled

Definition at line 5052 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 4138 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 4152 of file class.tx_install.php.

Referenced by checkExtensions().

tx_install::isJPG (  ) 

Check if JPG functions are available

Returns:
boolean TRUE if JPEG functions are available

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

Referenced by checkExtensions().

tx_install::isPNG (  ) 

Check if PNG functions are available

Returns:
boolean TRUE if PNG functions are available

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

Referenced by checkExtensions().

tx_install::isTTF (  ) 

Returns true if TTF lib is installed.

Returns:
boolean TRUE if TrueType support

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

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 408 of file class.tx_install.php.

References $content, $GLOBALS, $markers, $template, $TYPO3_CONF_VARS, t3lib_div::_GP(), t3lib_parsehtml::getSubpart(), message(), 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 7754 of file class.tx_install.php.

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

Referenced by checkTheDatabase(), checkTheImageProcessing(), and 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 $head Section header
string $short_string A short description
string $long_string A long (more detailed) description
integer $type -1=OK sign, 0=message, 1=notification, 2=warning, 3=error
boolean $force Print message also in "Advanced" mode (not only in 1-2-3 mode)
Returns:
void

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

References printSection().

Referenced by check_mail(), checkConfiguration(), checkDirs(), checkExtensions(), checkImageMagick(), checkTheDatabase(), checkTheImageProcessing(), cleanupManager(), displayTwinImage(), generateConfigForm(), generateUpdateDatabaseForm_checkboxes(), init(), isBasicComplete(), isExtensionEnabled(), loginForm(), outputWrapper(), phpinformation(), printSection(), typo3conf_edit(), 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 7933 of file class.tx_install.php.

Referenced by isBasicComplete(), and stepOutput().

tx_install::output ( $  content  ) 

Sends the page to the client.

Parameters:
string $content The HTML page
Returns:
void

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

References $content, and $GLOBALS.

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

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 $content The HTML to output
Returns:
void

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

tx_install::outputWrapper ( $  content  ) 

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

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

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

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

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

tx_install::phpinformation (  ) 

Outputs system information

Returns:
void

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

References $content, $GLOBALS, $markers, $template, t3lib_div::formatForTextarea(), t3lib_div::getIndpEnv(), t3lib_parsehtml::getSubpart(), message(), output(), outputWrapper(), printAll(), t3lib_parsehtml::substituteMarkerArray(), and viewArray().

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 7515 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(), phpinformation(), typo3conf_edit(), and updateWizard().

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

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

Parameters:
string $head Section header
string $short_string A short description
string $long_string A long (more detailed) description
integer $type -1=OK sign, 0=message, 1=notification, 2=warning , 3=error
Returns:
void

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

References $content, $markers, $template, t3lib_parsehtml::getSubpart(), message(), 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 7851 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 3942 of file class.tx_install.php.

tx_install::setScriptName ( $  type  ) 

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

Parameters:
string $type The type
Returns:
string The url

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

References $value.

tx_install::setupGeneral ( $  cmd = ''  ) 

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

Parameters:
string $cmd If "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 3204 of file class.tx_install.php.

Referenced by init().

tx_install::setupGeneralCalculate (  ) 

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

If safe_mode

if PNG/GIF/GD

Returns:
array Suggested setup

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

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 7803 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 (  ) 

Controls the step 1-2-3-go process

Returns:
string The content to output to the screen

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

References $content, $GLOBALS, $key, $markers, $template, checkTheConfig(), createEncryptionKey(), getDatabaseList(), t3lib_div::getFilesInDir(), t3lib_install::getListOfTables(), t3lib_parsehtml::getSubpart(), t3lib_div::getUserObj(), messageBasicFinished(), securityRisk(), stepHeader(), t3lib_parsehtml::substituteMarkerArray(), and t3lib_parsehtml::substituteSubpart().

Referenced by init().

tx_install::suggestFieldDefinition ( $  fieldInfo  ) 

Suggests a field definition for a TCA config array.

Parameters:
array $fieldInfo Info of a field
Returns:
string The suggestion

Definition at line 7127 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 $fieldName The field name
string $fieldInfo The field information
Returns:
string Suggested TCA configuration

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

Referenced by compareDatabaseAndTCA().

tx_install::tx_install (  ) 

Constructor

Returns:
void

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

References $enableInstallToolFile, $GLOBALS, t3lib_div::_GP(), checkPassword(), t3lib_div::getUserObj(), loginForm(), t3lib_div::makeInstance(), t3lib_utility_Http::redirect(), and typo3conf_edit().

tx_install::typo3conf_edit (  ) 

Editing files in typo3conf directory (or elsewhere if enabled)

Returns:
void

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

References $messages, $template, t3lib_div::formatForTextarea(), t3lib_div::formatSize(), getBackupFilename(), t3lib_div::getFilesInDir(), t3lib_parsehtml::getSubpart(), t3lib_div::isFirstPartOfStr(), message(), output(), outputWrapper(), printAll(), t3lib_parsehtml::substituteMarkerArray(), t3lib_parsehtml::substituteSubpart(), t3lib_div::validPathStr(), and t3lib_div::writeFile().

Referenced by init(), and tx_install().

tx_install::updateWizard (  ) 

Generates update wizard

Returns:
void

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

References $action, $GLOBALS, $TYPO3_CONF_VARS, output(), outputWrapper(), printAll(), t3lib_extMgm::removeCacheFiles(), t3lib_extMgm::typo3_loadExtensions(), and updateWizard_parts().

Referenced by init().

tx_install::updateWizard_parts ( $  action  ) 

Implements the steps for the update wizard

Parameters:
string $action Which should be done.
Returns:
void

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

References $action, $content, $GLOBALS, $markers, 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 $incomingValue Array to view
Returns:
string HTML output

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

References $content, $key, $value, t3lib_parsehtml::getSubpart(), t3lib_parsehtml::substituteMarkerArray(), and t3lib_parsehtml::substituteSubpart().

Referenced by phpinformation().

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

Writes or returns lines from localconf.php

Parameters:
array $lines Array of lines to write back to localconf.php. Possibly
boolean $showOutput If 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 3844 of file class.tx_install.php.

Referenced by generateConfigForm().

Member Data Documentation

tx_install::$action = ''

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

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

tx_install::$allowFileEditOutsite_typo3conf_dir = 0

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

tx_install::$checkIM = 0

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

tx_install::$checkIMlzw = 0

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

tx_install::$config_array

Initial value:

 array( // Flags are set in this array if the options are available and checked ok.
        '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 198 of file class.tx_install.php.

tx_install::$dumpImCommands = 1

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

tx_install::$errorMessages = array()

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

tx_install::$fatalError = 0

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

tx_install::$headerStyle = ''

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

tx_install::$INSTALL = array()

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

tx_install::$javascript

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

tx_install::$mailMessage = ''

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

tx_install::$markers = array()

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

Referenced by alterPasswordForm(), check_mail(), cleanupManager(), generateConfigForm(), imagemenu(), init(), loginForm(), menu(), phpinformation(), printSection(), stepOutput(), and updateWizard_parts().

tx_install::$menuitems

Initial value:

 array(
        'config' => 'Basic Configuration',
        'database' => 'Database Analyser',
        'update' => 'Update 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 221 of file class.tx_install.php.

Referenced by imagemenu().

tx_install::$messages = array()

Reimplemented from t3lib_install.

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

Referenced by typo3conf_edit().

tx_install::$mode = ''

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

tx_install::$passwordOK = 0

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

tx_install::$scriptSelf = 'index.php'

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

tx_install::$sections = array()

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

Referenced by printAll().

tx_install::$sendNoCacheHeaders = 1

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

tx_install::$session = NULL [protected]

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

tx_install::$setAllCheckBoxesByDefault = 0

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

tx_install::$silent = 1

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

tx_install::$step = 0

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

tx_install::$stylesheets

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

tx_install::$template

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

Referenced by alterPasswordForm(), check_mail(), cleanupManager(), displayFieldComp(), displayFields(), displaySuggestions(), displayTwinImage(), generateConfigForm(), imagemenu(), init(), loginForm(), phpinformation(), printAll(), printSection(), stepHeader(), stepOutput(), and typo3conf_edit().

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

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

tx_install::$totalSteps = 4

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

tx_install::$typo3temp_path = ''

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

tx_install::$updateIdentity = 'TYPO3 Install Tool'

Reimplemented from t3lib_install.

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

The documentation for this class was generated from the following file:
Generated on Sat Jul 24 04:20:47 2010 for TYPO3 API by  doxygen 1.4.7