Fixed bug #10087: Deprecation annotations are wrong for TYPO3 3.6 and 3.5
authorMartin Kutschker <martin.t.kutschker@blackbox.net>
Fri, 9 Jan 2009 21:32:33 +0000 (21:32 +0000)
committerMartin Kutschker <martin.t.kutschker@blackbox.net>
Fri, 9 Jan 2009 21:32:33 +0000 (21:32 +0000)
git-svn-id: https://svn.typo3.org/TYPO3v4/Core/trunk@4675 709f56b5-9817-0410-a4d7-c38de5d9e867

14 files changed:
ChangeLog
t3lib/class.t3lib_befunc.php
t3lib/class.t3lib_beuserauth.php
t3lib/class.t3lib_db.php
t3lib/class.t3lib_div.php
t3lib/class.t3lib_tstemplate.php
t3lib/class.t3lib_userauth.php
t3lib/stddb/tables.php
typo3/sysext/cms/tslib/class.tslib_content.php
typo3/sysext/cms/tslib/class.tslib_fe.php
typo3/sysext/cms/tslib/class.tslib_fetce.php
typo3/sysext/cms/tslib/class.tslib_menu.php
typo3/sysext/cms/tslib/class.tslib_pibase.php
typo3/template.php

index d604ddb..6d7d7fd 100755 (executable)
--- a/ChangeLog
+++ b/ChangeLog
@@ -2,6 +2,7 @@
 2008-01-09  Martin Kutschker  <masi@typo3.org>
 
        * Fixed bug #10086: Core uses deprecated function t3lib_db->sql()
+       * Fixed bug #10087: Deprecation annotations are wrong for TYPO3 3.6 and 3.5
 
 2009-01-09  Oliver Hader  <oliver@typo3.org>
 
index f2b10f5..d7bfad1 100755 (executable)
@@ -341,7 +341,7 @@ final class t3lib_BEfunc {
         * @param       array           Array of fields
         * @param       string          Table in which we are searching (for DBAL detection of quoteStr() method)
         * @return      string          WHERE clause for search
-        * @deprecated since TYPO3 4.0 - Use $GLOBALS['TYPO3_DB']->searchQuery() directly!
+        * @deprecated since TYPO3 3.6 - Use $GLOBALS['TYPO3_DB']->searchQuery() directly!
         */
        public static function searchQuery($searchWords, $fields, $table = '') {
                return $GLOBALS['TYPO3_DB']->searchQuery($searchWords, $fields, $table);
@@ -356,7 +356,7 @@ final class t3lib_BEfunc {
         * @param       string          Table field name
         * @param       string          Value to find in list
         * @return      string          WHERE clause for a query
-        * @deprecated since TYPO3 4.0 - Use $GLOBALS['TYPO3_DB']->listQuery() directly!
+        * @deprecated since TYPO3 3.6 - Use $GLOBALS['TYPO3_DB']->listQuery() directly!
         */
        public static function listQuery($field, $value) {
                return $GLOBALS['TYPO3_DB']->listQuery($field, $value, '');
@@ -489,7 +489,6 @@ final class t3lib_BEfunc {
         * $local_table and $mm_table is mandatory. $foreign_table is optional.
         * 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 $TCA in Inside TYPO3 for more details.
-        * DEPRECATED - Use $GLOBALS['TYPO3_DB']->exec_SELECT_mm_query() instead since that will return the result pointer while this returns the query. Using this function may make your application less fitted for DBAL later.
         *
         * @param       string          Field list for SELECT
         * @param       string          Tablename, local table
@@ -500,7 +499,7 @@ final class t3lib_BEfunc {
         * @param       string          Optional ORDER BY field(s), if none, supply blank string.
         * @param       string          Optional LIMIT value ([begin,]max), if none, supply blank string.
         * @return      string          Full SQL query
-        * @deprecated since TYPO3 4.0
+        * @deprecated since TYPO3 3.6 - Use $GLOBALS['TYPO3_DB']->exec_SELECT_mm_query() instead since that will return the result pointer while this returns the query. Using this function may make your application less fitted for DBAL later.
         * @see t3lib_DB::exec_SELECT_mm_query()
         */
        public static function mm_query($select, $local_table, $mm_table, $foreign_table, $whereClause = '', $groupBy = '', $orderBy = '', $limit = '') {
@@ -523,7 +522,7 @@ final class t3lib_BEfunc {
         * @param       string          Table name
         * @param       array           Field values as key=>value pairs.
         * @return      string          Full SQL query for INSERT
-        * @deprecated since TYPO3 4.0
+        * @deprecated since TYPO3 3.6
         */
        public static function DBcompileInsert($table, $fields_values) {
                return $GLOBALS['TYPO3_DB']->INSERTquery($table, $fields_values);
@@ -537,7 +536,7 @@ final class t3lib_BEfunc {
         * @param       string          WHERE clause, eg. "uid=1"
         * @param       array           Field values as key=>value pairs.
         * @return      string          Full SQL query for UPDATE
-        * @deprecated since TYPO3 4.0
+        * @deprecated since TYPO3 3.6
         */
        public static function DBcompileUpdate($table, $where, $fields_values) {
                return $GLOBALS['TYPO3_DB']->UPDATEquery($table, $where, $fields_values);
@@ -1642,7 +1641,7 @@ final class t3lib_BEfunc {
         * @param       string          String to set as title-attribute. If no $content is given only the attribute name is returned.
         * @param       boolean         If $hsc is set, then content of the attribute is htmlspecialchar()'ed (which is good for XHTML and other reasons...)
         * @return      string
-        * @deprecated since TYPO3 4.0 - The idea made sense with older browsers, but now all browsers should support the "title" attribute - so just hardcode the title attribute instead!
+        * @deprecated since TYPO3 3.6 - The idea made sense with older browsers, but now all browsers should support the "title" attribute - so just hardcode the title attribute instead!
         */
        public static function titleAttrib($content = '', $hsc = 0) {
                global $CLIENT;
@@ -4082,7 +4081,7 @@ final class t3lib_BEfunc {
 
        /**
         * Returns "list of backend modules". Most likely this will be obsolete soon / removed. Don't use.
-        * Usage: 3
+        * Usage: 0
         *
         * @param       array           Module names in array. Must be "addslashes()"ed
         * @param       string          Perms clause for SQL query
@@ -4090,7 +4089,7 @@ final class t3lib_BEfunc {
         * @param       string          The URL/script to jump to (used in A tag)
         * @return      array           Two keys, rows and list
         * @internal
-        * @deprecated since TYPO3 4.0
+        * @deprecated since TYPO3 3.6
         * @obsolete
         */
        public static function getListOfBackendModules($name, $perms_clause, $backPath = '', $script = 'index.php') {
index 8be9122..8e7dbf6 100644 (file)
@@ -145,7 +145,7 @@ class t3lib_beUserAuth extends t3lib_userAuthGroup {
         *
         * @param       boolean         Activate insertion of the URL.
         * @return      void
-        * @access private
+        * @deprecated since TYPO3 3.6
         */
        function trackBeUser($flag)     {
                if ($flag && t3lib_extMgm::isLoaded('beuser_tracking')) {
index 9f5deb4..e69d74a 100755 (executable)
@@ -741,12 +741,13 @@ class t3lib_DB {
        /**
         * Executes query
         * mysql() wrapper function
-        * DEPRECATED - use exec_* functions from this class instead!
-        * Usage count/core: 9
+        * Usage count/core: 0
         *
         * @param       string          Database name
         * @param       string          Query to execute
         * @return      pointer         Result pointer / DBAL object
+        * @deprecated since TYPO3 3.6
+        * @see sql_query()
         */
        function sql($db,$query)        {
                $res = mysql_query($query, $this->link);
index baa4d36..a459165 100755 (executable)
@@ -385,7 +385,7 @@ final class t3lib_div {
         * @param       string          GET/POST var to return
         * @param       boolean         If set, values are stripped of return values that are *arrays!* - string/integer values returned are always strip-slashed()
         * @return      mixed           POST var named $var and if not set, the GET var of the same name.
-        * @deprecated since TYPO3 3.7 - Use t3lib_div::_GP instead (ALWAYS delivers a value with un-escaped values!)
+        * @deprecated since TYPO3 3.6 - Use t3lib_div::_GP instead (ALWAYS delivers a value with un-escaped values!)
         * @see _GP()
         */
        public static function GPvar($var,$strip=0)     {
@@ -1170,7 +1170,7 @@ final class t3lib_div {
         *
         * @param       string          String to process
         * @return      string
-        * @deprecated since TYPO3 4.1 - Use t3lib_cs::conv_case() instead or for HTML output, wrap your content in <span class="uppercase">...</span>)
+        * @deprecated since TYPO3 3.5 - Use t3lib_cs::conv_case() instead or for HTML output, wrap your content in <span class="uppercase">...</span>)
         * @ignore
         */
        public static function danish_strtoupper($string)       {
@@ -1668,7 +1668,7 @@ final class t3lib_div {
         * @param       array           Array of values to make unique
         * @return      array
         * @ignore
-        * @deprecated since TYPO3 4.1 - Use the PHP function array_unique instead
+        * @deprecated since TYPO3 3.5 - Use the PHP function array_unique instead
         */
        public static function uniqueArray(array $valueArray)   {
                return array_unique($valueArray);
index 8edeb6e..8101d0e 100755 (executable)
@@ -1230,7 +1230,7 @@ class t3lib_TStemplate    {
         * @param       string          Property name in the menu array
         * @param       array           Menu array to traverse
         * @return      array           Modified menu array
-        * @deprecated since TYPO3 4.0
+        * @deprecated since TYPO3 3.6
         * @internal
         */
        function checkFile($name,$menuArr)      {
index 5fb118f..8f96ed9 100755 (executable)
@@ -1126,9 +1126,11 @@ class t3lib_userAuth {
        }
 
        /**
-        * Redirect to somewhere. Obsolete, deprecated etc.
+        * Redirect to somewhere (obsolete).
         *
         * @return      void
+        * @deprecated since TYPO3 3.6
+        * @obsolete
         * @ignore
         */
        function redirect() {
index fc6d290..8bf090b 100755 (executable)
@@ -87,8 +87,8 @@ $ICON_TYPES = array();
 /**
  * Commonly used language labels which can be used in the $TCA array and elsewhere.
  * Obsolete - just use the values of each entry directly.
- *
- * @deprecated since TYPO3 3.7
+ * @todo turn into an object with magic getters and setter so we can make use of the deprecation logging
+ * @deprecated since TYPO3 3.6
  */
 $LANG_GENERAL_LABELS = array(
        'endtime' => 'LLL:EXT:lang/locallang_general.php:LGL.endtime',
index 5042395..cb113e9 100755 (executable)
@@ -6122,7 +6122,7 @@ class tslib_cObj {
         * @param       string          Labels for bytes, kilo, mega and giga separated by vertical bar (|) and possibly encapsulated in "". Eg: " | K| M| G" (which is the default value)
         * @return      string
         * @see t3lib_div::formatSize(), stdWrap()
-        * @deprecated since TYPO3 4.0 - Use t3lib_div::formatSize() instead
+        * @deprecated since TYPO3 3.6 - Use t3lib_div::formatSize() instead
         */
        function bytes($sizeInBytes,$labels)    {
                return t3lib_div::formatSize($sizeInBytes,$labels);
@@ -6208,7 +6208,7 @@ class tslib_cObj {
         * @param       string          Input string to evaluate
         * @return      boolean         Returns true if the $email address (input string) is valid; Has a "@", domain name with at least one period and only allowed a-z characters.
         * @see t3lib_div::validEmail()
-        * @deprecated since TYPO3 4.0
+        * @deprecated since TYPO3 3.6
         */
        function checkEmail($email)     {
                return t3lib_div::validEmail($email);
@@ -6890,7 +6890,7 @@ class tslib_cObj {
         * @param       string          The field name to look in
         * @param       string          The value to look for.
         * @return      string
-        * @deprecated since TYPO3 4.0 - Use $GLOBALS['TYPO3_DB']->listQuery() directly!
+        * @deprecated since TYPO3 3.6 - Use $GLOBALS['TYPO3_DB']->listQuery() directly!
         */
        function whereSelectFromList($field,$value)     {
                return $GLOBALS['TYPO3_DB']->listQuery($field,$value,'');
index 1fb2a81..505e989 100755 (executable)
@@ -311,7 +311,13 @@ require_once (PATH_t3lib.'class.t3lib_lock.php');
                'onload' => array(),
                'onunload' => array(),
        );
-       var $JSCode='';                                         // Deprecated, use additionalJavaScript instead.
+       /**
+        * Adds JavaScript code
+        *
+        * @var string
+        * @deprecated since TYPO3 3.5 - use additionalJavaScript instead.
+        */
+       var $JSCode='';
        var $JSImgCode='';                                      // Used to accumulate JavaScript loaded images (by menus)
        var $divSection='';                                     // Used to accumulate DHTML-layers.
        var $defaultBodyTag='<body>';           // Default bodytag, if nothing else is set. This can be overridden by applications like TemplaVoila.
@@ -354,7 +360,12 @@ require_once (PATH_t3lib.'class.t3lib_lock.php');
        var $uniqueString='';
        var $indexedDocTitle='';                        // This value will be used as the title for the page in the indexer (if indexing happens)
        var $altPageTitle='';                           // Alternative page title (normally the title of the page record). Can be set from applications you make.
-       var $pEncAllowedParamNames=array();     // An array that holds parameter names (keys) of GET parameters which MAY be MD5/base64 encoded with simulate_static_documents method. @deprecated since TYPO3 4.3, remove in TYPO3 4.5
+       /**
+        * An array that holds parameter names (keys) of GET parameters which MAY be MD5/base64 encoded with simulate_static_documents method.
+        * @var array
+        * @deprecated since TYPO3 4.3, remove in TYPO3 4.5
+        */
+       var $pEncAllowedParamNames=array();
        var $baseUrl='';                                        // The base URL set for the page header.
        var $anchorPrefix='';                           // The proper anchor prefix needed when using speaking urls. (only set if baseUrl is set)
 
@@ -472,10 +483,9 @@ require_once (PATH_t3lib.'class.t3lib_lock.php');
        /**
         * Connect to MySQL database
         * May exit after outputting an error message or some JavaScript redirecting to the install tool.
-        * Use connectToDB() instead!
         *
         * @return      void
-        * @deprecated since TYPO3 3.8
+        * @deprecated since TYPO3 3.8 - Use connectToDB() instead!
         */
        function connectToMySQL()       {
                $this->connectToDB();
index 1801aee..0d220bf 100644 (file)
@@ -77,7 +77,7 @@
  * @author     Kasper Skaarhoj <kasperYYYY@typo3.com>
  * @package TYPO3
  * @subpackage tslib
- * @deprecated since TYPO3 4.0
+ * @deprecated since TYPO3 3.6
  * @link http://typo3.org/doc.0.html?&tx_extrepmgm_pi1[extUid]=270&tx_extrepmgm_pi1[tocEl]=342&cHash=fdf55adb3b
  */
 class tslib_feTCE      {
index a69d90d..0285e03 100755 (executable)
@@ -916,6 +916,7 @@ class tslib_menu {
         * @param       array           TypoScript parameters for "special.". In particular the property "file" is reserved and specifies the file to include. Seems like any other property can be used freely by the script.
         * @param       string          The sorting field. Can be used from the script in the $incFile.
         * @return      array           An array with the menu items
+        * @deprecated since TYPO3 3.6 - use HMENU of type "userfunction" instead of "userdefined"
         * @access private
         */
        function includeMakeMenu($conf,$altSortField)   {
index c60d90d..0b86f50 100755 (executable)
@@ -785,7 +785,8 @@ class tslib_pibase {
         * @param       string          $data: CSS data
         * @param       string          If $selector is set to any CSS selector, eg 'P' or 'H1' or 'TABLE' then the style $data will regard those HTML-elements only
         * @return      void
-        * @deprecated since TYPO3 4.0 - I think this function should not be used (and probably isn't used anywhere). It was a part of a concept which was left behind quite quickly.
+        * @deprecated since TYPO3 3.6 - I think this function should not be used (and probably isn't used anywhere). It was a part of a concept which was left behind quite quickly.
+        * @obsolete
         * @private
         */
        function pi_setClassStyle($class,$data,$selector='')    {
@@ -1042,7 +1043,7 @@ class tslib_pibase {
         * @param       boolean         If set, the function will return the query not as a string but array with the various parts.
         * @return      mixed           The query build.
         * @access private
-        * @deprecated since TYPO3 4.0 - Use pi_exec_query() instead!
+        * @deprecated since TYPO3 3.6 - Use pi_exec_query() instead!
         */
        function pi_list_query($table,$count=0,$addWhere='',$mm_cat='',$groupBy='',$orderBy='',$query='',$returnQueryArray=FALSE)       {
 
index 2fa1d25..2921ce4 100755 (executable)
@@ -140,7 +140,7 @@ require_once(PATH_t3lib.'class.t3lib_ajax.php');
  *
  * @param      string          Input string
  * @return     string          Output string (in the old days this was wrapped in <font> tags)
- * @deprecated since TYPO3 4.0
+ * @deprecated since TYPO3 3.6
  */
 function fw($str)      {
        return $str;
@@ -879,7 +879,7 @@ $str.=$this->docBodyTagBegin().
         *
         * @return      void
         * @internal
-        * @deprecated since TYPO3 4.0
+        * @deprecated since TYPO3 3.6
         */
        function middle()       {
        }