1. Getting Started
      1. Basic Installation
      2. What is MODx
    2. Content Editing
      1. Editing Documents
      2. MODx Tags
        1. Document Variables
      3. Terminology
      4. The Manager
      5. Who Should Read This
    3. Designing
      1. Adding Chunks
      2. Adding MODx Tags
        1. Resource Fields
      3. Adding Snippets
      4. Document Caching
      5. Template Basics
    4. Administration
      1. Friendly URL Solutions
      2. Manager Users
        1. Manager Roles And Groups
        2. Reset your Password - Unblock your User
        3. Why Manager Users, Roles and Groups
      3. Moving Site
      4. Taking sites down for maintenance
      5. Upgrading
      6. Web Users
        1. Creating a Web User
        2. Web User Groups and Document Groups
        3. Why Web Users and Groups
    5. Developer's Guide
      1. API Reference
        1. DBAPI
          1. delete
          2. escape
          3. getInsertId
          4. query
          5. select
          6. update
        2. Document Object
        3. DocumentParser Object
          1. addEventListener
          2. changeWebUserPassword
          3. documentContent
          4. documentGenerated
          5. documentIdentifier
          6. documentListing
          7. documentMethod
          8. documentObject
          9. getAllChildren
          10. getCachePath
          11. getChildIds
          12. getDocumentChildren
          13. getDocumentChildrenTVarOutput
          14. getDocumentChildrenTVars
          15. getLoginUserID
          16. getLoginUserName
          17. getLoginUserType
          18. getManagerPath
          19. getParent
          20. getParentIds
          21. getUserData
          22. hasPermission
          23. isBackend
          24. isFrontend
          25. logEvent
          26. maxParserPasses
          27. minParserPasses
          28. regClientCSS
          29. runSnippet
          30. table_prefix
          31. tstart
          32. webAlert
      2. Chunks
      3. Modules
        1. How to create and run a module from within the Content Manager
        2. Managing module dependencies
        3. Setting up configuration parameters
        4. Writing the module code
      4. Plugins
      5. Snippets
      6. Template Variables
        1. (at) Binding
          1. (at)CHUNK
          2. (at)DIRECTORY
          3. (at)DOCUMENT
          4. (at)EVAL
          5. (at)FILE
          6. (at)INHERIT
          7. (at)SELECT
          8. What are (at) Bindings
        2. Creating a Template Variable
        3. What are Template Variables
        4. Widgets
          1. Misc. Widget
          2. DataGrid Widget
          3. Floater Widget
          4. Hyperlink Widget
          5. Marquee Widget
          6. RichTextBox Widget
          7. Ticker Widget
          8. Viewport Widget
          9. What are Widgets

logEvent

Last edited by Kari Söderholm on Jan 26, 2015.

API:logEvent

API Quick reference
Variable name: logEvent
Modx versions: 0.9.x + Evolution
Variable type: void
Object parent: DocumentParser

Description

void logEvent(int $evtid, int $type, string $msg [, $source= 'Parser']);
  • $evtid - Event ID
  • $type - Types: 1 = information, 2 = warning, 3 = error
  • $msg - Message to be logged. May contain HTML.
  • $source - source of the event (module, snippet name, etc.). Currently limited to max 50 characters by database field length.

Add an a alert message to the system event log.

Usage / Examples

$modx->logEvent($my_msg_cnt, 3, 'There was an error!', 'MySnippet');

Notes

Compared to other systems, it is a bit odd that the error levels are numbered the way they are.

Function Source

Function source in MODX version 1.0.15

API Source File | manager/includes/document.parser.class.inc.php | 1782

/**
 * Add an a alert message to the system event log
 *
 * @param int $evtid Event ID
 * @param int $type Types: 1 = information, 2 = warning, 3 = error
 * @param string $msg Message to be logged
 * @param string $source source of the event (module, snippet name, etc.)
 *                       Default: Parser
 */
function logEvent($evtid, $type, $msg, $source= 'Parser') {
    $msg= $this->db->escape($msg);
    if ($GLOBALS['database_connection_charset'] == 'utf8' && extension_loaded('mbstring')) {
        $esc_source = mb_substr($source, 0, 50 , "UTF-8");
    } else {
        $esc_source = substr($source, 0, 50);
    }
    $esc_source= $this->db->escape($esc_source);
    $LoginUserID = $this->getLoginUserID();
    if ($LoginUserID == '') $LoginUserID = 0;
    $evtid= intval($evtid);
    $type = intval($type);
    if ($type < 1) $type= 1; // Types: 1 = information, 2 = warning, 3 = error
    if (3 < $type) $type= 3;
    $this->db->insert(
        array(
            'eventid'     => $evtid,
            'type'        => $type,
            'createdon'   => time() + $this->config['server_offset_time'],
            'source'      => $esc_source,
            'description' => $msg,
            'user'        => $LoginUserID,
        ), $this->getFullTableName('event_log'));
    if (isset($this->config['send_errormail']) && $this->config['send_errormail'] !== '0') {
        if ($this->config['send_errormail'] <= $type) {
            $this->sendmail(array(
                    'subject' => 'MODX System Error on ' . $this->config['site_name'],
                    'body' => 'Source: ' . $source . ' - The details of the error could be seen in the MODX system events log.',
                    'type' => 'text')
            );
        }
    }
}

Suggest an edit to this page on GitHub (Requires GitHub account. Opens a new window/tab).