[TASK] Remove usage counts in method comments
authorChristian Kuhn <lolli@schwarzbu.ch>
Sun, 21 Aug 2011 13:24:54 +0000 (15:24 +0200)
committerSusanne Moog <typo3@susannemoog.de>
Sun, 21 Aug 2011 13:31:12 +0000 (15:31 +0200)
Issue #27985 removed the function indexes from class files and most
usage counts from method comments. This patch removes some missing matches.

Change-Id: Id53769839517e50b977cc01d7f6008beb74b5896
Resolves: #29135
Reviewed-on: http://review.typo3.org/4449
Reviewed-by: Susanne Moog
Tested-by: Susanne Moog
t3lib/class.t3lib_befunc.php
t3lib/class.t3lib_db.php
t3lib/class.t3lib_extmgm.php
t3lib/class.t3lib_iconworks.php

index 4ec16b7..3690b47 100644 (file)
  *
  *  This copyright notice MUST APPEAR in all copies of the script!
  ***************************************************************/
+
 /**
  * Standard functions available for the TYPO3 backend.
  * You are encouraged to use this class in your own applications (Backend Modules)
+ * Don't instantiate - call functions with "t3lib_BEfunc::" prefixed the function name.
  *
  * Call ALL methods without making an object!
  * Eg. to get a page-record 51 do this: 't3lib_BEfunc::getRecord('pages',51)'
  *
- * Usage counts are based on search 22/2 2003 through whole backend source of typo3/
- * Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj
- * XHTML compliant
- *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
- */
-
-
-/**
- * Standard functions available for the TYPO3 backend.
- * Don't instantiate - call functions with "t3lib_BEfunc::" prefixed the function name.
- *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage t3lib
  */
 final class t3lib_BEfunc {
 
-
        /*******************************************
         *
         * SQL-related, selecting records, searching
@@ -61,7 +50,6 @@ final class t3lib_BEfunc {
         * Returns the WHERE clause " AND NOT [tablename].[deleted-field]" if a deleted-field is configured in $GLOBALS['TCA'] for the tablename, $table
         * This function should ALWAYS be called in the backend for selection on tables which are configured in $GLOBALS['TCA'] since it will ensure consistent selection of records, even if they are marked deleted (in which case the system must always treat them as non-existent!)
         * In the frontend a function, ->enableFields(), is known to filter hidden-field, start- and endtime and fe_groups as well. But that is a job of the frontend, not the backend. If you need filtering on those fields as well in the backend you can use ->BEenableFields() though.
-        * Usage: 71
         *
         * @param       string          Table name present in $GLOBALS['TCA']
         * @param       string          Table alias if any
@@ -81,7 +69,6 @@ final class t3lib_BEfunc {
         * Additional WHERE clauses can be added by $where (fx. ' AND blabla = 1')
         * Will automatically check if records has been deleted and if so, not return anything.
         * $table must be found in $GLOBALS['TCA']
-        * Usage: 99
         *
         * @param       string          Table name present in $GLOBALS['TCA']
         * @param       integer         UID of record
@@ -142,7 +129,6 @@ final class t3lib_BEfunc {
         * $table does NOT need to be configured in $GLOBALS['TCA']
         * The query used is simply this:
         * $query = 'SELECT '.$fields.' FROM '.$table.' WHERE '.$where;
-        * Usage: 5 (ext: sys_todos)
         *
         * @param       string          Table name (not necessarily in TCA)
         * @param       string          WHERE clause
@@ -162,7 +148,6 @@ final class t3lib_BEfunc {
         * Returns records from table, $theTable, where a field ($theField) equals the value, $theValue
         * The records are returned in an array
         * If no records were selected, the function returns nothing
-        * Usage: 8
         *
         * @param       string          Table name present in $GLOBALS['TCA']
         * @param       string          Field to select on
@@ -201,7 +186,6 @@ final class t3lib_BEfunc {
        /**
         * Makes an backwards explode on the $str and returns an array with ($table, $uid).
         * Example: tt_content_45 => array('tt_content', 45)
-        * Usage: 1
         *
         * @param       string          [tablename]_[uid] string to explode
         * @return      array
@@ -214,7 +198,6 @@ final class t3lib_BEfunc {
        /**
         * Returns a list of pure integers based on $in_list being a list of records with table-names prepended.
         * Ex: $in_list = "pages_4,tt_content_12,45" would result in a return value of "4,45" if $tablename is "pages" and $default_tablename is 'pages' as well.
-        * Usage: 1 (t3lib_userauthgroup)
         *
         * @param       string          Input list
         * @param       string          Table name from which ids is returned
@@ -245,7 +228,6 @@ final class t3lib_BEfunc {
         * Notice that "fe_groups" is not selected for - only disabled, starttime and endtime.
         * Notice that deleted-fields are NOT filtered - you must ALSO call deleteClause in addition.
         * $GLOBALS["SIM_ACCESS_TIME"] is used for date.
-        * Usage: 5
         *
         * @param       string          $table is the table from which to return enableFields WHERE clause. Table name must have a 'ctrl' section in $GLOBALS['TCA'].
         * @param       boolean         $inv means that the query will select all records NOT VISIBLE records (inverted selection)
@@ -316,7 +298,6 @@ final class t3lib_BEfunc {
         * Returns what is called the 'RootLine'. That is an array with information about the page records from a page id ($uid) and back to the root.
         * By default deleted pages are filtered.
         * This RootLine will follow the tree all the way to the root. This is opposite to another kind of root line known from the frontend where the rootline stops when a root-template is found.
-        * Usage: 1
         *
         * @param       integer         Page id for which to create the root line.
         * @param       string          $clause can be used to select other criteria. It would typically be where-clauses that stops the process if we meet a page, the user has no reading access to.
@@ -457,7 +438,6 @@ final class t3lib_BEfunc {
         * Returns the path (visually) of a page $uid, fx. "/First page/Second page/Another subpage"
         * Each part of the path will be limited to $titleLimit characters
         * Deleted pages are filtered out.
-        * Usage: 15
         *
         * @param       integer         Page uid for which to create record path
         * @param       string          $clause is additional where clauses, eg. "
@@ -502,7 +482,6 @@ final class t3lib_BEfunc {
        /**
         * Returns an array with the exclude-fields as defined in TCA and FlexForms
         * Used for listing the exclude-fields in be_groups forms
-        * Usage: 2 (t3lib_tceforms + t3lib_transferdata)
         *
         * @return      array           Array of arrays with excludeFields (fieldname, table:fieldname) from all TCA entries and from FlexForms (fieldname, table:extkey;sheetname;fieldname)
         */
@@ -704,7 +683,6 @@ final class t3lib_BEfunc {
         * Returns a page record (of page with $id) with an extra field "_thePath" set to the record path IF the WHERE clause, $perms_clause, selects the record. Thus is works as an access check that returns a page record if access was granted, otherwise not.
         * If $id is zero a pseudo root-page with "_thePath" set is returned IF the current BE_USER is admin.
         * In any case ->isInWebMount must return TRUE for the user (regardless of $perms_clause)
-        * Usage: 21
         *
         * @param       integer         Page uid for which to check read-access
         * @param       string          $perms_clause is typically a value generated with $GLOBALS['BE_USER']->getPagePermsClause(1);
@@ -736,7 +714,6 @@ final class t3lib_BEfunc {
 
        /**
         * Returns the "types" configuration parsed into an array for the record, $rec, from table, $table
-        * Usage: 6
         *
         * @param       string          Table name (present in TCA)
         * @param       array           Record from $table
@@ -787,7 +764,6 @@ final class t3lib_BEfunc {
         * Returns the "type" value of $rec from $table which can be used to look up the correct "types" rendering section in $GLOBALS['TCA']
         * If no "type" field is configured in the "ctrl"-section of the $GLOBALS['TCA'] for the table, zero is used.
         * If zero is not an index in the "types" section of $GLOBALS['TCA'] for the table, then the $fieldValue returned will default to 1 (no matter if that is an index or not)
-        * Usage: 7
         *
         * @param       string          Table name present in TCA
         * @param       array           Record from $table
@@ -812,7 +788,6 @@ final class t3lib_BEfunc {
         * Parses a part of the field lists in the "types"-section of $GLOBALS['TCA'] arrays, namely the "special configuration" at index 3 (position 4)
         * Elements are splitted by ":" and within those parts, parameters are splitted by "|".
         * Everything is returned in an array and you should rather see it visually than listen to me anymore now...  Check out example in Inside TYPO3
-        * Usage: 5
         *
         * @param       string          Content from the "types" configuration of TCA (the special configuration) - see description of function
         * @param       string          The ['defaultExtras'] value from field configuration
@@ -844,7 +819,6 @@ final class t3lib_BEfunc {
        /**
         * Takes an array of "[key] = [value]" strings and returns an array with the keys set as keys pointing to the value.
         * Better see it in action! Find example in Inside TYPO3
-        * Usage: 6
         *
         * @param       array           Array of "[key] = [value]" strings to convert.
         * @return      array
@@ -867,7 +841,6 @@ final class t3lib_BEfunc {
        /**
         * Finds the Data Structure for a FlexForm field
         * NOTE ON data structures for deleted records: This function may fail to deliver the data structure for a record for a few reasons: a) The data structure could be deleted (either with deleted-flagged or hard-deleted), b) the data structure is fetched using the ds_pointerField_searchParent in which case any deleted record on the route to the final location of the DS will make it fail. In theory, we can solve the problem in the case where records that are deleted-flagged keeps us from finding the DS - this is done at the markers ###NOTE_A### where we make sure to also select deleted records. However, we generally want the DS lookup to fail for deleted records since for the working website we expect a deleted-flagged record to be as inaccessible as one that is completely deleted from the DB. Any way we look at it, this may lead to integrity problems of the reference index and even lost files if attached. However, that is not really important considering that a single change to a data structure can instantly invalidate large amounts of the reference index which we do accept as a cost for the flexform features. Other than requiring a reference index update, deletion of/changes in data structure or the failure to look them up when completely deleting records may lead to lost files in the uploads/ folders since those are now without a proper reference.
-        * Usage: 5
         *
         * @param       array           Field config array
         * @param       array           Record data
@@ -1011,7 +984,6 @@ final class t3lib_BEfunc {
 
        /**
         * Returns all registered FlexForm definitions with title and fields
-        * Usage: 1
         *
         * @param       string          The content table
         * @return      array           The data structures with speaking extension title
@@ -1104,7 +1076,6 @@ final class t3lib_BEfunc {
         * Stores the string value $data in the 'cache_hash' cache with the
         * hash key, $hash, and visual/symbolic identification, $ident
         * IDENTICAL to the function by same name found in t3lib_page:
-        * Usage: 2
         *
         * @param       string          32 bit hash string (eg. a md5 hash of a serialized array identifying the data being stored)
         * @param       string          The data string. If you want to store an array, then just serialize it first.
@@ -1148,7 +1119,6 @@ final class t3lib_BEfunc {
        /**
         * Returns the Page TSconfig for page with id, $id
         * Requires class "t3lib_TSparser"
-        * Usage: 26 (spec. in ext info_pagetsconfig)
         *
         * @param       integer         Page uid for which to create Page TSconfig
         * @param       array           If $rootLine is an array, that is used as rootline, otherwise rootline is just calculated
@@ -1211,8 +1181,6 @@ final class t3lib_BEfunc {
         * THIS DOES NOT CHECK ANY PERMISSIONS. SHOULD IT?
         * More documentation is needed.
         *
-        * Usage: 1 (ext. direct_mail)
-        *
         * @param       integer         Page id
         * @param       array           Page TS array to write
         * @param       string          Prefix for object paths
@@ -1267,7 +1235,6 @@ final class t3lib_BEfunc {
 
        /**
         * Implodes a multi dimensional TypoScript array, $p, into a one-dimentional array (return value)
-        * Usage: 3
         *
         * @param       array           TypoScript structure
         * @param       string          Prefix string
@@ -1297,7 +1264,6 @@ final class t3lib_BEfunc {
        /**
         * Returns an array with be_users records of all user NOT DELETED sorted by their username
         * Keys in the array is the be_users uid
-        * Usage: 14 (spec. ext. "beuser" and module "web_perm")
         *
         * @param       string          Optional $fields list (default: username,usergroup,usergroup_cached_list,uid) can be used to set the selected fields
         * @param       string          Optional $where clause (fx. "AND username='pete'") can be used to limit query
@@ -1317,7 +1283,6 @@ final class t3lib_BEfunc {
 
        /**
         * Returns an array with be_groups records (title, uid) of all groups NOT DELETED sorted by their title
-        * Usage: 8 (spec. ext. "beuser" and module "web_perm")
         *
         * @param       string          Field list
         * @param       string          WHERE clause
@@ -1338,7 +1303,6 @@ final class t3lib_BEfunc {
        /**
         * Returns an array with be_groups records (like ->getGroupNames) but:
         * - if the current BE_USER is admin, then all groups are returned, otherwise only groups that the current user is member of (usergroup_cached_list) will be returned.
-        * Usage: 2 (module "web_perm" and ext. taskcenter)
         *
         * @param       string          Field list; $fields specify the fields selected (default: title,uid)
         * @return      array
@@ -1355,7 +1319,6 @@ final class t3lib_BEfunc {
         * Returns the array $usernames with the names of all users NOT IN $groupArray changed to the uid (hides the usernames!).
         * If $excludeBlindedFlag is set, then these records are unset from the array $usernames
         * Takes $usernames (array made by t3lib_BEfunc::getUserNames()) and a $groupArray (array with the groups a certain user is member of) as input
-        * Usage: 8
         *
         * @param       array           User names
         * @param       array           Group names
@@ -1389,7 +1352,6 @@ final class t3lib_BEfunc {
 
        /**
         * Corresponds to blindUserNames but works for groups instead
-        * Usage: 2 (module web_perm)
         *
         * @param       array           Group names
         * @param       array           Group names (reference)
@@ -1423,7 +1385,6 @@ final class t3lib_BEfunc {
 
        /**
         * Returns the difference in days between input $tstamp and $EXEC_TIME
-        * Usage: 2 (class t3lib_BEfunc)
         *
         * @param       integer         Time stamp, seconds
         * @return      integer
@@ -1435,7 +1396,6 @@ final class t3lib_BEfunc {
 
        /**
         * Returns $tstamp formatted as "ddmmyy" (According to $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'])
-        * Usage: 11
         *
         * @param       integer         Time stamp, seconds
         * @return      string          Formatted time
@@ -1446,7 +1406,6 @@ final class t3lib_BEfunc {
 
        /**
         * Returns $tstamp formatted as "ddmmyy hhmm" (According to $GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'] AND $GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'])
-        * Usage: 28
         *
         * @param       integer         Time stamp, seconds
         * @return      string          Formatted time
@@ -1458,7 +1417,6 @@ final class t3lib_BEfunc {
        /**
         * Returns $value (in seconds) formatted as hh:mm:ss
         * For instance $value = 3600 + 60*2 + 3 should return "01:02:03"
-        * Usage: 1 (class t3lib_BEfunc)
         *
         * @param       integer         Time stamp, seconds
         * @param       boolean         Output hh:mm:ss. If FALSE: hh:mm
@@ -1477,7 +1435,6 @@ final class t3lib_BEfunc {
 
        /**
         * Returns the "age" in minutes / hours / days / years of the number of $seconds inputted.
-        * Usage: 15
         *
         * @param       integer         $seconds could be the difference of a certain timestamp and time()
         * @param       string          $labels should be something like ' min| hrs| days| yrs| min| hour| day| year'. This value is typically delivered by this function call: $GLOBALS["LANG"]->sL("LLL:EXT:lang/locallang_core.php:labels.minutesHoursDaysYears")
@@ -1506,7 +1463,6 @@ final class t3lib_BEfunc {
        /**
         * Returns a formatted timestamp if $tstamp is set.
         * The date/datetime will be followed by the age in parenthesis.
-        * Usage: 3
         *
         * @param       integer         Time stamp, seconds
         * @param       integer         1/-1 depending on polarity of age.
@@ -1522,7 +1478,6 @@ final class t3lib_BEfunc {
 
        /**
         * Returns alt="" and title="" attributes with the value of $content.
-        * Usage: 7
         *
         * @param       string          Value for 'alt' and 'title' attributes (will be htmlspecialchars()'ed before output)
         * @return      string
@@ -1538,7 +1493,6 @@ final class t3lib_BEfunc {
         * Returns a linked image-tag for thumbnail(s)/fileicons/truetype-font-previews from a database row with a list of image files in a field
         * All $GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'] extension are made to thumbnails + ttf file (renders font-example)
         * Thumbsnails are linked to the show_item.php script which will display further details.
-        * Usage: 7
         *
         * @param       array           $row is the database row from the table, $table.
         * @param       string          Table name for $row (present in TCA)
@@ -1644,7 +1598,6 @@ final class t3lib_BEfunc {
 
        /**
         * Returns single image tag to thumbnail using a thumbnail script (like thumbs.php)
-        * Usage: 3
         *
         * @param       string          $thumbScript must point to "thumbs.php" relative to the script position
         * @param       string          $theFile must be the proper reference to the file thumbs.php should show
@@ -1665,7 +1618,6 @@ final class t3lib_BEfunc {
 
        /**
         * Returns title-attribute information for a page-record informing about id, alias, doktype, hidden, starttime, endtime, fe_group etc.
-        * Usage: 8
         *
         * @param       array           Input must be a page row ($row) with the proper fields set (be sure - send the full range of fields for the table)
         * @param       string          $perms_clause is used to get the record path of the shortcut page, if any (and doktype==4)
@@ -1760,7 +1712,6 @@ final class t3lib_BEfunc {
         * Returns title-attribute information for ANY record (from a table defined in TCA of course)
         * The included information depends on features of the table, but if hidden, starttime, endtime and fe_group fields are configured for, information about the record status in regard to these features are is included.
         * "pages" table can be used as well and will return the result of ->titleAttribForPages() for that page.
-        * Usage: 10
         *
         * @param       array           Table row; $row is a row from the table, $table
         * @param       string          Table name
@@ -1820,7 +1771,6 @@ final class t3lib_BEfunc {
 
        /**
         * Returns the label of the first found entry in an "items" array from $GLOBALS['TCA'] (tablename = $table/fieldname = $col) where the value is $key
-        * Usage: 9
         *
         * @param       string          Table name, present in $GLOBALS['TCA']
         * @param       string          Field name, present in $GLOBALS['TCA']
@@ -1846,7 +1796,6 @@ final class t3lib_BEfunc {
        /**
         * Returns the label-value for fieldname $col in table, $table
         * If $printAllWrap is set (to a "wrap") then it's wrapped around the $col value IF THE COLUMN $col DID NOT EXIST in TCA!, eg. $printAllWrap = '<strong>|</strong>' and the fieldname was 'not_found_field' then the return value would be '<strong>not_found_field</strong>'
-        * Usage: 17
         *
         * @param       string          Table name, present in $GLOBALS['TCA']
         * @param       string          Field name
@@ -1870,7 +1819,6 @@ final class t3lib_BEfunc {
        /**
         * Returns the "title"-value in record, $row, from table, $table
         * The field(s) from which the value is taken is determined by the "ctrl"-entries 'label', 'label_alt' and 'label_alt_force'
-        * Usage: 26
         *
         * @param       string          Table name, present in TCA
         * @param       array           Row from table
@@ -1971,7 +1919,6 @@ final class t3lib_BEfunc {
         * For instance a database record relation would be looked up to display the title-value of that record. A checkbox with a "1" value would be "Yes", etc.
         * $table/$col is tablename and fieldname
         * REMEMBER to pass the output through htmlspecialchars() if you output it to the browser! (To protect it from XSS attacks and be XHTML compliant)
-        * Usage: 24
         *
         * @param       string          Table name, present in TCA
         * @param       string          Field name, present in TCA
@@ -2172,7 +2119,6 @@ final class t3lib_BEfunc {
 
        /**
         * Same as ->getProcessedValue() but will go easy on fields like "tstamp" and "pid" which are not configured in TCA - they will be formatted by this function instead.
-        * Usage: 2
         *
         * @param       string          Table name, present in TCA
         * @param       string          Field name
@@ -2201,7 +2147,6 @@ final class t3lib_BEfunc {
 
        /**
         * Returns file icon name (from $FILEICONS) for the fileextension $ext
-        * Usage: 10
         *
         * @param       string          File extension, lowercase
         * @return      string          File icon filename
@@ -2214,7 +2159,6 @@ final class t3lib_BEfunc {
         * Returns fields for a table, $table, which would typically be interesting to select
         * This includes uid, the fields defined for title, icon-field.
         * Returned as a list ready for query ($prefix can be set to eg. "pages." if you are selecting from the pages table and want the table name prefixed)
-        * Usage: 3
         *
         * @param       string          Table name, present in $GLOBALS['TCA']
         * @param       string          Table prefix
@@ -2267,7 +2211,6 @@ final class t3lib_BEfunc {
         * Makes a form for configuration of some values based on configuration found in the array $configArray, with default values from $defaults and a data-prefix $dataPrefix
         * <form>-tags must be supplied separately
         * Needs more documentation and examples, in particular syntax for configuration array. See Inside TYPO3. That's were you can expect to find example, if anywhere.
-        * Usage: 1 (ext. direct_mail)
         *
         * @param       array           Field configuration code.
         * @param       array           Defaults
@@ -2333,7 +2276,6 @@ final class t3lib_BEfunc {
         * Returns help-text icon if configured for.
         * TCA_DESCR must be loaded prior to this function and $GLOBALS['BE_USER'] must
         * have 'edit_showFieldHelp' set to 'icon', otherwise nothing is returned
-        * Usage: 6
         *
         * Please note: since TYPO3 4.5 the UX team decided to not use CSH in its former way,
         * but to wrap the given text (where before the help icon was, and you could hover over it)
@@ -2395,7 +2337,6 @@ final class t3lib_BEfunc {
         * $GLOBALS['TCA_DESCR'] must be loaded prior to this function and $GLOBALS['BE_USER'] must have "edit_showFieldHelp" set to "text",
         * otherwise nothing is returned
         * Will automatically call t3lib_BEfunc::helpTextIcon() to get the icon for the text.
-        * Usage: 4
         *
         * @param       string          Table name
         * @param       string          Field name
@@ -2481,7 +2422,6 @@ final class t3lib_BEfunc {
        /**
         * API for getting CSH icons/text for use in backend modules.
         * TCA_DESCR will be loaded if it isn't already
-        * Usage: ?
         *
         * @param       string          Table name ('_MOD_'+module name)
         * @param       string          Field name (CSH locallang main key)
@@ -2533,7 +2473,6 @@ final class t3lib_BEfunc {
        /**
         * Returns a JavaScript string (for an onClick handler) which will load the alt_doc.php script that shows the form for editing of the record(s) you have send as params.
         * REMEMBER to always htmlspecialchar() content in href-properties to ampersands get converted to entities (XHTML requirement and XSS precaution)
-        * Usage: 35
         *
         * @param       string          $params is parameters sent along to alt_doc.php. This requires a much more details description which you must seek in Inside TYPO3s documentation of the alt_doc.php API. And example could be '&edit[pages][123] = edit' which will show edit form for page record 123.
         * @param       string          $backPath must point back to the TYPO3_mainDir directory (where alt_doc.php is)
@@ -2549,7 +2488,6 @@ final class t3lib_BEfunc {
        /**
         * Returns a JavaScript string for viewing the page id, $id
         * It will detect the correct domain name if needed and provide the link with the right back path. Also it will re-use any window already open.
-        * Usage: 8
         *
         * @param       integer         $pageUid is page id
         * @param       string          $backPath must point back to TYPO3_mainDir (where the site is assumed to be one level above)
@@ -2654,7 +2592,6 @@ final class t3lib_BEfunc {
        /**
         * Returns the merged User/Page TSconfig for page id, $id.
         * Please read details about module programming elsewhere!
-        * Usage: 15
         *
         * @param       integer         Page uid
         * @param       string          $TSref is an object string which determines the path of the TSconfig to return.
@@ -2671,7 +2608,6 @@ final class t3lib_BEfunc {
         * Returns a selector box "function menu" for a module
         * Requires the JS function jumpToUrl() to be available
         * See Inside TYPO3 for details about how to use / make Function menus
-        * Usage: 50
         *
         * @param       mixed           $id is the "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=...
         * @param       string          $elementName it the form elements name, probably something like "SET[...]"
@@ -2716,7 +2652,6 @@ final class t3lib_BEfunc {
        /**
         * Checkbox function menu.
         * Works like ->getFuncMenu() but takes no $menuItem array since this is a simple checkbox.
-        * Usage: 34
         *
         * @param       mixed           $mainParams $id is the "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=...
         * @param       string          $elementName it the form elements name, probably something like "SET[...]"
@@ -2745,7 +2680,6 @@ final class t3lib_BEfunc {
        /**
         * Input field function menu
         * Works like ->getFuncMenu() / ->getFuncCheck() but displays a input field instead which updates the script "onchange"
-        * Usage: 1
         *
         * @param       mixed           $id is the "&id=" parameter value to be sent to the module, but it can be also a parameter array which will be passed instead of the &id=...
         * @param       string          $elementName it the form elements name, probably something like "SET[...]"
@@ -2774,7 +2708,6 @@ final class t3lib_BEfunc {
        /**
         * Removes menu items from $itemArray if they are configured to be removed by TSconfig for the module ($modTSconfig)
         * See Inside TYPO3 about how to program modules and use this API.
-        * Usage: 4
         *
         * @param       array           Module TS config array
         * @param       array           Array of items from which to remove items.
@@ -2797,7 +2730,6 @@ final class t3lib_BEfunc {
        /**
         * Call to update the page tree frame (or something else..?) after
         * use 'updatePageTree' as a first parameter will set the page tree to be updated.
-        * Usage: 10
         *
         * @param       string          Key to set the update signal. When setting, this value contains strings telling WHAT to set. At this point it seems that the value "updatePageTree" is the only one it makes sense to set. If empty, all update signals will be removed.
         * @param       mixed           Additional information for the update signal, used to only refresh a branch of the tree
@@ -2821,7 +2753,6 @@ final class t3lib_BEfunc {
        /**
         * Call to update the page tree frame (or something else..?) if this is set by the function
         * setUpdateSignal(). It will return some JavaScript that does the update (called in the typo3/template.php file, end() function)
-        * Usage: 1
         *
         * @return      string          HTML javascript code
         * @see t3lib_BEfunc::setUpdateSignal()
@@ -2884,7 +2815,6 @@ final class t3lib_BEfunc {
         * This is kind of session variable management framework for the backend users.
         * If a key from MOD_MENU is set in the CHANGED_SETTINGS array (eg. a value is passed to the script from the outside), this value is put into the settings-array
         * Ultimately, see Inside TYPO3 for how to use this function in relation to your modules.
-        * Usage: 23
         *
         * @param       array           MOD_MENU is an array that defines the options in menus.
         * @param       array           CHANGED_SETTINGS represents the array used when passing values to the script from the menus.
@@ -3062,7 +2992,6 @@ final class t3lib_BEfunc {
        /**
         * Unlock or Lock a record from $table with $uid
         * If $table and $uid is not set, then all locking for the current BE_USER is removed!
-        * Usage: 5
         *
         * @param       string          Table name
         * @param       integer         Record uid
@@ -3093,7 +3022,6 @@ final class t3lib_BEfunc {
        /**
         * Returns information about whether the record from table, $table, with uid, $uid is currently locked (edited by another user - which should issue a warning).
         * Notice: Locking is not strictly carried out since locking is abandoned when other backend scripts are activated - which means that a user CAN have a record "open" without having it locked. So this just serves as a warning that counts well in 90% of the cases, which should be sufficient.
-        * Usage: 5
         *
         * @param       string          Table name
         * @param       integer         Record uid
@@ -3150,7 +3078,6 @@ final class t3lib_BEfunc {
 
        /**
         * Returns select statement for MM relations (as used by TCEFORMs etc)
-        * Usage: 3
         *
         * @param       array           Configuration array for the field, taken from $GLOBALS['TCA']
         * @param       string          Field name
@@ -3238,7 +3165,6 @@ final class t3lib_BEfunc {
        /**
         * Returns TSConfig for the TCEFORM object in Page TSconfig.
         * Used in TCEFORMs
-        * Usage: 4
         *
         * @param       string          Table name present in TCA
         * @param       array           Row from table
@@ -3290,7 +3216,6 @@ final class t3lib_BEfunc {
        /**
         * Find the real PID of the record (with $uid from $table). This MAY be impossible if the pid is set as a reference to the former record or a page (if two records are created at one time).
         * NOTICE: Make sure that the input PID is never negative because the record was an offline version! Therefore, you should always use t3lib_BEfunc::fixVersioningPid($table,$row); on the data you input before calling this function!
-        * Usage: 2
         *
         * @param       string          Table name
         * @param       integer         Record uid
@@ -3333,7 +3258,6 @@ final class t3lib_BEfunc {
 
        /**
         * Return $uid if $table is pages and $uid is integer - otherwise the $pid
-        * Usage: 1
         *
         * @param       string          Table name
         * @param       integer         Record uid
@@ -3349,7 +3273,6 @@ final class t3lib_BEfunc {
 
        /**
         * Returns the REAL pid of the record, if possible. If both $uid and $pid is strings, then pid=-1 is returned as an error indication.
-        * Usage: 8
         *
         * @param       string          Table name
         * @param       integer         Record uid
@@ -3369,7 +3292,6 @@ final class t3lib_BEfunc {
 
        /**
         * Returns first found domain record "domainName" (without trailing slash) if found in the input $rootLine
-        * Usage: 2
         *
         * @param       array           Root line array
         * @return      string          Domain name, if found.
@@ -3388,7 +3310,6 @@ final class t3lib_BEfunc {
 
        /**
         * Returns the sys_domain record for $domain, optionally with $path appended.
-        * Usage: 2
         *
         * @param       string          Domain name
         * @param       string          Appended path
@@ -3417,7 +3338,6 @@ final class t3lib_BEfunc {
 
        /**
         * Returns overlayered RTE setup from an array with TSconfig. Used in TCEforms and TCEmain
-        * Usage: 8
         *
         * @param       array           The properties of Page TSconfig in the key "RTE."
         * @param       string          Table name
@@ -3545,7 +3465,6 @@ final class t3lib_BEfunc {
 
        /**
         * Returns TRUE if $modName is set and is found as a main- or submodule in $TBE_MODULES array
-        * Usage: 1
         *
         * @param       string          Module name
         * @return      boolean
@@ -4095,7 +4014,6 @@ final class t3lib_BEfunc {
 
        /**
         * Print error message with header, text etc.
-        * Usage: 19
         *
         * @param       string          Header string
         * @param       string          Content string
@@ -4344,7 +4262,6 @@ final class t3lib_BEfunc {
 
        /**
         * Returns "web" if the $path (absolute) is within the DOCUMENT ROOT - and thereby qualifies as a "web" folder.
-        * Usage: 4
         *
         * @param       string          Path to evaluate
         * @return      boolean
@@ -4355,7 +4272,6 @@ final class t3lib_BEfunc {
 
        /**
         * Creates ADMCMD parameters for the "viewpage" extension / "cms" frontend
-        * Usage: 1
         *
         * @param       array           Page record
         * @return      string          Query-parameters
@@ -4378,7 +4294,6 @@ final class t3lib_BEfunc {
         * Returns an array with key=>values based on input text $params
         * $params is exploded by line-breaks and each line is supposed to be on the syntax [key] = [some value]
         * These pairs will be parsed into an array an returned.
-        * Usage: 1
         *
         * @param       string          String of parameters on multiple lines to parse into key-value pairs (see function description)
         * @return      array
@@ -4449,4 +4364,4 @@ final class t3lib_BEfunc {
        }
 }
 
-?>
+?>
\ No newline at end of file
index 3d614e4..a0f7233 100644 (file)
  *
  *  This copyright notice MUST APPEAR in all copies of the script!
  ***************************************************************/
+
 /**
  * Contains the class "t3lib_db" containing functions for building SQL queries
  * and mysql wrappers, thus providing a foundational API to all database
  * interaction.
  * This class is instantiated globally as $TYPO3_DB in TYPO3 scripts.
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
- */
-
-
-/**
  * TYPO3 "database wrapper" class (new in 3.6.0)
  * This class contains
  * - abstraction functions for executing INSERT/UPDATE/DELETE/SELECT queries ("Query execution"; These are REQUIRED for all future connectivity to the database, thus ensuring DBAL compliance!)
@@ -60,7 +56,6 @@
  */
 class t3lib_DB {
 
-
                // Debug:
        var $debugOutput = FALSE; // Set "TRUE" or "1" if you want database errors outputted. Set to "2" if you also want successful database actions outputted.
        var $debug_lastBuiltQuery = ''; // Internally: Set to last built query (not necessarily executed...)
@@ -100,7 +95,6 @@ class t3lib_DB {
        /**
         * Creates and executes an INSERT SQL-statement for $table from the array with field/value pairs $fields_values.
         * Using this function specifically allows us to handle BLOB and CLOB fields depending on DB
-        * Usage count/core: 47
         *
         * @param       string          Table name
         * @param       array           Field values as key=>value pairs. Values will be escaped internally. Typically you would fill an array like "$insertFields" with 'fieldname'=>'value' and pass it to this function as argument.
@@ -141,7 +135,6 @@ class t3lib_DB {
        /**
         * Creates and executes an UPDATE SQL-statement for $table where $where-clause (typ. 'uid=...') from the array with field/value pairs $fields_values.
         * Using this function specifically allow us to handle BLOB and CLOB fields depending on DB
-        * Usage count/core: 50
         *
         * @param       string          Database tablename
         * @param       string          WHERE clause, eg. "uid=1". NOTICE: You must escape values in this argument with $this->fullQuoteStr() yourself!
@@ -162,7 +155,6 @@ class t3lib_DB {
 
        /**
         * Creates and executes a DELETE SQL-statement for $table where $where-clause
-        * Usage count/core: 40
         *
         * @param       string          Database tablename
         * @param       string          WHERE clause, eg. "uid=1". NOTICE: You must escape values in this argument with $this->fullQuoteStr() yourself!
@@ -182,7 +174,6 @@ class t3lib_DB {
        /**
         * Creates and executes a SELECT SQL-statement
         * Using this function specifically allow us to handle the LIMIT feature independently of DB.
-        * Usage count/core: 340
         *
         * @param       string          List of fields to select from the table. This is what comes right after "SELECT ...". Required value.
         * @param       string          Table(s) from which to select. This is what comes right after "FROM ...". Required value.
@@ -212,8 +203,6 @@ class t3lib_DB {
         * The JOIN is done with [$local_table].uid <--> [$mm_table].uid_local  / [$mm_table].uid_foreign <--> [$foreign_table].uid
         * The function is very useful for selecting MM-relations between tables adhering to the MM-format used by TCE (TYPO3 Core Engine). See the section on $GLOBALS['TCA'] in Inside TYPO3 for more details.
         *
-        * Usage: 12 (spec. ext. sys_action, sys_messages, sys_todos)
-        *
         * @param       string          Field list for SELECT
         * @param       string          Tablename, local table
         * @param       string          Tablename, relation table
@@ -254,8 +243,6 @@ class t3lib_DB {
        /**
         * Executes a select based on input query parts array
         *
-        * Usage: 9
-        *
         * @param       array           Query parts array
         * @return      pointer         MySQL select result pointer / DBAL object
         * @see exec_SELECTquery()
@@ -381,7 +368,6 @@ class t3lib_DB {
 
        /**
         * Creates an INSERT SQL-statement for $table from the array with field/value pairs $fields_values.
-        * Usage count/core: 4
         *
         * @param       string          See exec_INSERTquery()
         * @param       array           See exec_INSERTquery()
@@ -454,7 +440,6 @@ class t3lib_DB {
 
        /**
         * Creates an UPDATE SQL-statement for $table where $where-clause (typ. 'uid=...') from the array with field/value pairs $fields_values.
-        * Usage count/core: 6
         *
         * @param       string          See exec_UPDATEquery()
         * @param       string          See exec_UPDATEquery()
@@ -499,7 +484,6 @@ class t3lib_DB {
 
        /**
         * Creates a DELETE SQL-statement for $table where $where-clause
-        * Usage count/core: 3
         *
         * @param       string          See exec_DELETEquery()
         * @param       string          See exec_DELETEquery()
@@ -529,7 +513,6 @@ class t3lib_DB {
 
        /**
         * Creates a SELECT SQL-statement
-        * Usage count/core: 11
         *
         * @param       string          See exec_SELECTquery()
         * @param       string          See exec_SELECTquery()
@@ -734,7 +717,6 @@ class t3lib_DB {
 
        /**
         * Escaping and quoting values for SQL statements.
-        * Usage count/core: 100
         *
         * @param       string          Input string
         * @param       string          Table name for which to quote string. Just enter the table that the field-value is selected from (and any DBAL will look up which handler to use and then how to quote the string!).
@@ -775,8 +757,6 @@ class t3lib_DB {
         * Use this function instead of the PHP addslashes() function when you build queries - this will prepare your code for DBAL.
         * NOTICE: You must wrap the output of this function in SINGLE QUOTES to be DBAL compatible. Unless you have to apply the single quotes yourself you should rather use ->fullQuoteStr()!
         *
-        * Usage count/core: 20
-        *
         * @param       string          Input string
         * @param       string          Table name for which to quote string. Just enter the table that the field-value is selected from (and any DBAL will look up which handler to use and then how to quote the string!).
         * @return      string          Output string; Quotes (" / ') and \ will be backslashed (or otherwise based on DBAL handler)
@@ -801,7 +781,6 @@ class t3lib_DB {
        /**
         * Will convert all values in the one-dimensional array to integers.
         * Useful when you want to make sure an array contains only integers before imploding them in a select-list.
-        * Usage count/core: 7
         *
         * @param       array           Array with values
         * @return      array           The input array with all values passed through intval()
@@ -817,7 +796,6 @@ class t3lib_DB {
        /**
         * Will force all entries in the input comma list to integers
         * Useful when you want to make sure a commalist of supposed integers really contain only integers; You want to know that when you don't trust content that could go into an SQL statement.
-        * Usage count/core: 6
         *
         * @param       string          List of comma-separated values which should be integers
         * @return      string          The input list but with every value passed through intval()
@@ -831,7 +809,6 @@ class t3lib_DB {
         * Removes the prefix "ORDER BY" from the input string.
         * This function is used when you call the exec_SELECTquery() function and want to pass the ORDER BY parameter by can't guarantee that "ORDER BY" is not prefixed.
         * Generally; This function provides a work-around to the situation where you cannot pass only the fields by which to order the result.
-        * Usage count/core: 11
         *
         * @param       string          eg. "ORDER BY title, uid"
         * @return      string          eg. "title, uid"
@@ -845,7 +822,6 @@ class t3lib_DB {
         * Removes the prefix "GROUP BY" from the input string.
         * This function is used when you call the SELECTquery() function and want to pass the GROUP BY parameter by can't guarantee that "GROUP BY" is not prefixed.
         * Generally; This function provides a work-around to the situation where you cannot pass only the fields by which to order the result.
-        * Usage count/core: 1
         *
         * @param       string          eg. "GROUP BY title, uid"
         * @return      string          eg. "title, uid"
@@ -858,7 +834,6 @@ class t3lib_DB {
        /**
         * Takes the last part of a query, eg. "... uid=123 GROUP BY title ORDER BY title LIMIT 5,2" and splits each part into a table (WHERE, GROUPBY, ORDERBY, LIMIT)
         * Work-around function for use where you know some userdefined end to an SQL clause is supplied and you need to separate these factors.
-        * Usage count/core: 13
         *
         * @param       string          Input string
         * @return      array
@@ -915,7 +890,6 @@ class t3lib_DB {
         * mysql_query() wrapper function
         * Beware: Use of this method should be avoided as it is experimentally supported by DBAL. You should consider
         *         using exec_SELECTquery() and similar methods instead.
-        * Usage count/core: 1
         *
         * @param       string          Query to execute
         * @return      pointer         Result pointer / DBAL object
@@ -931,7 +905,6 @@ class t3lib_DB {
        /**
         * Returns the error status on the last sql() execution
         * mysql_error() wrapper function
-        * Usage count/core: 32
         *
         * @return      string          MySQL error string.
         */
@@ -952,7 +925,6 @@ class t3lib_DB {
        /**
         * Returns the number of selected rows.
         * mysql_num_rows() wrapper function
-        * Usage count/core: 85
         *
         * @param       pointer         MySQL result pointer (of SELECT query) / DBAL object
         * @return      integer         Number of resulting rows
@@ -968,7 +940,6 @@ class t3lib_DB {
        /**
         * Returns an associative array that corresponds to the fetched row, or FALSE if there are no more rows.
         * mysql_fetch_assoc() wrapper function
-        * Usage count/core: 307
         *
         * @param       pointer         MySQL result pointer (of SELECT query) / DBAL object
         * @return      array           Associative array of result row.
@@ -985,7 +956,6 @@ class t3lib_DB {
         * Returns an array that corresponds to the fetched row, or FALSE if there are no more rows.
         * The array contains the values in numerical indices.
         * mysql_fetch_row() wrapper function
-        * Usage count/core: 56
         *
         * @param       pointer         MySQL result pointer (of SELECT query) / DBAL object
         * @return      array           Array with result rows.
@@ -1001,7 +971,6 @@ class t3lib_DB {
        /**
         * Free result memory
         * mysql_free_result() wrapper function
-        * Usage count/core: 3
         *
         * @param       pointer         MySQL result pointer to free / DBAL object
         * @return      boolean         Returns TRUE on success or FALSE on failure.
@@ -1017,7 +986,6 @@ class t3lib_DB {
        /**
         * Get the ID generated from the previous INSERT operation
         * mysql_insert_id() wrapper function
-        * Usage count/core: 13
         *
         * @return      integer         The uid of the last inserted record.
         */
@@ -1028,7 +996,6 @@ class t3lib_DB {
        /**
         * Returns the number of rows affected by the last INSERT, UPDATE or DELETE query
         * mysql_affected_rows() wrapper function
-        * Usage count/core: 1
         *
         * @return      integer         Number of rows affected by last query
         */
@@ -1039,7 +1006,6 @@ class t3lib_DB {
        /**
         * Move internal result pointer
         * mysql_data_seek() wrapper function
-        * Usage count/core: 3
         *
         * @param       pointer         MySQL result pointer (of SELECT query) / DBAL object
         * @param       integer         Seek result number.
@@ -1056,7 +1022,6 @@ class t3lib_DB {
        /**
         * Get the type of the specified field in a result
         * mysql_field_type() wrapper function
-        * Usage count/core: 2
         *
         * @param       pointer         MySQL result pointer (of SELECT query) / DBAL object
         * @param       integer         Field index.
@@ -1073,7 +1038,6 @@ class t3lib_DB {
        /**
         * Open a (persistent) connection to a MySQL server
         * mysql_pconnect() wrapper function
-        * Usage count/core: 12
         *
         * @param       string          Database host IP/domain
         * @param       string          Username to connect with.
@@ -1168,7 +1132,6 @@ class t3lib_DB {
        /**
         * Select a MySQL database
         * mysql_select_db() wrapper function
-        * Usage count/core: 8
         *
         * @param       string          Database to connect to.
         * @return      boolean         Returns TRUE on success or FALSE on failure.
@@ -1198,7 +1161,6 @@ class t3lib_DB {
         * This is only used as a service function in the (1-2-3 process) of the Install Tool.
         * In any case a lookup should be done in the _DEFAULT handler DBMS then.
         * Use in Install Tool only!
-        * Usage count/core: 1
         *
         * @return      array           Each entry represents a database name
         */
@@ -1217,7 +1179,6 @@ class t3lib_DB {
         * Returns the list of tables from the default database, TYPO3_db (quering the DBMS)
         * In a DBAL this method should 1) look up all tables from the DBMS  of
         * the _DEFAULT handler and then 2) add all tables *configured* to be managed by other handlers
-        * Usage count/core: 2
         *
         * @return      array           Array with tablenames as key and arrays with status information as value
         */
@@ -1309,7 +1270,6 @@ class t3lib_DB {
 
        /**
         * mysql() wrapper function, used by the Install Tool and EM for all queries regarding management of the database!
-        * Usage count/core: 10
         *
         * @param       string          Query to execute
         * @return      pointer         Result pointer
index 540557b..a9310b8 100644 (file)
  *
  *  This copyright notice MUST APPEAR in all copies of the script!
  ***************************************************************/
-/**
- * Contains a class with Extension Management functions
- *
- * Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj
- *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
- */
-
 
 /**
  * Extension Management functions
  * This class is never instantiated, rather the methods inside is called as functions like
  *              t3lib_extMgm::isLoaded('my_extension');
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage t3lib
  */
 final class t3lib_extMgm {
+
        protected static $extensionKeyMap;
 
 
@@ -55,7 +48,6 @@ final class t3lib_extMgm {
 
        /**
         * Returns TRUE if the extension with extension key $key is loaded.
-        * Usage: 109
         *
         * @param       string          Extension key to test
         * @param       boolean         If $exitOnError is TRUE and the extension is not loaded the function will die with an error message
@@ -75,7 +67,6 @@ final class t3lib_extMgm {
         * Returns the absolute path to the extension with extension key $key
         * If the extension is not loaded the function will die with an error message
         * Useful for internal fileoperations
-        * Usage: 136
         *
         * @param $key string Extension key
         * @param $script string $script is appended to the output if set.
@@ -124,7 +115,6 @@ final class t3lib_extMgm {
         * Returns the relative path to the extension as measured from from the TYPO3_mainDir
         * If the extension is not loaded the function will die with an error message
         * Useful for images and links from backend
-        * Usage: 54
         *
         * @param       string          Extension key
         * @return      string
@@ -143,7 +133,6 @@ final class t3lib_extMgm {
         * Returns the relative path to the extension as measured from the PATH_site (frontend)
         * If the extension is not loaded the function will die with an error message
         * Useful for images and links from the frontend
-        * Usage: 6
         *
         * @param       string          Extension key
         * @return      string
@@ -154,7 +143,6 @@ final class t3lib_extMgm {
 
        /**
         * Returns the correct class name prefix for the extension key $key
-        * Usage: 3
         *
         * @param       string          Extension key
         * @return      string
@@ -240,7 +228,6 @@ final class t3lib_extMgm {
         * This function adds the configuration needed for rendering of the field in TCEFORMS - but it does NOT add the field names to the types lists!
         * So to have the fields displayed you must also call fx. addToAllTCAtypes or manually add the fields to the types list.
         * FOR USE IN ext_tables.php FILES
-        * Usage: 4
         *
         * @param       string          $table is the table name of a table already present in $GLOBALS['TCA'] with a columns section
         * @param       array           $columnArray is the array with the additional columns (typical some fields an extension wants to add)
@@ -265,7 +252,6 @@ final class t3lib_extMgm {
         * This is needed to have new fields shown automatically in the TCEFORMS of a record from $table.
         * Typically this function is called after having added new columns (database fields) with the addTCAcolumns function
         * FOR USE IN ext_tables.php FILES
-        * Usage: 1
         *
         * @param       string          Table name
         * @param       string          Field list to add.
@@ -756,7 +742,6 @@ final class t3lib_extMgm {
         * Add tablename to default list of allowed tables on pages (in $PAGES_TYPES)
         * Will add the $table to the list of tables allowed by default on pages as setup by $PAGES_TYPES['default']['allowedTables']
         * FOR USE IN ext_tables.php FILES
-        * Usage: 11
         *
         * @param       string          Table name
         * @return      void
@@ -768,7 +753,6 @@ final class t3lib_extMgm {
        /**
         * Adds a module (main or sub) to the backend interface
         * FOR USE IN ext_tables.php FILES
-        * Usage: 18
         *
         * @param       string          $main is the main module key, $sub is the submodule key. So $main would be an index in the $TBE_MODULES array and $sub could be an element in the lists there.
         * @param       string          $sub is the submodule key. If $sub is not set a blank $main module is created.
@@ -904,7 +888,6 @@ final class t3lib_extMgm {
         * The arguments values are generally determined by which function menu this is supposed to interact with
         * See Inside TYPO3 for information on how to use this function.
         * FOR USE IN ext_tables.php FILES
-        * Usage: 26
         *
         * @param       string          Module name
         * @param       string          Class name
@@ -928,7 +911,6 @@ final class t3lib_extMgm {
         * Adds $content to the default Page TSconfig as set in $GLOBALS['TYPO3_CONF_VARS'][BE]['defaultPageTSconfig']
         * Prefixed with a [GLOBAL] line
         * FOR USE IN ext_tables.php/ext_localconf.php FILES
-        * Usage: 5
         *
         * @param       string          Page TSconfig content
         * @return      void
@@ -941,7 +923,6 @@ final class t3lib_extMgm {
         * Adds $content to the default User TSconfig as set in $GLOBALS['TYPO3_CONF_VARS'][BE]['defaultUserTSconfig']
         * Prefixed with a [GLOBAL] line
         * FOR USE IN ext_tables.php/ext_localconf.php FILES
-        * Usage: 3
         *
         * @param       string          User TSconfig content
         * @return      void
@@ -954,7 +935,6 @@ final class t3lib_extMgm {
         * Adds a reference to a locallang file with $GLOBALS['TCA_DESCR'] labels
         * FOR USE IN ext_tables.php FILES
         * eg. t3lib_extMgm::addLLrefForTCAdescr('pages', 'EXT:lang/locallang_csh_pages.xml'); for the pages table or t3lib_extMgm::addLLrefForTCAdescr('_MOD_web_layout', 'EXT:cms/locallang_csh_weblayout.php'); for the Web > Page module.
-        * Usage: 31
         *
         * @param       string          Description key. Typically a database table (like "pages") but for applications can be other strings, but prefixed with "_MOD_")
         * @param       string          File reference to locallang file, eg. "EXT:lang/locallang_csh_pages.php" (or ".xml")
@@ -1175,7 +1155,6 @@ final class t3lib_extMgm {
         * If the value (array pos. 1) is already found in that items-array, the entry is substituted, otherwise the input array is added to the bottom.
         * Use this function to add a frontend plugin to this list of plugin-types - or more generally use this function to add an entry to any selectorbox/radio-button set in the TCEFORMS
         * FOR USE IN ext_tables.php FILES
-        * Usage: 13
         *
         * @param       array           Item Array
         * @param       string          Type (eg. "list_type") - basically a field from "tt_content" table
@@ -1202,7 +1181,6 @@ final class t3lib_extMgm {
        /**
         * Adds an entry to the "ds" array of the tt_content field "pi_flexform".
         * This is used by plugins to add a flexform XML reference / content for use when they are selected as plugin or content element.
-        * Usage: 0
         *
         * @param       string          Plugin key as used in the list_type field. Use the asterisk * to match all list_type values.
         * @param       string          Either a reference to a flex-form XML file (eg. "FILE:EXT:newloginbox/flexform_ds.xml") or the XML directly.
@@ -1222,7 +1200,6 @@ final class t3lib_extMgm {
         * Adds the $table tablename to the list of tables allowed to be includes by content element type "Insert records"
         * By using $content_table and $content_field you can also use the function for other tables.
         * FOR USE IN ext_tables.php FILES
-        * Usage: 9
         *
         * @param       string          Table name to allow for "insert record"
         * @param       string          Table name TO WHICH the $table name is applied. See $content_field as well.
@@ -1250,7 +1227,6 @@ final class t3lib_extMgm {
         *               "includeLib" - just includes the library for manual use somewhere in TypoScript.
         *       (Remember that your $type definition should correspond to the column/items array in $GLOBALS['TCA'][tt_content] where you added the selector item for the element! See addPlugin() function)
         * FOR USE IN ext_localconf.php FILES
-        * Usage: 2
         *
         * @param       string          $key is the extension key
         * @param       string          $classFile is the PHP-class filename relative to the extension root directory. If set to blank a default value is chosen according to convensions.
@@ -1316,7 +1292,6 @@ tt_content.' . $key . $prefix . ' {
         * Call this method to add an entry in the static template list found in sys_templates
         * "static template files" are the modern equivalent (provided from extensions) to the traditional records in "static_templates"
         * FOR USE IN ext_localconf.php FILES
-        * Usage: 3
         *
         * @param       string          $extKey is of course the extension key
         * @param       string          $path is the path where the template files (fixed names) include_static.txt (integer list of uids from the table "static_templates"), constants.txt, setup.txt, editorcfg.txt, and include_static_file.txt is found (relative to extPath, eg. 'static/'). The file include_static_file.txt, allows you to include other static templates defined in files, from your static template, and thus corresponds to the field 'include_static_file' in the sys_template table. The syntax for this is a commaseperated list of static templates to include, like:  EXT:css_styled_content/static/,EXT:da_newsletter_subscription/static/,EXT:cc_random_image/pi2/static/
@@ -1337,7 +1312,6 @@ tt_content.' . $key . $prefix . ' {
         * Adds $content to the default TypoScript setup code as set in $GLOBALS['TYPO3_CONF_VARS'][FE]['defaultTypoScript_setup']
         * Prefixed with a [GLOBAL] line
         * FOR USE IN ext_localconf.php FILES
-        * Usage: 6
         *
         * @param       string          TypoScript Setup string
         * @return      void
@@ -1350,7 +1324,6 @@ tt_content.' . $key . $prefix . ' {
         * Adds $content to the default TypoScript constants code as set in $GLOBALS['TYPO3_CONF_VARS'][FE]['defaultTypoScript_constants']
         * Prefixed with a [GLOBAL] line
         * FOR USE IN ext_localconf.php FILES
-        * Usage: 0
         *
         * @param       string          TypoScript Constants string
         * @return      void
@@ -1363,7 +1336,6 @@ tt_content.' . $key . $prefix . ' {
         * Adds $content to the default TypoScript code for either setup, constants or editorcfg as set in $GLOBALS['TYPO3_CONF_VARS'][FE]['defaultTypoScript_*']
         * (Basically this function can do the same as addTypoScriptSetup and addTypoScriptConstants - just with a little more hazzle, but also with some more options!)
         * FOR USE IN ext_localconf.php FILES
-        * Usage: 7
         *
         * @param       string          $key is the extension key (informative only).
         * @param       string          $type is either "setup", "constants" or "editorcfg" and obviously determines which kind of TypoScript code we are adding.
@@ -1414,7 +1386,6 @@ tt_content.' . $key . $prefix . ' {
         *
         * Usages of this function can be seen in config_default.php
         * Extensions are always detected in the order local - global - system.
-        * Usage: 1
         *
         * @return      array           Extension Array
         * @internal
@@ -1522,7 +1493,6 @@ $_EXTCONF = $GLOBALS[\'TYPO3_CONF_VARS\'][\'EXT\'][\'extConf\'][$_EXTKEY];
 
        /**
         * Returns TRUE if the "localconf.php" file in "typo3conf/" is writable
-        * Usage: 1
         *
         * @return      boolean
         * @internal
@@ -1534,7 +1504,6 @@ $_EXTCONF = $GLOBALS[\'TYPO3_CONF_VARS\'][\'EXT\'][\'extConf\'][$_EXTKEY];
        /**
         * Returns an error string if typo3conf/ or cache-files with $cacheFilePrefix are NOT writable
         * Returns FALSE if no problem.
-        * Usage: 1
         *
         * @param       string          Prefix of the cache file to check
         * @return      string
@@ -1559,7 +1528,6 @@ $_EXTCONF = $GLOBALS[\'TYPO3_CONF_VARS\'][\'EXT\'][\'extConf\'][$_EXTKEY];
        /**
         * Returns an array with the two cache-files (0=>localconf, 1=>tables) from typo3conf/ if they (both) exist. Otherwise FALSE.
         * Evaluation relies on $GLOBALS['TYPO3_LOADED_EXT']['_CACHEFILE']
-        * Usage: 2
         *
         * @param string $cacheFilePrefix Cache file prefix to be used (optional)
         * @return      array
@@ -1590,7 +1558,6 @@ $_EXTCONF = $GLOBALS[\'TYPO3_CONF_VARS\'][\'EXT\'][\'extConf\'][$_EXTKEY];
        /**
         * Compiles/Creates the two cache-files in typo3conf/ based on $cacheFilePrefix
         * Returns a array with the key "_CACHEFILE" set to the $cacheFilePrefix value
-        * Usage: 1
         *
         * @param       array           Extension information array
         * @param       string          Prefix for the cache files
index f98fe39..2641b16 100644 (file)
  *
  *  This copyright notice MUST APPEAR in all copies of the script!
  ***************************************************************/
-/**
- * Contains class for icon generation in the backend
- *
- * Revised for TYPO3 3.6 July/2003 by Kasper Skårhøj
- * XHTML compliant
- *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
- */
-
 
 /**
- * Icon generation, backend
+ * Contains class for icon generation in the backend
  * This library has functions that returns - and if necessary creates - the icon for an element in TYPO3
  *
  * Expects global vars:
@@ -49,7 +40,7 @@
  * The class is included in eg. init.php
  * ALL functions called without making a class instance, eg. "t3lib_iconWorks::getIconImage()"
  *
- * @author     Kasper Skårhøj <kasperYYYY@typo3.com>
+ * @author Kasper Skårhøj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage t3lib
  */
@@ -124,7 +115,6 @@ 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.
-        * Usage: 60
         *
         * @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!)
@@ -148,7 +138,6 @@ final class t3lib_iconWorks {
        /**
         * Creates the icon for input table/row
         * Returns filename for the image icon, relative to PATH_typo3
-        * Usage: 24
         *
         * @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!)
@@ -309,7 +298,6 @@ 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
-        * Usage: 336
         *
         * @param       string          Current backpath to PATH_typo3 folder
         * @param       string          Icon file name relative to PATH_typo3 folder