EXT: Debugger¶

What does it do?¶

• This is a simple PHP debugger.Put this into your PHP file:

  debugBegin();
  debug ($variable, '$variable');
  debugEnd();
  

  You can add the IP address for debug output in the EM. Enter the filename to put all output into a HTML file instead of the screen.

• You can see all the debug output if you use the debug file. Make sure you have the DEBUGFILEMODE set to 'o' for overwriting. Otherwise nothing will be written, if the file already has contents! And verify the starting date and time to see that the debug really has been written during your last PHP session.

• Read the EM for fh_debug. All documentation is directly written there.

• Support for the logging of errors into your own file instead of the PHP error_log file. Just insert lines like these into your PHP file for the TYPO3 Core or for a TYPO3 extension:

  $backtrace = \JambageCom\Fhdebug\Utility\DebugFunctions::getTraceArray();
  error_log('my debug code position 1 - backtrace: ' . print_r($backtrace, TRUE) . chr(13), 3, \JambageCom\Fhdebug\Utility\DebugFunctions::getErrorLogFilename());
  

• If you debug the TYPO3 Core on a place where the autoloader did not already include the files of fh_debug or in the file ext_localconf.php of a TYPO3 extension, you can use this approach example:

  public function create($cacheIdentifier, $cacheObjectName, $backendObjectName, array $backendOptions = array()) {
   class CacheFactory implements \TYPO3\CMS\Core\SingletonInterface {
  
  // now add the following lines to generated the debug output
  if (\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::isLoaded('fh_debug')) {
       require_once(\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::extPath('fh_debug') . 'Classes/Utility/DebugFunctions.php');  // use t3lib_extMgm::extPath in TYPO3 4.5
          // some configuration:
          \JambageCom\Fhdebug\Utility\DebugFunctions::setErrorLogFile(''); // this is necessary if you use the error_log file
          // if you use the debug HTML file:
          \JambageCom\Fhdebug\Utility\DebugFunctions::setDebugFile('fileadmin/debug.html');
  
    \JambageCom\Fhdebug\Utility\DebugFunctions::setDebugBegin(FALSE);
    \JambageCom\Fhdebug\Utility\DebugFunctions::setRecursiveDepth('12');
    \JambageCom\Fhdebug\Utility\DebugFunctions::setTraceDepth('12');
    \JambageCom\Fhdebug\Utility\DebugFunctions::setAppendDepth('0');
    \JambageCom\Fhdebug\Utility\DebugFunctions::setTypo3Mode('ALL');
    \JambageCom\Fhdebug\Utility\DebugFunctions::setActive(TRUE);
    \JambageCom\Fhdebug\Utility\DebugFunctions::initFile();
  
          // show the values of some variables:
          \JambageCom\Fhdebug\Utility\DebugFunctions::debug($cacheIdentifier, 'create $cacheIdentifier');
          \JambageCom\Fhdebug\Utility\DebugFunctions::debug($cacheObjectName, 'create $cacheObjectName');
          \JambageCom\Fhdebug\Utility\DebugFunctions::debug($backendObjectName, 'create $backendObjectName');
          \JambageCom\Fhdebug\Utility\DebugFunctions::debug($backendOptions, 'create $backendOptions');
          \JambageCom\Fhdebug\Utility\DebugFunctions::close();
  }
  

Screenshots¶

Here you see what the extension does:

The debug info is stored as a HTML file. The variable name, contents and type are shown together with leading backtrace lines.

debug file¶

Use the generated debug file, which by default is http://exampletypo3.com/fileadmin/debug.html .You must add the '</body>' HTML tag to the end of the file. This is because the debugger does not know how many output you will add there if you use the append functionality.

In order to make sure that the debugging will be activated from the beginning of the TYPO3 process, you must follow this step. Add this line into your file typo3conf/AdditionalConfiguration.php. Maybe you need to create this file.

<?php
$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['tslib/index_ts.php']['preprocessRequest'][] = 'JambageCom\\FhDebug\\Hooks\\CoreHooks->preprocessRequest';
?>

errorLog¶

The default error_log file of the extension fh_debug is “fileadmin/phpDebugErrorLog.txt”.You can use the error_log in a case when there are troubles using the debug output file.

devLog¶

You can add calls to the devLog logging function to your PHP files.

This will be transformed into debug entries in the debug file.

Example:
$dataVar = array('important' => 'We need more cardboard', 'data' => 'size 1m x 0.5 m');
\TYPO3\CMS\Core\Utility\GeneralUtility::devLog($myDebug, 'myextensionkey', 0, $dataVar);

This will be transformed into debug entries of a variable named “$devLogArray” in the debug file.