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 ($uKey)
 loginForm ()
 init ()
 stepOutput ()
 checkTheConfig ()
 typo3conf_edit ()
 phpinformation ()
 typo3TempManager ()
 getSelectorOptions ($deleteType, $tt='')
 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)
 getFormElement ($labels, $values, $fieldName, $default, $msg='')
 getDatabaseList ()
 setupGeneralCalculate ()
 getGDPartOfPhpinfo ()
 isTTF ($phpinfo='')
 isGD ()
 isGIF ()
 isJPG ()
 isPNG ()
 ImageTypes ()
 getGDSoftwareInfo ()
 generallyAboutConfiguration ()
 checkTheImageProcessing ()
 isExtensionEnabled ($ext, $headCode, $short)
 displayTwinImage ($imageFile, $IMcommands=array(), $note='')
 getTwinImageMessage ($message, $label_1="", $label_2='')
 formatImCmds ($arr)
 imagemenu ()
 checkTheDatabase ()
 updateWizard ()
 updateWizard_parts ($action)
 getUpgradeObjInstance ($className, $identifier)
 isBackendAdminUser ()
 isStaticTemplates ()
 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 ()
 linkIt ($url, $link='')
 message ($head, $short_string='', $long_string='', $type=0, $force=0)
 printSection ($head, $short_string, $long_string, $type)
 fw ($str, $size=1)
 fwheader ($str)
 wrapInCells ($label, $content)
 printAll ()
 outputWrapper ($content)
 output ($content)
 menu ()
 stepHeader ()
 note123 ()
 endNotes ()
 convertByteSize ($bytes)
 securityRisk ()
 alterPasswordForm ()
 messageBasicFinished ()
 setScriptName ($type)
 formWidth ($size=48, $textarea=0, $styleOverride='')
 formWidthText ($size=48, $styleOverride='', $wrap='')
 getBackupFilename ($filename)

Public Attributes

 $getGD_start_string = '<h2 align="center"><a name="module_gd">gd</a></h2>'
 $getGD_end_string = '</table>'
 $getTTF_string = 'with TTF library'
 $getTTF_string_alt = 'with freetype'
 $action = ''
 $scriptSelf = 'index.php'
 $fontTag2 = '<span class="bodytext">'
 $fontTag1 = '<span class="smalltext">'
 $updateIdentity = 'TYPO3 Install Tool'
 $headerStyle = ''
 $contentBeforeTable = ''
 $setAllCheckBoxesByDefault = 0
 $allowFileEditOutsite_typo3conf_dir = 0
 $INSTALL = array()
 $checkIMlzw = 0
 $checkIM = 0
 $dumpImCommands = 1
 $mode = ''
 $step = 0
 $passwordOK = 0
 $silent = 1
 $messageFunc_nl2br = 1
 $sections = array()
 $fatalError = 0
 $sendNoCacheHeaders = 1
 $config_array
 $typo3temp_path = ''
 $menuitems
 $cookie_name = 'Typo3InstallTool'
 $JSmessage = ''

Detailed Description

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


Member Function Documentation

tx_install::_checkImageMagick_getVersion ( file,
path 
)

Extracts the version number for ImageMagick

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

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

Referenced by checkImageMagick().

tx_install::_checkImageMagickGifCapability ( path  ) 

Checking GIF-compression capabilities of ImageMagick install

Parameters:
[type] $file: ...
Returns:
[type] ...

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

tx_install::alterPasswordForm (  ) 

[Describe function...]

Returns:
[type] ...

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

References $content.

Referenced by init().

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:
[type] ...

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

References t3lib_div::makeInstance(), and t3lib_div::plainMailEncoded().

Referenced by checkConfiguration(), and init().

tx_install::checkConfiguration (  ) 

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

Returns:
[type] ...

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

References check_mail(), convertByteSize(), message(), t3lib_div::testInt(), t3lib_div::trimExplode(), and t3lib_div::validIP().

Referenced by checkTheConfig().

tx_install::checkDatabase (  ) 

Checks database username/password/host/database

Returns:
[type] ...

Definition at line 1995 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:
[type] ...

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

References message(), and t3lib_div::mkdir().

Referenced by checkTheConfig().

tx_install::checkExtensions (  ) 

Checking php extensions, specifically GDLib and Freetype

Returns:
[type] ...

Definition at line 1683 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:
[type] $paths: ...
Returns:
[type] ...

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

References _checkImageMagick_getVersion(), and message().

Referenced by checkTheConfig().

tx_install::checkPassword ( uKey  ) 

Returns true if submitted password is ok. Else displays a form in which to enter password.

Parameters:
[type] $uKey: ...
Returns:
bool whether the submitted password is ok

Definition at line 330 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:
[type] ...

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

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

Referenced by init(), and stepOutput().

tx_install::checkTheDatabase (  ) 

Returns:
[type] ...

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

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:
[type] ...

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

References more.

Referenced by init().

tx_install::cleanupManager (  ) 

Provides a tool cleaning up various tables in the database

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

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

