Solutions Open Source

Référence de la classe tx_install

Graphe d'héritage de tx_install:

Inheritance graph
[légende]
Graphe de collaboration de tx_install:

Collaboration graph
[légende]

Liste de tous les membres

Fonctions membres publiques

 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)
 menu ()
 stepHeader ()
 note123 ()
 endNotes ()
 convertByteSize ($bytes)
 securityRisk ()
 alterPasswordForm ()
 messageBasicFinished ()
 setScriptName ($type)
 formWidth ($size=48, $textarea=0, $styleOverride='')
 formWidthText ($size=48, $styleOverride='', $wrap='')
 getBackupFilename ($filename)

Attributs publics

 $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 = ''


Documentation des fonctions membres

tx_install::tx_install (  ) 

Constructor

Renvoie:
[type] ...

tx_install::checkPassword ( uKey  ) 

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

Paramètres:
[type] $uKey: ...
Renvoie:
[type] ...

tx_install::loginForm (  ) 

[Describe function...]

Renvoie:
[type] ...

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.

Renvoie:
[type] ...

tx_install::stepOutput (  ) 

Controls the step 1-2-3-go process

Renvoie:
[type] ...

tx_install::checkTheConfig (  ) 

Calling the functions that checks the system

Renvoie:
[type] ...

tx_install::typo3conf_edit (  ) 

Editing files in typo3conf directory (or elsewhere if enabled)

Renvoie:
[type] ...

tx_install::phpinformation (  ) 

Outputs system information

Renvoie:
[type] ...

tx_install::typo3TempManager (  ) 

Provides a tool for deleting temporary files located in typo3temp/

Renvoie:
string HTML output

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

[Describe function...]

Paramètres:
[type] $deleteType: ...
[type] $tt: ...
Renvoie:
[type] ...

tx_install::cleanupManager (  ) 

Provides a tool cleaning up various tables in the database

Renvoie:
string HTML output
Auteur:
Robert Lemke <rl@robertlemke.de>
À faire:
Add more functionality ...

tx_install::generateConfigForm ( type = ''  ) 

Creating the form for editing the TYPO3_CONF_VARS options.

Paramètres:
[type] $type: ...
Renvoie:
[type] ...

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

[Describe function...]

Paramètres:
[type] $string: ...
[type] $mainArray: ...
[type] $commentArray: ...
Renvoie:
[type] ...

tx_install::checkConfiguration (  ) 

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

Renvoie:
[type] ...

tx_install::check_mail ( cmd = ''  ) 

Check if PHP function mail() works

Paramètres:
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.
Renvoie:
[type] ...

tx_install::checkExtensions (  ) 

Checking php extensions, specifically GDLib and Freetype

Renvoie:
[type] ...

tx_install::checkDirs (  ) 

Checking and testing that the required writable directories are writable.

Renvoie:
[type] ...

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.

Paramètres:
[type] $paths: ...
Renvoie:
[type] ...

tx_install::_checkImageMagickGifCapability ( path  ) 

Checking GIF-compression capabilities of ImageMagick install

Paramètres:
[type] $file: ...
Renvoie:
[type] ...

tx_install::_checkImageMagick_getVersion ( file,
path 
)

Extracts the version number for ImageMagick

Paramètres:
string The program name to execute in order to find out the version number
string Path for the above program
Renvoie:
string Version number of the found ImageMagick instance

tx_install::checkDatabase (  ) 

Checks database username/password/host/database

Renvoie:
[type] ...

tx_install::setupGeneral ( cmd = ''  ) 

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

Paramètres:
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
Renvoie:
[type] ...

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

Writes or returns lines from localconf.php

Paramètres:
array Array of lines to write back to localconf.php. Possibly
boolean If TRUE then print what has been done.
Renvoie:
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)
Voir également:
parent::writeToLocalconf_control()

Réimplémentée à partir de t3lib_install.

tx_install::outputExitBasedOnStep ( content  ) 

[Describe function...]

Paramètres:
[type] $content: ...
Renvoie:
[type] ...

tx_install::setLabelValueArray ( arr,
type 
)

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

Paramètres:
[type] $arr: ...
[type] $type: ...
Renvoie:
[type] ...

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

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

Paramètres:
[type] $labels: ...
[type] $values: ...
[type] $fieldName: ...
[type] $default: ...
[type] $msg: ...
Renvoie:
[type] ...

tx_install::getDatabaseList (  ) 

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

Renvoie:
[type] ...

tx_install::setupGeneralCalculate (  ) 

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

If safe_mode

if PNG/GIF/GD

Renvoie:
[type] ...

tx_install::getGDPartOfPhpinfo (  ) 

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

Renvoie:
[type] ...

tx_install::isTTF ( phpinfo = ''  ) 

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

Paramètres:
[type] $phpinfo: ...
Renvoie:
[type] ...

tx_install::isGD (  ) 

Renvoie:
[type] ...

tx_install::isGIF (  ) 

[Describe function...]

Renvoie:
[type] ...

tx_install::isJPG (  ) 

[Describe function...]

Renvoie:
[type] ...

tx_install::isPNG (  ) 

[Describe function...]

Renvoie:
[type] ...

tx_install::ImageTypes (  ) 

[Describe function...]

Renvoie:
[type] ...

tx_install::getGDSoftwareInfo (  ) 

Returns general information about GDlib

Renvoie:
[type] ...

tx_install::generallyAboutConfiguration (  ) 

Returns general information about configuration of TYPO3.

Renvoie:
[type] ...

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)

Renvoie:
[type] ...

tx_install::isExtensionEnabled ( ext,
headCode,
short 
)

[Describe function...]

Paramètres:
[type] $ext: ...
[type] $headCode: ...
[type] $short: ...
Renvoie:
[type] ...

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

[Describe function...]

Paramètres:
[type] $imageFile: ...
[type] $IMcommands: ...
[type] $note: ...
Renvoie:
[type] ...

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

[Describe function...]

Paramètres:
[type] $message: ...
[type] $label_1: ...
[type] $label_2: ...
Renvoie:
[type] ...

tx_install::formatImCmds ( arr  ) 

[Describe function...]

Paramètres:
[type] $arr: ...
Renvoie:
[type] ...

tx_install::imagemenu (  ) 

[Describe function...]

Renvoie:
[type] ...

tx_install::checkTheDatabase (  ) 

Renvoie:
[type] ...

tx_install::updateWizard (  ) 

Generates update wizard, outputs it as well

Renvoie:
void

tx_install::updateWizard_parts ( action  ) 

Implements the steps for the update wizard

Paramètres:
string action which should be done.
Renvoie:
void

tx_install::getUpgradeObjInstance ( className,
identifier 
)

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

Paramètres:
string class name
identifier identifier of upgrade object - needed to fetch user input
Renvoie:
object newly instanciated upgrade object

tx_install::isBackendAdminUser (  ) 

[Describe function...]

Renvoie:
[type] ...

tx_install::isStaticTemplates (  ) 

[Describe function...]

Renvoie:
[type] ...

tx_install::isBasicComplete ( tLabel  ) 

[Describe function...]

Paramètres:
[type] $tLabel: ...
Renvoie:
[type] ...

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

[Describe function...]

Paramètres:
[type] $type: ...
[type] $arr_update: ...
[type] $arr_remove: ...
[type] $action_type: ...
Renvoie:
[type] ...

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

[Describe function...]

Paramètres:
[type] $action_type: ...
[type] $content: ...
[type] $label: ...
Renvoie:
[type] ...

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

[Describe function...]

Paramètres:
[type] $arr: ...
[type] $pre: ...
[type] $label: ...
Renvoie:
[type] ...

tx_install::displayFieldComp ( arr,
arr_db 
)

[Describe function...]

Paramètres:
[type] $arr: ...
[type] $arr_db: ...
Renvoie:
[type] ...

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

[Describe function...]

Paramètres:
[type] $arr: ...
[type] $excludeList: ...
Renvoie:
[type] ...

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

Compares an array with field definitions with $TCA array

Paramètres:
[type] $FDsrc: ...
[type] $TCA: ...
[type] $onlyFields: ...
Renvoie:
[type] ...

tx_install::compareTCAandDatabase ( TCA,
FDcomp 
)

Compares the $TCA array with a field definition array

Paramètres:
[type] $TCA: ...
[type] $FDcomp: ...
Renvoie:
[type] ...

tx_install::suggestFieldDefinition ( fieldInfo  ) 

Suggests a field definition for a TCA config array.

Paramètres:
[type] $fieldInfo: ...
Renvoie:
[type] ...

tx_install::getItemArrayType ( arr  ) 

Private

Paramètres:
[type] $arr: ...
Renvoie:
[type] ...

tx_install::getItemBlobSize ( len  ) 

Private

Paramètres:
[type] $len: ...
Renvoie:
[type] ...

tx_install::suggestTCAFieldDefinition ( fieldName,
fieldInfo 
)

Should suggest a TCA configuration for a specific field.

Paramètres:
[type] $fieldName: ...
[type] $fieldInfo: ...
Renvoie:
[type] ...

tx_install::includeTCA (  ) 

Includes TCA

Renvoie:
[type] ...

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

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

Paramètres:
[type] $url: ...
[type] $link: ...
Renvoie:
[type] ...

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.

Paramètres:
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)
Renvoie:
void

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

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

Paramètres:
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
Renvoie:
void

tx_install::fw ( str,
size = 1 
)

Wraps the str in a font-tag with verdana 1

Paramètres:
[type] $str: ...
[type] $size: ...
Renvoie:
[type] ...

tx_install::fwheader ( str  ) 

Wraps the str in a font-tag with verdana 1

Paramètres:
[type] $str: ...
Renvoie:
[type] ...

tx_install::wrapInCells ( label,
content 
)

Wrapping labal/content in a table-row.

Paramètres:
[type] $label: ...
[type] $content: ...
Renvoie:
[type] ...

tx_install::printAll (  ) 

This prints all the messages in the ->section array

Renvoie:
[type] ...

tx_install::outputWrapper ( content  ) 

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

Paramètres:
[type] $content: ...
Renvoie:
[type] ...

tx_install::menu (  ) 

[Describe function...]

Renvoie:
[type] ...

tx_install::stepHeader (  ) 

[Describe function...]

Renvoie:
[type] ...

tx_install::note123 (  ) 

[Describe function...]

Renvoie:
[type] ...

tx_install::endNotes (  ) 

[Describe function...]

Renvoie:
[type] ...

tx_install::convertByteSize ( bytes  ) 

Convert a size from human-readable form into bytes

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

tx_install::securityRisk (  ) 

[Describe function...]

Renvoie:
[type] ...

tx_install::alterPasswordForm (  ) 

[Describe function...]

Renvoie:
[type] ...

tx_install::messageBasicFinished (  ) 

[Describe function...]

Renvoie:
[type] ...

tx_install::setScriptName ( type  ) 

[Describe function...]

Paramètres:
[type] $type: ...
Renvoie:
[type] ...

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

[Describe function...]

Paramètres:
[type] $size: ...
[type] $textarea: ...
[type] $styleOverride: ...
Renvoie:
[type] ...

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

[Describe function...]

Paramètres:
[type] $size: ...
[type] $styleOverride: ...
[type] $wrap: ...
Renvoie:
[type] ...

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.

Paramètres:
string Full path to a file
Renvoie:
string The name of the backup file (again, including the full path)


Documentation des données membres

tx_install::$getGD_start_string = '<h2 align="center"><a name="module_gd">gd</a></h2>'

tx_install::$getGD_end_string = '</table>'

tx_install::$getTTF_string = 'with TTF library'

tx_install::$getTTF_string_alt = 'with freetype'

tx_install::$action = ''

tx_install::$scriptSelf = 'index.php'

tx_install::$fontTag2 = '<span class="bodytext">'

tx_install::$fontTag1 = '<span class="smalltext">'

tx_install::$updateIdentity = 'TYPO3 Install Tool'

Réimplémentée à partir de t3lib_install.

tx_install::$headerStyle = ''

tx_install::$contentBeforeTable = ''

tx_install::$setAllCheckBoxesByDefault = 0

tx_install::$allowFileEditOutsite_typo3conf_dir = 0

tx_install::$INSTALL = array()

tx_install::$checkIMlzw = 0

tx_install::$checkIM = 0

tx_install::$dumpImCommands = 1

tx_install::$mode = ''

tx_install::$step = 0

tx_install::$passwordOK = 0

tx_install::$silent = 1

tx_install::$messageFunc_nl2br = 1

tx_install::$sections = array()

tx_install::$fatalError = 0

tx_install::$sendNoCacheHeaders = 1

tx_install::$config_array

Valeur initiale :

 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
        )

tx_install::$typo3temp_path = ''

tx_install::$menuitems

Valeur initiale :

 array(
                'config' => 'Basic Configuration',
                'database' => 'Database Analyser',
                'update' => 'Update Wizard',
                'images' => 'Image Processing',
                'extConfig' => 'All Configuration',
                'typo3temp' => 'typo3temp/',
                'cleanup' => 'Clean up database',
                'phpinfo' => 'phpinfo()',
                'typo3conf_edit' => 'Edit files in typo3conf/',
                'about' => 'About'
        )

tx_install::$cookie_name = 'Typo3InstallTool'

tx_install::$JSmessage = ''


La documentation de cette classe a été générée à partir du fichier suivant :
Généré le Fri Aug 31 11:43:55 2007 pour OBLADY - Typo3 API v4.1.2 par  doxygen 1.5.3