Solutions Open Source

Référence de la classe t3lib_install

Graphe d'héritage de t3lib_install:

Inheritance graph
[légende]

Liste de tous les membres

Fonctions membres publiques

 t3lib_install ()
 setValueInLocalconfFile (&$line_array, $variable, $value)
 writeToLocalconf_control ($inlines='', $absFullPath='')
 checkForBadString ($string)
 slashValueForSingleDashes ($value)
 getFieldDefinitions_sqlContent ($sqlContent)
 getFieldDefinitions_sqlContent_parseTypes (&$total)
 getFieldDefinitions_database ()
 getDatabaseExtra ($FDsrc, $FDcomp, $onlyTableList='', $ignoreNotNullWhenComparing=true)
 getUpdateSuggestions ($diffArr, $keyList='extra, diff')
 assembleFieldDefinition ($row)
 getStatementArray ($sqlcode, $removeNonSQL=0, $query_regex='')
 getCreateTables ($statements, $insertCountFlag=0)
 getTableInsertStatements ($statements, $table)
 performUpdateQueries ($arr, $keyArr)
 getListOfTables ()
 generateUpdateDatabaseForm_checkboxes ($arr, $label, $checked=1, $iconDis=0, $currentValue=array(), $cVfullMsg=0)

Attributs publics

 $updateIdentity = ''
 $deletedPrefixKey = 'zzz_deleted_'
 $dbUpdateCheckboxPrefix = 'TYPO3_INSTALL[database_update]'
 $localconf_addLinesOnly = 0
 $localconf_editPointToken = 'INSTALL SCRIPT EDIT POINT TOKEN - all lines after this points may be changed by the install script!'
 $allowUpdateLocalConf = 0
 $backPath = '../'
 $multiplySize = 1
 $setLocalconf = 0
 $messages = array()
 $touchedLine = 0


Documentation des fonctions membres

t3lib_install::t3lib_install (  ) 

Constructor function

Renvoie:
void

t3lib_install::setValueInLocalconfFile ( &$  line_array,
variable,
value 
)

This functions takes an array with lines from localconf.php, finds a variable and inserts the new value.

Paramètres:
array $line_array the localconf.php file exploded into an array by linebreaks. (see writeToLocalconf_control())
string $variable The variable name to find and substitute. This string must match the first part of a trimmed line in the line-array. Matching is done backwards so the last appearing line will be substituted.
string $value Is the value to be insert for the variable
Renvoie:
void
Voir également:
writeToLocalconf_control()

t3lib_install::writeToLocalconf_control ( inlines = '',
absFullPath = '' 
)

Writes or returns lines from localconf.php

Paramètres:
array Array of lines to write back to localconf.php. Possibly
string Absolute path of alternative file to use (Notice: this path is not validated in terms of being inside 'TYPO3 space')
Renvoie:
mixed If $inlines 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:
setValueInLocalconfFile()

Réimplémentée dans tx_install.

t3lib_install::checkForBadString ( string  ) 

Checking for linebreaks in the string

Paramètres:
string String to test
Renvoie:
boolean Returns TRUE if string is OK
Voir également:
setValueInLocalconfFile()

t3lib_install::slashValueForSingleDashes ( value  ) 

Replaces ' with \' and \ with \

Paramètres:
string Input value
Renvoie:
string Output value
Voir également:
setValueInLocalconfFile()

t3lib_install::getFieldDefinitions_sqlContent ( sqlContent  ) 

Reads the field definitions for the input sql-file string

Paramètres:
string $sqlContent: Should be a string read from an sql-file made with 'mysqldump [database_name] -d'
Renvoie:
array Array with information about table.

t3lib_install::getFieldDefinitions_sqlContent_parseTypes ( &$  total  ) 

Multiplies varchars/tinytext fields in size according to $this->multiplySize Useful if you want to use UTF-8 in the database and needs to extend the field sizes in the database so UTF-8 chars are not discarded. For most charsets available as single byte sets, multiplication with 2 should be enough. For chinese, use 3.

Paramètres:
array Total array (from getFieldDefinitions_sqlContent())
Renvoie:
void private
Voir également:
getFieldDefinitions_sqlContent()

t3lib_install::getFieldDefinitions_database (  ) 

Reads the field definitions for the current database

Renvoie:
array Array with information about table.

