Bug #28050

t3lib_div::devLog - PHPDoc Comment does not match method signature

Added by Sebastian Michaelsen over 8 years ago. Updated almost 2 years ago.

Status:
Closed
Priority:
Should have
Assignee:
-
Category:
Backend API
Target version:
Start date:
2011-07-09
Due date:
% Done:

100%

TYPO3 Version:
4.6
PHP Version:
Tags:
Complexity:
Is Regression:
Sprint Focus:

Description

This is the signature of t3lib_div::devLog

    /**
     * Logs message to the development log.
     * This should be implemented around the source code, both frontend and backend, logging everything from the flow through an application, messages, results from comparisons to fatal errors.
     * The result is meant to make sense to developers during development or debugging of a site.
     * The idea is that this function is only a wrapper for external extensions which can set a hook which will be allowed to handle the logging of the information to any format they might wish and with any kind of filter they would like.
     * If you want to implement the devLog in your applications, simply add lines like:
     *         if (TYPO3_DLOG)    t3lib_div::devLog('[write message in english here]', 'extension key');
     *
     * @param    string        Message (in english).
     * @param    string        Extension key (from which extension you are calling the log)
     * @param    integer        Severity: 0 is info, 1 is notice, 2 is warning, 3 is fatal error, -1 is "OK" message
     * @param    array        Additional data you want to pass to the logger.
     * @return    void
     */
    public static function devLog($msg, $extKey, $severity = 0, $dataVar = FALSE) {
    }

Notice that the last Parameter is declared as array, but defaults to FALSE. This leads to warning notices in IDEs like PHPStorm when you use devLog.

Associated revisions

Revision 6b84e32e (diff)
Added by Sebastian Michaelsen over 8 years ago

[BUG] t3lib_div::devLog - PHPDoc Comment does not match method signature

Change-Id: Iba6222bdd79d62057ba0338ac0a88614583c1690
Resolves: #28050
Releases: 4.6, 4.5
Reviewed-on: http://review.typo3.org/3206
Reviewed-by: Steffen Gebert
Tested-by: Steffen Gebert

Revision 87adf576 (diff)
Added by Sebastian Michaelsen over 8 years ago

[BUGFIX] t3lib_div::devLog - PHPDoc Comment does not match method signature

Change-Id: I9c49e5d5350d9442a5836e5e4e6bf778766bf532
Resolves: #28050
Releases: 4.6, 4.5
Reviewed-on: http://review.typo3.org/3207
Reviewed-by: Steffen Gebert
Tested-by: Steffen Gebert
Reviewed-by: Sebastian Michaelsen
Tested-by: Sebastian Michaelsen

History

#1 Updated by Mr. Hudson over 8 years ago

Patch set 1 of change Iba6222bdd79d62057ba0338ac0a88614583c1690 has been pushed to the review server.
It is available at http://review.typo3.org/3206

#2 Updated by Mr. Hudson over 8 years ago

Patch set 1 of change I9c49e5d5350d9442a5836e5e4e6bf778766bf532 has been pushed to the review server.
It is available at http://review.typo3.org/3207

#3 Updated by Steffen Gebert over 8 years ago

  • Target version set to 4.5.4

#4 Updated by Mr. Hudson over 8 years ago

Patch set 1 of change Ia93e1bbce0fade3cf082da3a799d19fec5c4dbc4 has been pushed to the review server.
It is available at http://review.typo3.org/3208

#5 Updated by Sebastian Michaelsen over 8 years ago

  • Status changed from New to Resolved
  • % Done changed from 0 to 100

#6 Updated by Riccardo De Contardi almost 2 years ago

  • Status changed from Resolved to Closed

Also available in: Atom PDF