References $action, $content, $GLOBALS, $res, t3lib_install::getListOfTables(), message(), output(), outputWrapper(), and printAll().

Referenced by init().

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

Compares an array with field definitions with $TCA array

Parameters:
[type] $FDsrc: ...
[type] $TCA: ...
[type] $onlyFields: ...
Returns:
[type] ...

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

tx_install::compareTCAandDatabase ( TCA,
FDcomp 
)

Compares the $TCA array with a field definition array

Parameters:
[type] $TCA: ...
[type] $FDcomp: ...
Returns:
[type] ...

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

tx_install::convertByteSize ( bytes  ) 

Convert a size from human-readable form into bytes

Parameters:
string A string containing the size in bytes, kilobytes or megabytes. Example: 64M
Returns:
string The string is returned in bytes and can also hold floating values

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

Referenced by checkConfiguration().

tx_install::displayFieldComp ( arr,
arr_db 
)

[Describe function...]

Parameters:
[type] $arr: ...
[type] $arr_db: ...
Returns:
[type] ...

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

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

[Describe function...]

Parameters:
[type] $arr: ...
[type] $pre: ...
[type] $label: ...
Returns:
[type] ...

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

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

[Describe function...]

Parameters:
[type] $arr: ...
[type] $excludeList: ...
Returns:
[type] ...

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

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

[Describe function...]

Parameters:
[type] $imageFile: ...
[type] $IMcommands: ...
[type] $note: ...
Returns:
[type] ...

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

tx_install::endNotes (  ) 

[Describe function...]

Returns:
[type] ...

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

References fw(), and OS.

tx_install::formatImCmds ( arr  ) 

[Describe function...]

Parameters:
[type] $arr: ...
Returns:
[type] ...

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

tx_install::formWidth ( size = 48,
textarea = 0,
styleOverride = '' 
)

[Describe function...]

Parameters:
[type] $size: ...
[type] $textarea: ...
[type] $styleOverride: ...
Returns:
[type] ...

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

References $GLOBALS.

tx_install::formWidthText ( size = 48,
styleOverride = '',
wrap = '' 
)

[Describe function...]

Parameters:
[type] $size: ...
[type] $styleOverride: ...
[type] $wrap: ...
Returns:
[type] ...

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

References $GLOBALS.

Referenced by typo3conf_edit().

tx_install::fw ( str,
size = 1 
)

Wraps the str in a font-tag with verdana 1

Parameters:
[type] $str: ...
[type] $size: ...
Returns:
[type] ...

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

Referenced by typo3conf_edit().

tx_install::fwheader ( str  ) 

Wraps the str in a font-tag with verdana 1

Parameters:
[type] $str: ...
Returns:
[type] ...

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

tx_install::generallyAboutConfiguration (  ) 

Returns general information about configuration of TYPO3.

Returns:
[type] ...

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

Referenced by init().

tx_install::generateConfigForm ( type = ''  ) 

Creating the form for editing the TYPO3_CONF_VARS options.

Parameters:
[type] $type: ...
Returns:
[type] ...

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

References $GLOBALS, $lines, $TYPO3_CONF_VARS, $value, t3lib_div::_GP(), t3lib_install::checkForBadString(), t3lib_div::debug(), t3lib_div::fixed_lgd(), getDefaultConfigArrayComments(), message(), t3lib_install::setValueInLocalconfFile(), and writeToLocalconf_control().

Referenced by init().

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

[Describe function...]

Parameters:
[type] $type: ...
[type] $arr_update: ...
[type] $arr_remove: ...
[type] $action_type: ...
Returns:
[type] ...

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

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 Full path to a file
Returns:
string The name of the backup file (again, including the full path)

Definition at line 5133 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:
[type] ...

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

References $GLOBALS.

Referenced by stepOutput().

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

[Describe function...]

Parameters:
[type] $string: ...
[type] $mainArray: ...
[type] $commentArray: ...
Returns:
[type] ...

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

References $lines, and $TYPO3_CONF_VARS.

Referenced by generateConfigForm().

tx_install::getFormElement ( labels,
values,
fieldName,
default,
msg = '' 
)

Returns a form-element for the localconf.php update form

Parameters:
[type] $labels: ...
[type] $values: ...
[type] $fieldName: ...
[type] $default: ...
[type] $msg: ...
Returns:
[type] ...

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

tx_install::getGDPartOfPhpinfo (  ) 

Returns the part of phpinfo() output that tells about GD library (HTML-code)

Returns:
[type] ...

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

tx_install::getGDSoftwareInfo (  ) 

Returns general information about GDlib

Returns:
[type] ...

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

Referenced by checkExtensions().

tx_install::getItemArrayType ( arr  ) 

Private

Parameters:
[type] $arr: ...
Returns:
[type] ...

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

References t3lib_div::testInt().

tx_install::getItemBlobSize ( len  ) 

Private

Parameters:
[type] $len: ...
Returns:
[type] ...

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

tx_install::getSelectorOptions ( deleteType,
tt = '' 
)

[Describe function...]

Parameters:
[type] $deleteType: ...
[type] $tt: ...
Returns:
[type] ...

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

