FAQ How to

show Changed

Changed

Visitor's book Site map pmwiki-2.3.37

• login

Diagnostic Messages

(redirected from Cookbook.DiagnosticMessages)

Questions answered by this extension

When I am writing a PmWiki extension or recipe how can I quickly and easily log diagnostic information from the extension?

Description

This extension provides a simple function dmsg() that goes to some effort to dump to the PmWiki built in $MessagesFmt array the variables passed to it in a readable way. These messages can then be displayed using the built in (:messages:) page directive, or better still, with the drop in Cookbook:Messages Replacement extension.

The extension provides a function function dmsg (string $smsgprefix, $smsgdata, bool $smshtml = false, string $dmsgId = '', bool $dmsgLog=false) {} whose parameters are:

This extension is inspired by the code snippet in Cookbook:Debugging For Cookbook Authors, and provides an enhanced, tried and tested, reusable version of this.

Installation

• download diagnosticmessages-2024-08-18.zip Δ
• extract the directory /diagnosticmessages/
• copy the /diagnosticmessages/ directory into the /extensions/ directory

Usage

The extension provides a page variable {$dmsgVersion} which contains the current extension version, and page variable {$DiagnosticMessages} for a (:if enabled DiagnosticMessages:) extension installation check.

You can then use Messages Replacement Redirects to Extensions.MessagesReplacement to display the messages.

Configuration

In the extension or recipe that is using dmsg() include the code:

if (!function_exists('dmsg')) {
    if (!isset ($MessagesFmt['functionName'])) $MessagesFmt['functionName'] = []; # initialise
    function dmsg (string $smsgprefix, $smsgdata) { # local instance
        global $MessagesFmt;
        $MessagesFmt['functionName'] [] = 
            $smsgprefix . '= ' . (is_array ($smsgdata)
            ? @implode (BR . $smsgprefix . '= ', \PHSC ($smsgdata))
            : \PHSC ($smsgdata));
    } # end function
} # end if

This will ensure that whether or not the dmsg() function is available globally the extension or recipe will work and be able to call dmsg().

The extension will use the parameter $dmsgId as the unique identifier if it is supplied. If $dmsgId is not supplied the extension will generate an identifier based on the calling function, or if the calling function is include_once() it will use the basename of the extension's or recipe's filename.

dmsg() returns the value of the string added to $MessagesFmt.

Change log / Release notes

See also

• DiagnosticMessages home Capture extension and recipe diagnostic messages for display by the messages directive
• test DiagnosticMessages

On PmWiki

From the PmWiki developer category:

• Complex Recipes
• Module Guidelines
• Debugging For Cookbook Authors
• Messages Replacement Redirects to Extensions.MessagesReplacement
• Simple Recipe Template A Simple Recipe Template to provide a framework for PmWiki recipes

Contributors

Special thanks to Petko and the PmWiki documenters.

Talkback

See discussion at DiagnosticMessages-Talk