[TASK] Clean up phpDoc comments in t3lib classes
authorWouter Wolters <typo3@wouterwolters.nl>
Sun, 13 May 2012 12:10:44 +0000 (14:10 +0200)
committerChristian Kuhn <lolli@schwarzbu.ch>
Wed, 16 May 2012 07:54:56 +0000 (09:54 +0200)
Clean up phpDoc comments for the following classes:

* t3lib/class.t3lib_formmail.php
* t3lib/class.t3lib_frontendedit.php
* t3lib/class.t3lib_iconworks.php
* t3lib/class.t3lib_install.php

Clean up provides:

* Provide correct parameter names in phpDoc
* Provide correct data types in phpDoc
* CGLify phpDoc (remove tabs)

Change-Id: I48a245d96f760c8957bebc8970cbe76446287084
Resolves: #37137
Releases: 6.0
Reviewed-on: http://review.typo3.org/11154
Reviewed-by: Oliver Klee
Reviewed-by: Christian Kuhn
Tested-by: Christian Kuhn
t3lib/class.t3lib_formmail.php
t3lib/class.t3lib_frontendedit.php
t3lib/class.t3lib_iconworks.php
t3lib/class.t3lib_install.php

index edd0ebe..8d18757 100644 (file)
  *
  * Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
-
 /**
  * Formmail class, used by the TYPO3 "cms" extension (default frontend) to send email forms.
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage t3lib
  * @see tslib_fe::sendFormmail(), t3lib/formmail.php
  */
 class t3lib_formmail {
        protected $reserved_names = 'recipient,recipient_copy,auto_respond_msg,auto_respond_checksum,redirect,subject,attachment,from_email,from_name,replyto_email,replyto_name,organisation,priority,html_enabled,quoted_printable,submit_x,submit_y';
-       protected $dirtyHeaders = array(); // collection of suspicious header data, used for logging
+               // Collection of suspicious header data, used for logging
+       protected $dirtyHeaders = array();
 
        protected $characterSet;
        protected $subject;
@@ -82,9 +82,9 @@ class t3lib_formmail {
         * [html_enabled]:              If mail is sent as html
         * [use_base64]:                If set, base64 encoding will be used instead of quoted-printable
         *
-        * @param       array           Contains values for the field names listed above (with slashes removed if from POST input)
-        * @param       boolean         Whether to base64 encode the mail content
-        * @return      void
+        * @param array $valueList Contains values for the field names listed above (with slashes removed if from POST input)
+        * @param boolean $base64 Whether to base64 encode the mail content
+        * @return void
         */
        function start($valueList, $base64 = FALSE) {
 
@@ -106,7 +106,7 @@ class t3lib_formmail {
                }
 
                if (isset($valueList['recipient'])) {
-                               // convert form data from renderCharset to mail charset
+                               // Convert form data from renderCharset to mail charset
                        $this->subject = ($valueList['subject'])
                                        ? $valueList['subject']
                                        : 'Formmail on ' . t3lib_div::getIndpEnv('HTTP_HOST');
@@ -135,7 +135,7 @@ class t3lib_formmail {
 
                        $this->priority = ($valueList['priority']) ? t3lib_utility_Math::forceIntegerInRange($valueList['priority'], 1, 5) : 3;
 
-                               // auto responder
+                               // Auto responder
                        $this->autoRespondMessage = (trim($valueList['auto_respond_msg']) && $this->fromAddress)
                                        ? trim($valueList['auto_respond_msg'])
                                        : '';
@@ -164,7 +164,7 @@ class t3lib_formmail {
                                                $space = (strlen($val) > 60) ? LF : '';
                                                $val = (is_array($val) ? implode($val, LF) : $val);
 
-                                                       // convert form data from renderCharset to mail charset (HTML may use entities)
+                                                       // Convert form data from renderCharset to mail charset (HTML may use entities)
                                                $plainTextValue = $val;
                                                $HtmlValue = htmlspecialchars($val);
 
@@ -228,7 +228,7 @@ class t3lib_formmail {
                                // Ignore target encoding. This is handled automatically by Swift Mailer and overriding the defaults
                                // is not worth the trouble
 
-                               // log dirty header lines
+                               // Log dirty header lines
                        if ($this->dirtyHeaders) {
                                t3lib_div::sysLog('Possible misuse of t3lib_formmail: see TYPO3 devLog', 'Core', 3);
                                if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['enable_DLOG']) {
@@ -241,8 +241,8 @@ class t3lib_formmail {
        /**
         * Checks string for suspicious characters
         *
-        * @param       string  String to check
-        * @return      string  Valid or empty string
+        * @param string $string String to check
+        * @return string Valid or empty string
         */
        protected function sanitizeHeaderString($string) {
                $pattern = '/[\r\n\f\e]/';
@@ -271,10 +271,10 @@ class t3lib_formmail {
                $addressList = array();
                foreach ($addresses as $address) {
                        if ($address->personal) {
-                               // item with name found ( name <email@example.org> )
+                               // Item with name found ( name <email@example.org> )
                                $addressList[$address->mailbox . '@' . $address->host] = $address->personal;
                        } else {
-                               // item without name found ( email@example.org )
+                               // Item without name found ( email@example.org )
                                $addressList[] = $address->mailbox . '@' . $address->host;
                        }
                }
index ae08c4a..1e2002f 100644 (file)
@@ -28,8 +28,8 @@
 /**
  * Controller class for frontend editing.
  *
- * @author     Jeff Segars <jeff@webempoweredchurch.org>
- * @author     David Slayback <dave@webempoweredchurch.org>
+ * @author Jeff Segars <jeff@webempoweredchurch.org>
+ * @author David Slayback <dave@webempoweredchurch.org>
  * @package TYPO3
  * @subpackage t3lib
  */
@@ -52,7 +52,7 @@ class t3lib_frontendedit {
        /**
         * Initializes configuration options.
         *
-        * @return      void
+        * @return void
         */
        public function initConfigOptions() {
                $this->TSFE_EDIT = t3lib_div::_GP('TSFE_EDIT');
@@ -71,11 +71,11 @@ class t3lib_frontendedit {
         * With the "edit panel" the user will see buttons with links to editing, moving, hiding, deleting the element
         * This function is used for the cObject EDITPANEL and the stdWrap property ".editPanel"
         *
-        * @param       string          A content string containing the content related to the edit panel. For cObject "EDITPANEL" this is empty but not so for the stdWrap property. The edit panel is appended to this string and returned.
-        * @param       array           TypoScript configuration properties for the editPanel
-        * @param       string          The "table:uid" of the record being shown. If empty string then $this->currentRecord is used. For new records (set by $conf['newRecordFromTable']) it's auto-generated to "[tablename]:NEW"
-        * @param       array           Alternative data array to use. Default is $this->data
-        * @return      string          The input content string with the editPanel appended. This function returns only an edit panel appended to the content string if a backend user is logged in (and has the correct permissions). Otherwise the content string is directly returned.
+        * @param string $content A content string containing the content related to the edit panel. For cObject "EDITPANEL" this is empty but not so for the stdWrap property. The edit panel is appended to this string and returned.
+        * @param array $conf TypoScript configuration properties for the editPanel
+        * @param string $currentRecord The "table:uid" of the record being shown. If empty string then $this->currentRecord is used. For new records (set by $conf['newRecordFromTable']) it's auto-generated to "[tablename]:NEW"
+        * @param array $dataArray Alternative data array to use. Default is $this->data
+        * @return string The input content string with the editPanel appended. This function returns only an edit panel appended to the content string if a backend user is logged in (and has the correct permissions). Otherwise the content string is directly returned.
         */
        public function displayEditPanel($content, array $conf, $currentRecord, array $dataArray) {
                if ($conf['newRecordFromTable']) {
@@ -123,15 +123,14 @@ class t3lib_frontendedit {
         * Adds an edit icon to the content string. The edit icon links to alt_doc.php with proper parameters for editing the table/fields of the context.
         * This implements TYPO3 context sensitive editing facilities. Only backend users will have access (if properly configured as well).
         *
-        * @param       string          The content to which the edit icons should be appended
-        * @param       string          The parameters defining which table and fields to edit. Syntax is [tablename]:[fieldname],[fieldname],[fieldname],... OR [fieldname],[fieldname],[fieldname],... (basically "[tablename]:" is optional, default table is the one of the "current record" used in the function). The fieldlist is sent as "&columnsOnly=" parameter to alt_doc.php
-        * @param       array           TypoScript properties for configuring the edit icons.
-        * @param       string          The "table:uid" of the record being shown. If empty string then $this->currentRecord is used. For new records (set by $conf['newRecordFromTable']) it's auto-generated to "[tablename]:NEW"
-        * @param       array           Alternative data array to use. Default is $this->data
-        * @param       string          Additional URL parameters for the link pointing to alt_doc.php
-        * @return      string          The input content string, possibly with edit icons added (not necessarily in the end but just after the last string of normal content.
+        * @param string $content The content to which the edit icons should be appended
+        * @param string $params The parameters defining which table and fields to edit. Syntax is [tablename]:[fieldname],[fieldname],[fieldname],... OR [fieldname],[fieldname],[fieldname],... (basically "[tablename]:" is optional, default table is the one of the "current record" used in the function). The fieldlist is sent as "&columnsOnly=" parameter to alt_doc.php
+        * @param array $conf TypoScript properties for configuring the edit icons.
+        * @param string $currentRecord The "table:uid" of the record being shown. If empty string then $this->currentRecord is used. For new records (set by $conf['newRecordFromTable']) it's auto-generated to "[tablename]:NEW"
+        * @param array $dataArray Alternative data array to use. Default is $this->data
+        * @param string $addUrlParamStr Additional URL parameters for the link pointing to alt_doc.php
+        * @return string The input content string, possibly with edit icons added (not necessarily in the end but just after the last string of normal content.
         */
-
        public function displayEditIcons($content, $params, array $conf = array(), $currentRecord = '', array $dataArray = array(), $addUrlParamStr = '') {
                        // Check incoming params:
                list($currentRecordTable, $currentRecordUID) = explode(':', $currentRecord);
@@ -139,7 +138,8 @@ class t3lib_frontendedit {
                if (!$table) {
                        $table = $currentRecordTable;
                } elseif ($table != $currentRecordTable) {
-                       return $content; // If the table is set as the first parameter, and does not match the table of the current record, then just return.
+                               // If the table is set as the first parameter, and does not match the table of the current record, then just return.
+                       return $content;
                }
 
                $editUid = $dataArray['_LOCALIZED_UID'] ? $dataArray['_LOCALIZED_UID'] : $currentRecordUID;
@@ -171,8 +171,8 @@ class t3lib_frontendedit {
        /**
         * Returns TRUE if an edit-action is sent from the Admin Panel
         *
-        * @return      boolean
-        * @see index_ts.php
+        * @return boolean
+        * @see index_ts.php
         */
        public function isEditAction() {
                if (is_array($this->TSFE_EDIT)) {
@@ -193,8 +193,8 @@ class t3lib_frontendedit {
         * Returns TRUE if an edit form is shown on the page.
         * Used from index_ts.php where a TRUE return-value will result in classes etc. being included.
         *
-        * @return      boolean
-        * @see index_ts.php
+        * @return boolean
+        * @see index_ts.php
         */
        public function isEditFormShown() {
                if (is_array($this->TSFE_EDIT)) {
@@ -209,12 +209,12 @@ class t3lib_frontendedit {
         * Management of the on-page frontend editing forms and edit panels.
         * Basically taking in the data and commands and passes them on to the proper classes as they should be.
         *
-        * @return      void
+        * @return void
         * @throws UnexpectedValueException if TSFE_EDIT[cmd] is not a valid command
-        * @see index_ts.php
+        * @see index_ts.php
         */
        public function editAction() {
-                       // Commands:
+                       // Commands
                list($table, $uid) = explode(':', $this->TSFE_EDIT['record']);
                $uid = intval($uid);
                $cmd = $this->TSFE_EDIT['cmd'];
@@ -249,9 +249,9 @@ class t3lib_frontendedit {
        /**
         * Hides a specific record.
         *
-        * @param       string          The table name for the record to hide.
-        * @param       integer         The UID for the record to hide.
-        * @return      void
+        * @param string $table The table name for the record to hide.
+        * @param integer $uid The UID for the record to hide.
+        * @return void
         */
        public function doHide($table, $uid) {
                $hideField = $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['disabled'];
@@ -268,9 +268,9 @@ class t3lib_frontendedit {
        /**
         * Unhides (shows) a specific record.
         *
-        * @param       string          The table name for the record to unhide.
-        * @param       integer         The UID for the record to unhide.
-        * @return      void
+        * @param string $table The table name for the record to unhide.
+        * @param integer $uid The UID for the record to unhide.
+        * @return void
         */
        public function doUnhide($table, $uid) {
                $hideField = $GLOBALS['TCA'][$table]['ctrl']['enablecolumns']['disabled'];
@@ -287,9 +287,9 @@ class t3lib_frontendedit {
        /**
         * Moves a record up.
         *
-        * @param       string          The table name for the record to move.
-        * @param       integer         The UID for the record to hide.
-        * @return      void
+        * @param string $table The table name for the record to move.
+        * @param integer $uid The UID for the record to hide.
+        * @return void
         */
        public function doUp($table, $uid) {
                $this->move($table, $uid, 'up');
@@ -298,9 +298,9 @@ class t3lib_frontendedit {
        /**
         * Moves a record down.
         *
-        * @param       string          The table name for the record to move.
-        * @param       integer         The UID for the record to move.
-        * @return      void
+        * @param string $table The table name for the record to move.
+        * @param integer $uid The UID for the record to move.
+        * @return void
         */
        public function doDown($table, $uid) {
                $this->move($table, $uid, 'down');
@@ -309,9 +309,9 @@ class t3lib_frontendedit {
        /**
         * Moves a record after a given element. Used for drag.
         *
-        * @param       string          The table name for the record to move.
-        * @param       integer         The UID for the record to move.
-        * @return      void
+        * @param string $table The table name for the record to move.
+        * @param integer $uid The UID for the record to move.
+        * @return void
         */
        public function doMoveAfter($table, $uid) {
                $afterUID = $GLOBALS['BE_USER']->frontendEdit->TSFE_EDIT['moveAfter'];
@@ -321,21 +321,21 @@ class t3lib_frontendedit {
        /**
         * Moves a record
         *
-        * @param       string          The table name for the record to move.
-        * @param       integer         The UID for the record to move.
-        * @param       string          The direction to move, either 'up' or 'down'.
-        * @param       integer         The UID of record to move after. This is specified for dragging only.
-        * @return      void
+        * @param string $table The table name for the record to move.
+        * @param integer $uid The UID for the record to move.
+        * @param string $direction The direction to move, either 'up' or 'down'.
+        * @param integer $afterUID The UID of record to move after. This is specified for dragging only.
+        * @return void
         */
        protected function move($table, $uid, $direction = '', $afterUID = 0) {
                $cmdData = array();
                $sortField = $GLOBALS['TCA'][$table]['ctrl']['sortby'];
                if ($sortField) {
-                               // Get self:
+                               // Get self
                        $fields = array_unique(t3lib_div::trimExplode(',', $GLOBALS['TCA'][$table]['ctrl']['copyAfterDuplFields'] . ',uid,pid,' . $sortField, TRUE));
                        $res = $GLOBALS['TYPO3_DB']->exec_SELECTquery(implode(',', $fields), $table, 'uid=' . $uid);
                        if ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) {
-                                       // record before or after
+                                       // Record before or after
                                if (($GLOBALS['BE_USER']->adminPanel instanceOf tslib_AdminPanel) && ($GLOBALS['BE_USER']->adminPanel->extGetFeAdminValue('preview'))) {
                                        $ignore = array('starttime' => 1, 'endtime' => 1, 'disabled' => 1, 'fe_group' => 1);
                                }
@@ -395,9 +395,9 @@ class t3lib_frontendedit {
        /**
         * Deletes a specific record.
         *
-        * @param       string          The table name for the record to delete.
-        * @param       integer         The UID for the record to delete.
-        * @return      void
+        * @param string $table The table name for the record to delete.
+        * @param integer $uid The UID for the record to delete.
+        * @return void
         */
        public function doDelete($table, $uid) {
                $cmdData[$table][$uid]['delete'] = 1;
@@ -411,9 +411,9 @@ class t3lib_frontendedit {
        /**
         * Saves a record based on its data array.
         *
-        * @param       string          The table name for the record to save.
-        * @param       integer         The UID for the record to save.
-        * @return      void
+        * @param string $table The table name for the record to save.
+        * @param integer $uid The UID for the record to save.
+        * @return void
         */
        public function doSave($table, $uid) {
                $data = $this->TSFE_EDIT['data'];
@@ -435,9 +435,9 @@ class t3lib_frontendedit {
        /**
         * Saves a record based on its data array and closes it.
         *
-        * @param       string          The table name for the record to save.
-        * @param       integer         The UID for the record to save.
-        * @return      void
+        * @param string $table The table name for the record to save.
+        * @param integer $uid The UID for the record to save.
+        * @return void
         * @note        This method is only a wrapper for doSave() but is needed so
         *                      that frontend editing views can handle "save" differently from
         *                      "save and close".
@@ -449,14 +449,13 @@ class t3lib_frontendedit {
                $this->doSave($table, $uid);
        }
 
-
        /**
         * Stub for closing a record. No real functionality needed since content
         * element rendering will take care of everything.
         *
-        * @param       string          The table name for the record to close.
-        * @param       integer         The UID for the record to close.
-        * @return      void
+        * @param string $table The table name for the record to close.
+        * @param integer $uid The UID for the record to close.
+        * @return void
         */
        public function doClose($table, $uid) {
                // Do nothing.
@@ -466,9 +465,9 @@ class t3lib_frontendedit {
         * Checks whether the user has access to edit the language for the
         * requested record.
         *
-        * @param       string          The name of the table.
-        * @param       array           The record.
-        * @return      boolean
+        * @param string $table The name of the table.
+        * @param array $currentRecord The record.
+        * @return boolean
         */
        protected function allowedToEditLanguage($table, array $currentRecord) {
                        // If no access right to record languages, return immediately
@@ -494,12 +493,12 @@ class t3lib_frontendedit {
        /**
         * Checks whether the user is allowed to edit the requested table.
         *
-        * @param       string  The name of the table.
-        * @param       array   The data array.
-        * @param       array   The configuration array for the edit panel.
-        * @param       boolean Boolean indicating whether recordEditAccessInternals should not be checked. Defaults
+        * @param string $table The name of the table.
+        * @param array $dataArray The data array.
+        * @param array $conf The configuration array for the edit panel.
+        * @param boolean $checkEditAccessInternals Boolean indicating whether recordEditAccessInternals should not be checked. Defaults
         *                                       to TRUE but doesn't makes sense when creating new records on a page.
-        * @return      boolean
+        * @return boolean
         */
        protected function allowedToEdit($table, array $dataArray, array $conf, $checkEditAccessInternals = TRUE) {
 
@@ -550,11 +549,11 @@ class t3lib_frontendedit {
        /**
         * Takes an array of generally allowed actions and filters that list based on page and content permissions.
         *
-        * @param       string  The name of the table.
-        * @param       array   The configuration array.
-        * @param       integer The PID where editing will occur.
-        * @param       string  Comma-separated list of actions that are allowed in general.
-        * @return      array
+        * @param string $table The name of the table.
+        * @param array $conf The configuration array.
+        * @param integer $pid The PID where editing will occur.
+        * @param string $allow Comma-separated list of actions that are allowed in general.
+        * @return array
         */
        protected function getAllowedEditActions($table, array $conf, $pid, $allow = '') {
 
@@ -564,13 +563,13 @@ class t3lib_frontendedit {
                }
 
                if (!$conf['onlyCurrentPid'] || $pid == $GLOBALS['TSFE']->id) {
-                               // Permissions:
+                               // Permissions
                        $types = t3lib_div::trimExplode(',', t3lib_div::strtolower($conf['allow']), TRUE);
                        $allow = array_flip($types);
 
                        $perms = $GLOBALS['BE_USER']->calcPerms($GLOBALS['TSFE']->page);
                        if ($table == 'pages') {
-                                       // rootpage!
+                                       // Rootpage
                                if (count($GLOBALS['TSFE']->config['rootLine']) == 1) {
                                        unset($allow['move']);
                                        unset($allow['hide']);
@@ -596,8 +595,7 @@ class t3lib_frontendedit {
        /**
         * Adds any extra Javascript includes needed for Front-end editing
         *
-        * @param       none
-        * @return      string
+        * @return string
         */
        public function getJavascriptIncludes() {
                        // No extra JS includes needed
@@ -608,8 +606,8 @@ class t3lib_frontendedit {
         * Gets the hidden fields (array key=field name, value=field value) to be used in the edit panel for a particular content element.
         * In the normal case, no hidden fields are needed but special controllers such as TemplaVoila need to track flexform pointers, etc.
         *
-        * @param       array   The data array for a specific content element.
-        * @return      array
+        * @param array $dataArray The data array for a specific content element.
+        * @return array
         */
        public function getHiddenFields(array $dataArray) {
                        // No special hidden fields needed.
@@ -619,7 +617,7 @@ class t3lib_frontendedit {
        /**
         * Initializes t3lib_TCEmain since it is used on modification actions.
         *
-        * @return      void
+        * @return void
         */
        protected function initializeTceMain() {
                if (!isset($this->tce)) {
index 33417d9..0bd724c 100644 (file)
@@ -116,12 +116,12 @@ final class t3lib_iconWorks {
         * Returns an icon image tag, 18x16 pixels, based on input information.
         * This function is recommended to use in your backend modules.
         *
-        * @param       string          The table name
-        * @param       array           The table row ("enablefields" are at least needed for correct icon display and for pages records some more fields in addition!)
-        * @param       string          The backpath to the main TYPO3 directory (relative path back to PATH_typo3)
-        * @param       string          Additional attributes for the image tag
-        * @param       boolean         If set, the icon will be grayed/shaded
-        * @return      string          <img>-tag
+        * @param string $table The table name
+        * @param array $row The table row ("enablefields" are at least needed for correct icon display and for pages records some more fields in addition!)
+        * @param string $backPath The backpath to the main TYPO3 directory (relative path back to PATH_typo3)
+        * @param string $params Additional attributes for the image tag
+        * @param boolean $shaded If set, the icon will be grayed/shaded
+        * @return string <img>-tag
         * @see getIcon()
         */
        public static function getIconImage($table, $row = array(), $backPath, $params = '', $shaded = FALSE) {
@@ -139,17 +139,19 @@ final class t3lib_iconWorks {
         * Creates the icon for input table/row
         * Returns filename for the image icon, relative to PATH_typo3
         *
-        * @param       string          The table name
-        * @param       array           The table row ("enablefields" are at least needed for correct icon display and for pages records some more fields in addition!)
-        * @param       boolean         If set, the icon will be grayed/shaded
-        * @return      string          Icon filename
+        * @param string $table The table name
+        * @param array $row The table row ("enablefields" are at least needed for correct icon display and for pages records some more fields in addition!)
+        * @param boolean $shaded If set, the icon will be grayed/shaded
+        * @return string Icon filename
         * @see getIconImage()
         */
        public static function getIcon($table, $row = array(), $shaded = FALSE) {
-                       // Flags:
-               $doNotRenderUserGroupNumber = TRUE; // If set, then the usergroup number will NOT be printed unto the icon. NOTICE. the icon is generated only if a default icon for groups is not found... So effectively this is ineffective...
+                       // Flags
+                       // If set, then the usergroup number will NOT be printed unto the icon. NOTICE.
+                       // The icon is generated only if a default icon for groups is not found... So effectively this is ineffective.
+               $doNotRenderUserGroupNumber = TRUE;
 
-                       // Shadow:
+                       // Shadow
                if ($GLOBALS['TCA'][$table]['ctrl']['versioningWS']) {
                        switch ((int) $row['t3ver_state']) {
                                case 1:
@@ -195,9 +197,11 @@ final class t3lib_iconWorks {
                $hidden = FALSE;
                $timing = FALSE;
                $futuretiming = FALSE;
-               $user = FALSE; // In fact an integer value...
+                       // In fact an integer value
+               $user = FALSE;
                $deleted = FALSE;
-               $protectSection = FALSE; // Set, if a page-record (only pages!) has the extend-to-subpages flag set.
+                       // Set, if a page-record (only pages!) has the extend-to-subpages flag set.
+               $protectSection = FALSE;
                $noIconFound = $row['_NO_ICON_FOUND'] ? TRUE : FALSE;
                        // + $shaded which is also boolean!
 
@@ -214,7 +218,7 @@ final class t3lib_iconWorks {
                        if ($enCols['starttime']) {
                                if ($GLOBALS['EXEC_TIME'] < intval($row[$enCols['starttime']])) {
                                        $timing = TRUE;
-                                               // ...And if "endtime" is NOT set:
+                                               // And if "endtime" is NOT set:
                                        if (intval($row[$enCols['endtime']]) == 0) {
                                                $futuretiming = TRUE;
                                        }
@@ -224,9 +228,11 @@ final class t3lib_iconWorks {
                        if ($enCols['endtime']) {
                                if (intval($row[$enCols['endtime']]) > 0) {
                                        if (intval($row[$enCols['endtime']]) < $GLOBALS['EXEC_TIME']) {
-                                               $timing = TRUE; // End-timing applies at this point.
+                                                       // End-timing applies at this point.
+                                               $timing = TRUE;
                                        } else {
-                                               $futuretiming = TRUE; // End-timing WILL apply in the future for this element.
+                                                       // End-timing WILL apply in the future for this element.
+                                               $futuretiming = TRUE;
                                        }
                                }
                        }
@@ -297,11 +303,11 @@ final class t3lib_iconWorks {
         * Returns the src=... for the input $src value OR any alternative found in $TBE_STYLES['skinImg']
         * Used for skinning the TYPO3 backend with an alternative set of icons
         *
-        * @param       string          Current backpath to PATH_typo3 folder
-        * @param       string          Icon file name relative to PATH_typo3 folder
-        * @param       string          Default width/height, defined like 'width="12" height="14"'
-        * @param       integer         Mode: 0 (zero) is default and returns src/width/height. 1 returns value of src+backpath, 2 returns value of w/h.
-        * @return      string          Returns ' src="[backPath][src]" [wHattribs]'
+        * @param string $backPath Current backpath to PATH_typo3 folder
+        * @param string $src Icon file name relative to PATH_typo3 folder
+        * @param string $wHattribs Default width/height, defined like 'width="12" height="14"'
+        * @param integer $outputMode Mode: 0 (zero) is default and returns src/width/height. 1 returns value of src+backpath, 2 returns value of w/h.
+        * @return string Returns ' src="[backPath][src]" [wHattribs]'
         * @see skinImgFile()
         */
        public static function skinImg($backPath, $src, $wHattribs = '', $outputMode = 0) {
@@ -315,7 +321,6 @@ final class t3lib_iconWorks {
                }
                        // Setting source key. If the icon is refered to inside an extension, we homogenize the prefix to "ext/":
                $srcKey = preg_replace('/^(\.\.\/typo3conf\/ext|sysext|ext)\//', 'ext/', $src);
-               #if ($src!=$srcKey)debug(array($src, $srcKey));
 
                        // LOOKING for alternative icons:
                if ($GLOBALS['TBE_STYLES']['skinImg'][$srcKey]) { // Slower or faster with is_array()? Could be used.
@@ -328,7 +333,7 @@ final class t3lib_iconWorks {
                        $lookUpName = ($fExt ? preg_replace('/\.[[:alnum:]]+$/', '', $srcKey) . '.' . $fExt : $srcKey); // Set filename to look for
 
                        if ($fExt && !@is_file($GLOBALS['TBE_STYLES']['skinImgAutoCfg']['absDir'] . $lookUpName)) {
-                                       // fallback to original filename if icon with forced extension doesn't exists
+                                       // Fallback to original filename if icon with forced extension doesn't exists
                                $lookUpName = $srcKey;
                        }
                                // If file is found:
@@ -349,7 +354,7 @@ final class t3lib_iconWorks {
                        // if (preg_match('/^width="([0-9]+)" height="([0-9]+)"$/', $wHattribs, $reg))  $wHattribs='width="'.($reg[1]*2).'" height="'.($reg[2]*2).'"';
 
 
-                       // rendering disabled (greyed) icons using _i (inactive) as name suffix ("_d" is already used)
+                       // Rendering disabled (greyed) icons using _i (inactive) as name suffix ("_d" is already used)
                $matches = array();
                $srcBasename = basename($src);
                if (preg_match('/(.*)_i(\....)$/', $srcBasename, $matches)) {
@@ -379,7 +384,6 @@ final class t3lib_iconWorks {
                return $output;
        }
 
-
        /***********************************
         *
         * Other functions
@@ -389,13 +393,13 @@ final class t3lib_iconWorks {
        /**
         * Creates the icon file for the function getIcon()
         *
-        * @param       string          Original unprocessed Icon file, relative path to PATH_typo3
-        * @param       string          Mode string, eg. "deleted" or "futuretiming" determining how the icon will look
-        * @param       integer         The number of the fe_group record uid if applicable
-        * @param       boolean         Flag determines if the protected-section icon should be applied.
-        * @param       string          Absolute path to file from which to create the icon.
-        * @param       string          The filename that this icon should have had, basically [icon base name]_[flags].[extension] - used for part of temporary filename
-        * @return      string          Filename relative to PATH_typo3
+        * @param string $iconfile Original unprocessed Icon file, relative path to PATH_typo3
+        * @param string $mode Mode string, eg. "deleted" or "futuretiming" determining how the icon will look
+        * @param integer $user The number of the fe_group record uid if applicable
+        * @param boolean $protectSection Flag determines if the protected-section icon should be applied.
+        * @param string $absFile Absolute path to file from which to create the icon.
+        * @param string $iconFileName_stateTagged The filename that this icon should have had, basically [icon base name]_[flags].[extension] - used for part of temporary filename
+        * @return string Filename relative to PATH_typo3
         * @access private
         */
        public static function makeIcon($iconfile, $mode, $user, $protectSection, $absFile, $iconFileName_stateTagged) {
@@ -513,16 +517,16 @@ final class t3lib_iconWorks {
         * Of course it works only if ImageMagick is able to create valid png-images - which you cannot be sure of with older versions (still 5+)
         * The only drawback is (apparently) that IM creates true-color png's. The transparency of these will not be shown by MSIE on windows at this time (although it's straight 0%/100% transparency!) and the file size may be larger.
         *
-        * @param resource $dstImg destination image
-        * @param resource $srcImg source image
-        * @param integer $dstX destination x-coordinate
-        * @param integer $dstY destination y-coordinate
-        * @param integer $srcX source x-coordinate
-        * @param integer $srcY source y-coordinate
-        * @param integer $dstWidth destination width
-        * @param integer $dstHeight destination height
-        * @param integer $srcWidth source width
-        * @param integer $srcHeight source height
+        * @param resource $dstImg Destination image
+        * @param resource $srcImg Source image
+        * @param integer $dstX Destination x-coordinate
+        * @param integer $dstY Destination y-coordinate
+        * @param integer $srcX Source x-coordinate
+        * @param integer $srcY Source y-coordinate
+        * @param integer $dstWidth Destination width
+        * @param integer $dstHeight Destination height
+        * @param integer $srcWidth Source width
+        * @param integer $srcHeight Source height
         * @return void
         * @access private
         * @see t3lib_stdGraphic::imagecopyresized()
@@ -534,8 +538,8 @@ final class t3lib_iconWorks {
        /**
         * Create new image pointer from input file (either gif/png, in case the wrong format it is converted by t3lib_div::read_png_gif())
         *
-        * @param       string          Absolute filename of the image file from which to start the icon creation.
-        * @return      mixed           If success, image pointer, otherwise "-1"
+        * @param string $file Absolute filename of the image file from which to start the icon creation.
+        * @return mixed If success, image pointer, otherwise "-1"
         * @access private
         * @see t3lib_div::read_png_gif
         */
@@ -551,9 +555,9 @@ final class t3lib_iconWorks {
        /**
         * Write the icon in $im pointer to $path
         *
-        * @param       pointer         Pointer to GDlib image resource
-        * @param       string          Absolute path to the filename in which to write the icon.
-        * @return      void
+        * @param pointer $im Pointer to GDlib image resource
+        * @param string $path Absolute path to the filename in which to write the icon.
+        * @return void
         * @access private
         */
        public static function imagemake($im, $path) {
@@ -567,7 +571,6 @@ final class t3lib_iconWorks {
                }
        }
 
-
        /**********************************************
         *               SPRITE ICON API
         *
@@ -596,17 +599,17 @@ final class t3lib_iconWorks {
         * already to have a pre-defined background image, and the correct background-position to show
         * the necessary icon.
         *
-        * @param       string  $iconName       the name of the icon to fetch
-        * @param       array   $options        an associative array with additional options and attributes for the tag. by default, the key is the name of the attribute, and the value is the parameter string that is set. However, there are some additional special reserved keywords that can be used as keys: "html" (which is the HTML that will be inside the icon HTML tag), "tagName" (which is an alternative tagName than "span"), and "class" (additional class names that will be merged with the sprite icon CSS classes)
-        * @param       array   $overlays       an associative array with the icon-name as key, and the options for this overlay as an array again (see the parameter $options again)
-        * @return      string  the full HTML tag (usually a <span>)
+        * @param string $iconName The name of the icon to fetch
+        * @param array $options An associative array with additional options and attributes for the tag. by default, the key is the name of the attribute, and the value is the parameter string that is set. However, there are some additional special reserved keywords that can be used as keys: "html" (which is the HTML that will be inside the icon HTML tag), "tagName" (which is an alternative tagName than "span"), and "class" (additional class names that will be merged with the sprite icon CSS classes)
+        * @param array $overlays An associative array with the icon-name as key, and the options for this overlay as an array again (see the parameter $options again)
+        * @return string The full HTML tag (usually a <span>)
         * @access public
         */
        public static function getSpriteIcon($iconName, array $options = array(), array $overlays = array()) {
                $innerHtml = (isset($options['html']) ? $options['html'] : NULL);
                $tagName = (isset($options['tagName']) ? $options['tagName'] : NULL);
 
-                       // deal with the overlays
+                       // Deal with the overlays
                if (count($overlays)) {
                        foreach ($overlays as $overlayIconName => $overlayOptions) {
                                $overlayOptions['html'] = $innerHtml;
@@ -615,10 +618,10 @@ final class t3lib_iconWorks {
                        }
                }
 
-                       // check if whished icon is available
+                       // Check if whished icon is available
                $iconName = (in_array($iconName, $GLOBALS['TBE_STYLES']['spriteIconApi']['iconsAvailable']) || $iconName == 'empty-empty' ? $iconName : 'status-status-icon-missing');
 
-                       // create the CSS class
+                       // Create the CSS class
                $options['class'] = self::getSpriteIconClasses($iconName) . (isset($options['class']) ? ' ' . $options['class'] : '');
 
                unset($options['html']);
@@ -626,7 +629,6 @@ final class t3lib_iconWorks {
                return self::buildSpriteHtmlIconTag($options, $innerHtml, $tagName);
        }
 
-
        /**
         * This method is used throughout the TYPO3 Backend to show icons for a file type
         *
@@ -634,16 +636,16 @@ final class t3lib_iconWorks {
         * already to have a pre-defined background image, and the correct background-position to show
         * the necessary icon.
         *
-        * @param       string  $fileExtension  the name of the icon to fetch, can be a file extension, full file path or one of the special keywords "folder" or "mount"
-        * @param       array   $options        an associative array with additional options and attributes for the tag. by default, the key is the name of the attribute, and the value is the parameter string that is set. However, there are some additional special reserved keywords that can be used as keys: "html" (which is the HTML that will be inside the icon HTML tag), "tagName" (which is an alternative tagName than "span"), and "class" (additional class names that will be merged with the sprite icon CSS classes)
-        * @return      string  the full HTML tag (usually a <span>)
+        * @param string $fileExtension The name of the icon to fetch, can be a file extension, full file path or one of the special keywords "folder" or "mount"
+        * @param array $options An associative array with additional options and attributes for the tag. by default, the key is the name of the attribute, and the value is the parameter string that is set. However, there are some additional special reserved keywords that can be used as keys: "html" (which is the HTML that will be inside the icon HTML tag), "tagName" (which is an alternative tagName than "span"), and "class" (additional class names that will be merged with the sprite icon CSS classes)
+        * @return string The full HTML tag (usually a <span>)
         * @access public
         */
        public static function getSpriteIconForFile($fileExtension, array $options = array()) {
                $innerHtml = (isset($options['html']) ? $options['html'] : NULL);
                $tagName = (isset($options['tagName']) ? $options['tagName'] : NULL);
 
-                       // create the CSS class
+                       // Create the CSS class
                $options['class'] = self::mapFileExtensionToSpriteIconClass($fileExtension) . (isset($options['class']) ? ' ' . $options['class'] : '');
 
                unset($options['html']);
@@ -651,13 +653,12 @@ final class t3lib_iconWorks {
                return self::buildSpriteHtmlIconTag($options, $innerHtml, $tagName);
        }
 
-
        /**
         * Generates the spriteicon css classes name for a given path or fileExtension
         * usually called from getSpriteIconForFile or ExtJs Provider
         *
-        * @param       string          fileExtension can be jpg, gif etc, but also be 'mount' or 'folder', but can also be a full path which will be resolved then
-        * @return      string          the string of the CSS class, see t3lib_iconworks::$fileSpriteIconNames
+        * @param string $fileExtension FileExtension can be jpg, gif etc, but also be 'mount' or 'folder', but can also be a full path which will be resolved then
+        * @return string The string of the CSS class, see t3lib_iconworks::$fileSpriteIconNames
         * @access private
         */
        public static function mapFileExtensionToSpriteIconClass($fileExtension) {
@@ -668,17 +669,17 @@ final class t3lib_iconWorks {
         * Generates the spriteicon name for a given path or fileExtension
         * usually called from mapFileExtensionToSpriteIconClass and tceforms
         *
-        * @param       string          fileExtension can be jpg, gif etc, but also be 'mount' or 'folder', but can also be a full path which will be resolved then
-        * @return      string          the string of the CSS class, see t3lib_iconworks::$fileSpriteIconNames
+        * @param string $fileExtension FileExtension can be jpg, gif etc, but also be 'mount' or 'folder', but can also be a full path which will be resolved then
+        * @return string The string of the CSS class, see t3lib_iconworks::$fileSpriteIconNames
         * @access private
         */
        public static function mapFileExtensionToSpriteIconName($fileExtension) {
 
-                       // if the file is a whole file with name etc (mainly, if it has a "." or a "/"),
+                       // If the file is a whole file with name etc (mainly, if it has a "." or a "/"),
                        // then it is checked whether it is a valid directory
                if (strpos($fileExtension, '.') !== FALSE || strpos($fileExtension, '/') !== FALSE) {
 
-                               // check if it is a directory
+                               // Check if it is a directory
                        $filePath = dirname(t3lib_div::getIndpEnv('SCRIPT_FILENAME')) . '/' . $GLOBALS['BACK_PATH'] . $fileExtension;
                        $path = t3lib_div::resolveBackPath($filePath);
                        if (is_dir($path) || substr($fileExtension, -1) === '/' || substr($fileExtension, -1) === '\\') {
@@ -692,7 +693,7 @@ final class t3lib_iconWorks {
                        }
                }
 
-                       // if the file extension is not valid
+                       // If the file extension is not valid
                        // then use the default one
                if (!isset(self::$fileSpriteIconNames[$fileExtension])) {
                        $fileExtension = 'default';
@@ -702,7 +703,6 @@ final class t3lib_iconWorks {
                return $iconName;
        }
 
-
        /**
         * This method is used throughout the TYPO3 Backend to show icons for a DB record
         *
@@ -710,17 +710,17 @@ final class t3lib_iconWorks {
         * already to have a pre-defined background image, and the correct background-position to show
         * the necessary icon.
         *
-        * @param       string  $table  the TCA table name
-        * @param       array   $row    the DB record of the TCA table
-        * @param       array   $options        an associative array with additional options and attributes for the tag. by default, the key is the name of the attribute, and the value is the parameter string that is set. However, there are some additional special reserved keywords that can be used as keys: "html" (which is the HTML that will be inside the icon HTML tag), "tagName" (which is an alternative tagName than "span"), and "class" (additional class names that will be merged with the sprite icon CSS classes)
-        * @return      string  the full HTML tag (usually a <span>)
+        * @param string $table The TCA table name
+        * @param array $row The DB record of the TCA table
+        * @param array $options An associative array with additional options and attributes for the tag. by default, the key is the name of the attribute, and the value is the parameter string that is set. However, there are some additional special reserved keywords that can be used as keys: "html" (which is the HTML that will be inside the icon HTML tag), "tagName" (which is an alternative tagName than "span"), and "class" (additional class names that will be merged with the sprite icon CSS classes)
+        * @return string The full HTML tag (usually a <span>)
         * @access public
         */
        public static function getSpriteIconForRecord($table, array $row, array $options = array()) {
                $innerHtml = (isset($options['html']) ? $options['html'] : NULL);
                $tagName = (isset($options['tagName']) ? $options['tagName'] : NULL);
 
-                       // overlay this record icon with the status of the row
+                       // Overlay this record icon with the status of the row
                $overlaySpriteIconName = self::mapRecordOverlayToSpriteIconName($table, $row);
                if ($overlaySpriteIconName) {
                        $overlayOptions = array(
@@ -730,7 +730,7 @@ final class t3lib_iconWorks {
                        $innerHtml = self::getSpriteIcon($overlaySpriteIconName, $overlayOptions);
                }
 
-                       // fetch the name for the CSS class, based on the $row
+                       // Fetch the name for the CSS class, based on the $row
                $options['class'] = self::mapRecordTypeToSpriteIconClass($table, $row) . (isset($options['class']) ? ' ' . $options['class'] : '');
 
                unset($options['html']);
@@ -738,7 +738,6 @@ final class t3lib_iconWorks {
                return self::buildSpriteHtmlIconTag($options, $innerHtml, $tagName);
        }
 
-
        /**
         * this helper functions looks up the column that is used for the type of
         * the chosen TCA table. And then fetches the corresponding class
@@ -752,10 +751,10 @@ final class t3lib_iconWorks {
         *
         * see t3lib/stddb/tables.php for an example with the TCA table "pages"
         *
-        * @param       string  $table  the TCA table
-        * @param       array   $row    the selected record
-        * @return      string  the CSS class for the sprite icon of that DB record
-        * @access      private
+        * @param string $table The TCA table
+        * @param array $row The selected record
+        * @return string The CSS class for the sprite icon of that DB record
+        * @access private
         **/
        public static function mapRecordTypeToSpriteIconClass($table, array $row) {
                return self::getSpriteIconClasses(self::mapRecordTypeToSpriteIconName($table, $row));
@@ -774,10 +773,10 @@ final class t3lib_iconWorks {
         *
         * see t3lib/stddb/tables.php for an example with the TCA table "pages"
         *
-        * @param       string  $table  the TCA table
-        * @param       array   $row    the selected record
-        * @return      string  the CSS class for the sprite icon of that DB record
-        * @access      private
+        * @param string $tableThe TCA table
+        * @param array $row The selected record
+        * @return string The CSS class for the sprite icon of that DB record
+        * @access private
         **/
        public static function mapRecordTypeToSpriteIconName($table, array $row) {
                $recordType = array();
@@ -791,8 +790,8 @@ final class t3lib_iconWorks {
                                $recordType[1] = 'default';
                        }
 
-                               // workaround to give nav_hide pages a complete different icon
-                               // although it's not a separate doctype
+                               // Workaround to give nav_hide pages a complete different icon
+                               // Although it's not a separate doctype
                                // and to give root-pages an own icon
                        if ($table === 'pages') {
                                if ($row['nav_hide']) {
@@ -851,7 +850,6 @@ final class t3lib_iconWorks {
                return 'status-status-icon-missing';
        }
 
-
        /**
         * this helper functions checks if the DB record ($row) has any special status
         * based on the TCA settings like hidden, starttime etc, and then returns a specific
@@ -867,10 +865,10 @@ final class t3lib_iconWorks {
         * $GLOBALS['TYPO3_CONF_VARS']['BE']['spriteIconRecordOverlayNames'] that shows
         * the list of CSS classes that will be used for the sprites, mapped to the statuses here
         *
-        * @param       string  $table  the TCA table
-        * @param       array   $row    the selected record
-        * @return      string  the CSS class for the sprite icon of that DB record
-        * @access      private
+        * @param string $table The TCA table
+        * @param array $row The selected record
+        * @return string The CSS class for the sprite icon of that DB record
+        * @access private
         */
        public static function mapRecordOverlayToSpriteIconName($table, array $row) {
                $tcaCtrl = $GLOBALS['TCA'][$table]['ctrl'];
@@ -940,7 +938,7 @@ final class t3lib_iconWorks {
                        }
                }
 
-                       // now only show the status with the highest priority
+                       // Now only show the status with the highest priority
                $priorities = $GLOBALS['TBE_STYLES']['spriteIconApi']['spriteIconRecordOverlayPriorities'];
 
                $iconName = '';
@@ -956,41 +954,40 @@ final class t3lib_iconWorks {
                return $iconName;
        }
 
-
        /**
         * generic method to create the final CSS classes based on the sprite icon name
         * with the base class and splits the name into parts
         * is usually called by the methods that are responsible for fetching the names
         * out of the file name, or the record type
         *
-        * @param       string  $name   iconname like 'actions-document-new'
-        * @return      string  a list of all CSS classes needed for the HTML tag
-        * @access public
+        * @param string $name Iconname like 'actions-document-new'
+        * @return string A list of all CSS classes needed for the HTML tag
         */
        public static function getSpriteIconClasses($iconName) {
                $cssClasses = $baseCssClass = 't3-icon';
                $parts = explode('-', $iconName);
 
                if (count($parts) > 1) {
-                               // will be something like "t3-icon-actions"
+                               // Will be something like "t3-icon-actions"
                        $cssClasses .= ' ' . ($baseCssClass . '-' . $parts[0]);
-                               // will be something like "t3-icon-actions-document"
+                               // Will be something like "t3-icon-actions-document"
                        $cssClasses .= ' ' . ($baseCssClass . '-' . $parts[0] . '-' . $parts[1]);
-                               // will be something like "t3-icon-document-new"
+                               // Will be something like "t3-icon-document-new"
                        $cssClasses .= ' ' . ($baseCssClass . '-' . substr($iconName, strlen($parts[0]) + 1));
                }
                return $cssClasses;
        }
 
-
        /**
         * low level function that generates the HTML tag for the sprite icon
         * is usually called by the three API classes (getSpriteIcon, getSpriteIconForFile, getSpriteIconForRecord)
         * it does not care about classes or anything else, but just plainly builds the HTML tag
         *
-        * @param       array   $tagAttributes  an associative array of additional tagAttributes for the HTML tag
-        * @param       string  $innerHtml (optional)   the content within the tag, a "&nbsp;" by default
-        * @param       string  $tagName (optional)     the name of the HTML element that should be used (span by default)
+        * @param array $tagAttributes An associative array of additional tagAttributes for the HTML tag
+        * @param string $innerHtml The content within the tag, a "&nbsp;" by default
+        * @param string $tagName The name of the HTML element that should be used (span by default)
+        *
+        * @return string The sprite html icon tag
         */
        protected static function buildSpriteHtmlIconTag(array $tagAttributes, $innerHtml = NULL, $tagName = NULL) {
                $innerHtml = ($innerHtml === NULL ? '&nbsp;' : $innerHtml);
@@ -1001,7 +998,6 @@ final class t3lib_iconWorks {
                }
                return '<' . $tagName . $attributes . '>' . $innerHtml . '</' . $tagName . '>';
        }
-
 }
 
 ?>
\ No newline at end of file
index 0e51b80..95386ab 100644 (file)
 /**
  * Class to setup values in localconf.php and verify the TYPO3 DB tables/fields
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  */
 
-
 /**
  * Class to setup values in localconf.php and verify the TYPO3 DB tables/fields
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage t3lib
  */
 class t3lib_install {
 
-
                // External, Static
-       var $updateIdentity = ''; // Set to string which identifies the script using this class.
-
-       var $dbUpdateCheckboxPrefix = 'TYPO3_INSTALL[database_update]'; // Prefix for checkbox fields when updating database.
-       var $localconf_addLinesOnly = 0; // If this is set, modifications to localconf.php is done by adding new lines to the array only. If unset, existing values are recognized and changed.
-       protected $localconf_startEditPointToken = '## INSTALL SCRIPT EDIT POINT TOKEN - all lines after this points may be changed by the install script!'; // If set and addLinesOnly is disabled, lines will be change only if they are after this token (on a single line!) in the file
+               // Set to string which identifies the script using this class.
+       var $updateIdentity = '';
+
+               // Prefix for checkbox fields when updating database.
+       var $dbUpdateCheckboxPrefix = 'TYPO3_INSTALL[database_update]';
+               // If this is set, modifications to localconf.php is done by adding new lines to the array only. If unset, existing values are recognized and changed.
+       var $localconf_addLinesOnly = 0;
+               // If set and addLinesOnly is disabled, lines will be change only if they are after this token (on a single line!) in the file
+       protected $localconf_startEditPointToken = '## INSTALL SCRIPT EDIT POINT TOKEN - all lines after this points may be changed by the install script!';
        protected $localconf_endEditPointToken = '## INSTALL SCRIPT EDIT END POINT TOKEN - all lines before this points may be changed by the install script!';
-       var $allowUpdateLocalConf = 0; // If TRUE, this class will allow the user to update the localconf.php file. Is set TRUE in the init.php file.
-       var $backPath = '../'; // Backpath (used for icons etc.)
+               // If TRUE, this class will allow the user to update the localconf.php file. Is set TRUE in the init.php file.
+       var $allowUpdateLocalConf = 0;
+               // Backpath (used for icons etc.)
+       var $backPath = '../';
 
                // Internal, dynamic:
-       var $setLocalconf = 0; // Used to indicate that a value is change in the line-array of localconf and that it should be written.
-       var $messages = array(); // Used to set (error)messages from the executing functions like mail-sending, writing Localconf and such
-       var $touchedLine = 0; // updated with line in localconf.php file that was changed.
+               // Used to indicate that a value is change in the line-array of localconf and that it should be written.
+       var $setLocalconf = 0;
+               // Used to set (error)messages from the executing functions like mail-sending, writing Localconf and such
+       var $messages = array();
+               // Updated with line in localconf.php file that was changed.
+       var $touchedLine = 0;
 
        /**
         * @var t3lib_install_Sql Instance of SQL handler
@@ -78,11 +85,11 @@ class t3lib_install {
        /**
         * This functions takes an array with lines from localconf.php, finds a variable and inserts the new value.
         *
-        * @param       array           $line_array     the localconf.php file exploded into an array by linebreaks. (see writeToLocalconf_control())
-        * @param       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.
-        * @param       string          $value          Is the value to be insert for the variable
-        * @param       boolean         $quoteValue     Whether the given value should be quoted before being written
-        * @return      void
+        * @param array $line_array The localconf.php file exploded into an array by linebreaks. (see writeToLocalconf_control())
+        * @param 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.
+        * @param string $value Is the value to be insert for the variable
+        * @param boolean $quoteValue Whether the given value should be quoted before being written
+        * @return void
         * @see writeToLocalconf_control()
         */
        public function setValueInLocalconfFile(&$line_array, $variable, $value, $quoteValue = TRUE) {
@@ -90,11 +97,12 @@ class t3lib_install {
                        return 0;
                }
 
-                       // Initialize:
+                       // Initialize
                $found = 0;
                $this->touchedLine = '';
                $inArray = in_array($this->localconf_startEditPointToken, $line_array);
-               $tokenSet = ($this->localconf_startEditPointToken && !$inArray); // Flag is set if the token should be set but is not yet...
+                       // Flag is set if the token should be set but is not yet.
+               $tokenSet = ($this->localconf_startEditPointToken && !$inArray);
                $stopAtToken = ($this->localconf_startEditPointToken && $inArray);
                $hasEndToken = in_array($this->localconf_endEditPointToken, $line_array);
                $respectEndToken = $hasEndToken;
@@ -103,7 +111,7 @@ class t3lib_install {
                $search = array('[\'', '\']');
                $varDoubleQuotes = str_replace($search, $replace, $variable);
 
-                       // Search for variable name:
+                       // Search for variable name
                if (!$this->localconf_addLinesOnly && !$tokenSet) {
                        $line_array = array_reverse($line_array);
                        foreach ($line_array as $k => $v) {
@@ -120,7 +128,8 @@ class t3lib_install {
                                } // If stopAtToken and token found, break out of the loop..
                                if (!strcmp(substr($v2, 0, strlen($variable . ' ')), $variable . ' ')) {
                                        $mainparts = explode($variable, $v, 2);
-                                       if (count($mainparts) == 2) { // should ALWAYS be....
+                                               // Should ALWAYS be.
+                                       if (count($mainparts) == 2) {
                                                $subparts = explode('//', $mainparts[1], 2);
                                                if ($quoteValue) {
                                                        $value = '\'' . $this->slashValueForSingleDashes($value) . '\'';
@@ -137,7 +146,8 @@ class t3lib_install {
                                                // localconf.php. The following code was added to make sure that values with
                                                // double quotes are updated, too.
                                        $mainparts = explode($varDoubleQuotes, $v, 2);
-                                       if (count($mainparts) == 2) { // should ALWAYS be....
+                                               // Should ALWAYS be.
+                                       if (count($mainparts) == 2) {
                                                $subparts = explode('//', $mainparts[1], 2);
                                                if ($quoteValue) {
                                                        $value = '\'' . $this->slashValueForSingleDashes($value) . '\'';
@@ -279,7 +289,7 @@ class t3lib_install {
                $writeToLocalconf_dat['file'] = $absFullPath ? $absFullPath : PATH_typo3conf . 'localconf.php';
                $writeToLocalconf_dat['tmpfile'] = $writeToLocalconf_dat['file'] . $tmpExt;
 
-                       // Checking write state of localconf.php:
+                       // Checking write state of localconf.php
                if (!$this->allowUpdateLocalConf) {
                        throw new RuntimeException(
                                'TYPO3 Fatal Error: ->allowUpdateLocalConf flag in the install object is not set and therefore "localconf.php" cannot be altered.',
@@ -293,7 +303,7 @@ class t3lib_install {
                        );
                }
 
-                       // Splitting localconf.php file into lines:
+                       // Splitting localconf.php file into lines
                $lines = explode(LF, str_replace(CR, '', trim(t3lib_div::getUrl($writeToLocalconf_dat['file']))));
                $writeToLocalconf_dat['endLine'] = array_pop($lines); // Getting "? >" ending.
 
@@ -305,7 +315,8 @@ class t3lib_install {
                        array_push($lines, $updatedLine);
                }
 
-               if (is_array($inlines)) { // Setting a line and write:
+                       // Setting a line and write
+               if (is_array($inlines)) {
                                // Setting configuration
                        $updatedLine = $writeToLocalconf_dat['updatedText'] . date($GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'] . ' H:i:s');
                        array_push($inlines, $updatedLine);
@@ -374,15 +385,12 @@ class t3lib_install {
                $success = FALSE;
                if (!t3lib_div::writeFile($writeToLocalconf_dat['tmpfile'], implode(LF, $lines))) {
                        $msg = 'typo3conf/localconf.php' . $tmpExt . ' could not be written - maybe a write access problem?';
-               }
-               elseif (strcmp(t3lib_div::getUrl($writeToLocalconf_dat['tmpfile']), implode(LF, $lines))) {
+               } elseif (strcmp(t3lib_div::getUrl($writeToLocalconf_dat['tmpfile']), implode(LF, $lines))) {
                        @unlink($writeToLocalconf_dat['tmpfile']);
                        $msg = 'typo3conf/localconf.php' . $tmpExt . ' was NOT written properly (written content didn\'t match file content) - maybe a disk space problem?';
-               }
-               elseif (!@copy($writeToLocalconf_dat['tmpfile'], $writeToLocalconf_dat['file'])) {
+               } elseif (!@copy($writeToLocalconf_dat['tmpfile'], $writeToLocalconf_dat['file'])) {
                        $msg = 'typo3conf/localconf.php could not be replaced by typo3conf/localconf.php' . $tmpExt . ' - maybe a write access problem?';
-               }
-               else {
+               } else {
                        @unlink($writeToLocalconf_dat['tmpfile']);
                        $success = TRUE;
                        $msg = 'Configuration written to typo3conf/localconf.php';
@@ -399,8 +407,8 @@ class t3lib_install {
        /**
         * Checking for linebreaks in the string
         *
-        * @param       string          String to test
-        * @return      boolean         Returns TRUE if string is OK
+        * @param string $string String to test
+        * @return boolean Returns TRUE if string is OK
         * @see setValueInLocalconfFile()
         */
        function checkForBadString($string) {
@@ -422,7 +430,6 @@ class t3lib_install {
                return $value;
        }
 
-
        /**
         * Creates a table which checkboxes for updating database.
         *
@@ -443,7 +450,7 @@ class t3lib_install {
                                        <tr class="update-db-fields-batch">
                                                <td valign="top">
                                                        <input type="checkbox" id="' . $tableId . '-checkbox"' . ($checked ? ' checked="checked"' : '') . '
-                                                        onclick="$(\'' . $tableId . '\').select(\'input[type=checkbox]\').invoke(\'setValue\', $(this).checked);" />
+                                                       onclick="$(\'' . $tableId . '\').select(\'input[type=checkbox]\').invoke(\'setValue\', $(this).checked);" />
                                                </td>
                                                <td nowrap="nowrap"><label for="' . $tableId . '-checkbox" style="cursor:pointer"><strong>select/deselect all</strong></label></td>
                                        </tr>';