vb.org Archive - Mini Mods

Introduction:
This is my basic logging mechanism used in two of my current vbulletin products.

Instead of writing a text file to the file system which may or may not have been the best thing to do, i instead wrote this small plugin to facilitate logging to a database table instead.

Install:
Upload the contents of the upload folder to your vbulletin root directory.
Install the product XML file.

Usage:
There are no options that need to be set (they should be turned on/off in your plugin code).

Main Class is called DebugLog. It has one class variable, product, and two class methods, set and log.

Log takes up to 4 arguments.

Quote:

log($log, $location = '', $line = '', $extra = '' )
$log is the string, array or object of the data you wish to save.
$location is commonly the function or method that you are logging.
$line is commonly __LINE__ , but in a plugin this may or may not work,
so you can set this number manually if you wish
$extra is extra information about the data you are logging such as "should never be 0"

Set takes two arguments.

Quote:

set($var, $value)
$var is the variable name (currently only product is a valid variable to set).
$value is the value you wish $var to be.

in your plugin, it is advisable to setup your own debug class wrapper around the DevLog class

PHP Code:


		
			
class MyClass

{

    var $D = '';



    function SetupLog()

    {

        global $vbulletin;

        if($vbulletin->options['MyProduct_debug_enable'] && class_exists("DebugLog"))

        {

            $this->D = new DebugLog();

            $this->D->set("product", "MyProduct");

        }

    }



    function debug($data,$location='',$line='',$extra='')

    {

        global $vbulletin;

        if($vbulletin->options['MyProduct_debug_enable'] && class_exists("DebugLog"))

        {

            $this->D->log($data,$location,$line,$extra);

        }

    }

    function MyMethod($bar)

    {

        $this->debug($bar,"MyMethod");

        echo $bar . " + foo";

    }

}



$obj = new MyClass;

$obj->SetupLog(); // You need to seed the product so that it logs can be sorted



$obj->debug($obj,"Class Object");

//Writes Class information to the log table.



$var = $obj->MyMethod("Frank");

$obj->debug($var,"Called MyMethod");

// Writes the value of $var to the log table

you can also call the class staticly

PHP Code:


		
			
DebugLog::log($var);

You cannot set the product with this method so it defaults to devlog

Viewing Logs:
Admincp -> Devlog ->View Logs

This is -very very- basic and will gradually be expanded. As it currently is, it will be enough to assist in debugging current problems with my plugins.

ChangeLog
v0.1 - Release
v0.2 - Cosmetic - Added Line numbers to debug log output.

X vBulletin 3.8.12 by vBS Debug Information
Page Generation 0.02332 seconds Memory Usage 1,736KB Queries Executed 10 (?)
More Information
Template Usage: (1)ad_footer_end (1)ad_footer_start (1)ad_header_end (1)ad_header_logo (1)ad_navbar_below (2)bbcode_php_printable (2)bbcode_quote_printable (1)footer (1)gobutton (1)header (1)headinclude (6)option (1)post_thanks_navbar_search (1)printthread (5)printthreadbit (1)spacer_close (1)spacer_open Phrase Groups Available: global postbit showthread	Included Files: ./printthread.php ./global.php ./includes/init.php ./includes/class_core.php ./includes/config.php ./includes/functions.php ./includes/class_hook.php ./includes/modsystem_functions.php ./includes/class_bbcode_alt.php ./includes/class_bbcode.php ./includes/functions_bigthree.php Hooks Called: init_startup init_startup_session_setup_start init_startup_session_setup_complete cache_permissions fetch_threadinfo_query fetch_threadinfo fetch_foruminfo style_fetch cache_templates global_start parse_templates global_setup_complete printthread_start bbcode_fetch_tags bbcode_create bbcode_parse_start bbcode_parse_complete_precache bbcode_parse_complete printthread_post printthread_complete
Messages: