.. You may want to use the usual include line. Uncomment and adjust the path. 
.. include:: ../Includes.txt


========
CCDevlog
========

:Author:
      Kasper Skårhøj

:Created:
      2002-11-01T00:32:00

:Changed:
      2005-01-01T19:46:13

:Author:
      René Fritz

:Email:
      r.fritz@colorcube.de

:Info 3:


:Info 4:


.. _CCDevlog:

CCDevlog
========

Extension Key:  **cc\_devlog**

Copyright 2004-2005, René Fritz, <r.fritz@colorcube.de>

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

\- a GNU/GPL CMS/Framework available from www.typo3.com

.. _Table-of-Contents:

Table of Contents
-----------------

**CCDevlog 1**

**Introduction 1**

**Users manual 2**

**To-Do list 3**


.. _Introduction:

Introduction
------------

“ *Developer 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 CCDevlog extension provides development logging/debugging
functionality for the usage of :code:`t3lib\_div::devlog()` . The
:code:`t3lib\_div::devlog()` function itself provides only an
interface for logging but no implementation.

CCDevlog logs messages from :code:`t3lib\_div::devlog()` calls into a
database table. The log entries can be viewed with a backend module.
The module can be opened in an separate window.

|img-1|

Features:

- log entries are logged in log sessions – one log session per script
  run. That makes it easy to separate log runs.

- frontend logging include the page id

- Auto refresh

- Show log runs or latest entries

- Clicking on log entry show the corresponding log run only


.. _Users-manual:

Users manual
------------

The :code:`t3lib\_div:devlog()` function is defined as follows:

::

   /**
    * Developer 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
    */
   function devLog($msg, $extKey, $severity=0, $dataVar=FALSE)     {

I suggest to use the :code:`t3lib\_div:devlog()` function like this:

::

   class t3lib_userAuth {
   
       // write messages into the devlog?
   var $writeDevLog = FALSE;
   
   function start() {
       global $TYPO3_CONF_VARS;
       
           // enable dev logging if set
       if ($TYPO3_CONF_VARS['SC_OPTIONS']['t3lib/class.t3lib_userauth.php']['writeDevLog']) 
           $this->writeDevLog = TRUE;
       if (TYPO3_DLOG) $this->writeDevLog = TRUE;
       
       ...
       
       if ($this->writeDevLog AND !is_array($this->user)) 
           t3lib_div::devLog('No user session found.', 't3lib_userAuth', 2);


.. _To-Do-list:

To-Do list
----------

Any wishes? Send me code.

|img-2| CCDevlog - 3


.. ######CUTTER_MARK_IMAGES######

.. |img-1| image:: img-1.png
.. :align: left
.. :border: 0
.. :height: 318
.. :id: Grafik2
.. :name: Grafik2
.. :width: 443

.. |img-2| image:: img-2.png
.. :align: left
.. :border: 0
.. :height: 32
.. :id: Graphic1
.. :name: Graphic1
.. :width: 102