t3lib_install::getDatabaseExtra ( FDsrc,
FDcomp,
onlyTableList = '',
ignoreNotNullWhenComparing = true 
)

Compares two arrays with field information and returns information about fields that are MISSING and fields that have CHANGED. FDsrc and FDcomp can be switched if you want the list of stuff to remove rather than update.

Paramètres:
array Field definitions, source (from getFieldDefinitions_sqlContent())
array Field definitions, comparison. (from getFieldDefinitions_database())
string Table names (in list) which is the ONLY one observed.
boolean If set, this function ignores NOT NULL statements of the sql file field definition when comparing current field definition from database with field definition from sql file. This way, NOT NULL statements will be executed when the field is initially created, but the sql parser will never complain about missing NOT NULL statements afterwards.
Renvoie:
array Returns an array with 1) all elements from $FSsrc that is not in $FDcomp (in key 'extra') and 2) all elements from $FSsrc that is difference from the ones in $FDcomp

t3lib_install::getUpdateSuggestions ( diffArr,
keyList = 'extra,
diff'   
)

Returns an array with SQL-statements that is needed to update according to the diff-array

Paramètres:
array Array with differences of current and needed DB settings. (from getDatabaseExtra())
string List of fields in diff array to take notice of.
Renvoie:
array Array of SQL statements (organized in keys depending on type)

t3lib_install::assembleFieldDefinition ( row  ) 

Converts a result row with field information into the SQL field definition string

Paramètres:
array MySQL result row.
Renvoie:
string Field definition

t3lib_install::getStatementArray ( sqlcode,
removeNonSQL = 0,
query_regex = '' 
)

Returns an array where every entry is a single sql-statement. Input must be formatted like an ordinary MySQL-dump files

Paramètres:
string $sqlcode The sql-file content. Provided that 1) every query in the input is ended with ';' and that a line in the file contains only one query or a part of a query.
boolean If set, non-sql (like comments and blank lines) are not included in the final product)
string Regex to filter SQL lines to include.
Renvoie:
array Array of SQL statements.

t3lib_install::getCreateTables ( statements,
insertCountFlag = 0 
)

Returns tables to create and how many records in each

Paramètres:
array Array of SQL statements to analyse.
boolean If set, will count number of INSERT INTO statements following that table definition
Renvoie:
array Array with table definitions in index 0 and count in index 1

t3lib_install::getTableInsertStatements ( statements,
table 
)

Extracts all insert statements from $statement array where content is inserted into $table

Paramètres:
array Array of SQL statements
string Table name
Renvoie:
array Array of INSERT INTO statements where table match $table

t3lib_install::performUpdateQueries ( arr,
keyArr 
)

Performs the queries passed from the input array.

Paramètres:
array Array of SQL queries to execute.
array Array with keys that must match keys in $arr. Only where a key in this array is set and true will the query be executed (meant to be passed from a form checkbox)
Renvoie:
void

t3lib_install::getListOfTables (  ) 

Returns list of tables in the database

Renvoie:
array List of tables.
Voir également:
t3lib_db::admin_get_tables()

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

Creates a table which checkboxes for updating database.

Paramètres:
array Array of statements (key / value pairs where key is used for the checkboxes)
string Label for the table.
boolean If set, then checkboxes are set by default.
boolean If set, then icons are shown.
array Array of "current values" for each key/value pair in $arr. Shown if given.
boolean If set, will show the prefix "Current value" if $currentValue is given.
Renvoie:
string HTML table with checkboxes for update. Must be wrapped in a form.


Documentation des données membres

t3lib_install::$updateIdentity = ''

Réimplémentée dans tx_install.

t3lib_install::$deletedPrefixKey = 'zzz_deleted_'

t3lib_install::$dbUpdateCheckboxPrefix = 'TYPO3_INSTALL[database_update]'

t3lib_install::$localconf_addLinesOnly = 0

t3lib_install::$localconf_editPointToken = 'INSTALL SCRIPT EDIT POINT TOKEN - all lines after this points may be changed by the install script!'

t3lib_install::$allowUpdateLocalConf = 0

t3lib_install::$backPath = '../'

t3lib_install::$multiplySize = 1

t3lib_install::$setLocalconf = 0

t3lib_install::$messages = array()

t3lib_install::$touchedLine = 0


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