tx_install::getTwinImageMessage ( message,
label_1 = "",
label_2 = '' 
)

[Describe function...]

Parameters:
[type] $message: ...
[type] $label_1: ...
[type] $label_2: ...
Returns:
[type] ...

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

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

[Describe function...]

Parameters:
[type] $action_type: ...
[type] $content: ...
[type] $label: ...
Returns:
[type] ...

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

Referenced by stepOutput().

tx_install::getUpgradeObjInstance ( className,
identifier 
)

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

Parameters:
string class name
identifier identifier of upgrade object - needed to fetch user input
Returns:
object newly instanciated upgrade object

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

tx_install::imagemenu (  ) 

[Describe function...]

Returns:
[type] ...

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

tx_install::ImageTypes (  ) 

[Describe function...]

Returns:
[type] ...

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

tx_install::includeTCA (  ) 

Includes TCA

Returns:
[type] ...

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

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

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

References $content, alterPasswordForm(), check_mail(), checkDatabase(), checkTheConfig(), checkTheDatabase(), checkTheImageProcessing(), cleanupManager(), t3lib_div::debug(), exit, generallyAboutConfiguration(), generateConfigForm(), message(), output(), outputWrapper(), phpinformation(), printAll(), securityRisk(), setScriptName(), setupGeneral(), stepOutput(), typo3conf_edit(), typo3TempManager(), and updateWizard().

tx_install::isBackendAdminUser (  ) 

[Describe function...]

Returns:
[type] ...

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

tx_install::isBasicComplete ( tLabel  ) 

[Describe function...]

Parameters:
[type] $tLabel: ...
Returns:
[type] ...

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

tx_install::isExtensionEnabled ( ext,
headCode,
short 
)

[Describe function...]

Parameters:
[type] $ext: ...
[type] $headCode: ...
[type] $short: ...
Returns:
[type] ...

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

tx_install::isGD (  ) 

Returns:
[type] ...

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

Referenced by checkExtensions().

tx_install::isGIF (  ) 

[Describe function...]

Returns:
[type] ...

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

References t3lib_extMgm::extPath().

Referenced by checkExtensions().

tx_install::isJPG (  ) 

[Describe function...]

Returns:
[type] ...

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

Referenced by checkExtensions().

tx_install::isPNG (  ) 

[Describe function...]

Returns:
[type] ...

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

References t3lib_extMgm::extPath().

Referenced by checkExtensions().

tx_install::isStaticTemplates (  ) 

[Describe function...]

Returns:
[type] ...

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

tx_install::isTTF ( phpinfo = ''  ) 

Returns true if TTF lib is install according to phpinfo(). If $phpinfo supply as parameter that string is searched instead.

Parameters:
[type] $phpinfo: ...
Returns:
[type] ...

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

References t3lib_div::_GP(), exit, and t3lib_div::freetypeDpiComp().

Referenced by checkExtensions().

tx_install::linkIt ( url,
link = '' 
)

This creates a link to the given $url. If $link is set, that'll be the link-text

Parameters:
[type] $url: ...
[type] $link: ...
Returns:
[type] ...

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

tx_install::loginForm (  ) 

[Describe function...]

Returns:
[type] ...

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

References $content, $TYPO3_CONF_VARS, t3lib_div::_GP(), message(), output(), outputWrapper(), and printAll().

Referenced by tx_install().

tx_install::menu (  ) 

[Describe function...]

Returns:
[type] ...

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

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

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

Referenced by checkConfiguration(), checkDirs(), checkExtensions(), checkImageMagick(), cleanupManager(), generateConfigForm(), init(), loginForm(), phpinformation(), tx_install(), typo3conf_edit(), and typo3TempManager().

tx_install::messageBasicFinished (  ) 

[Describe function...]

Returns:
[type] ...

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

Referenced by stepOutput().

tx_install::note123 (  ) 

[Describe function...]

Returns:
[type] ...

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

tx_install::output ( content  ) 

Sends the page to the client.

Parameters:
string The HTML page

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

References $content, and $GLOBALS.

Referenced by cleanupManager(), init(), loginForm(), phpinformation(), typo3conf_edit(), and typo3TempManager().

tx_install::outputExitBasedOnStep ( content  ) 

[Describe function...]

Parameters:
[type] $content: ...
Returns:
[type] ...

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

References $content, exit, and t3lib_div::locationHeaderUrl().

tx_install::outputWrapper ( content  ) 

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

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

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

References $content, and t3lib_div::slashJS().

Referenced by cleanupManager(), init(), loginForm(), phpinformation(), typo3conf_edit(), and typo3TempManager().

tx_install::phpinformation (  ) 

Outputs system information

Returns:
[type] ...

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

References $GLOBALS, t3lib_div::getIndpEnv(), message(), output(), outputWrapper(), printAll(), and t3lib_div::view_array().

Referenced by init().

tx_install::printAll (  ) 

This prints all the messages in the ->section array

Returns:
[type] ...

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

References nbsp.

Referenced by cleanupManager(), init(), loginForm(),