Barbie > Data-Phrasebook-0.33 > Data::Phrasebook::Debug

Download:
Data-Phrasebook-0.33.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.33   Source   Latest Release: Data-Phrasebook-0.34

NAME ^

Data::Phrasebook::Debug - Phrasebook debugging.

SYNOPSIS ^

    use Data::Phrasebook;

    my $q = Data::Phrasebook->new(
        class  => 'Plain',
        loader => 'Text',
        file   => 'phrases.txt',
        debug  => 2,
    );

    my $r = Phrasebook->new( file  => 'phrases.txt', debug => 3 );

    $r->debug(4);
    $r->store(3,"Start");
    my @log = $r->retrieve(2);
    $r->clear();

DESCRIPTION ^

This module enables debug logging for phrasebook classes. It simply stores all interaction with the phrasebook, which can then be interrogated. Do not call directly, but via the class object.

There is a single storage for all levels of the Data::Phrasebook heirarchy. This then enables storage and retrieval to be performed by the user. There are several different levels of debugging, detailed as follows:

  1 - Errors
  2 - Warnings
  3 - Information
  4 - Variable Debugging

The first three are simple strings that are recorded during the processing. However, the latter is specifically for dumping the contents of significant variables.

Through the use of the debug() method, the debugging can be switched on and off at significant points. The clear() method will clear the current trail of debugging information.

METHODS ^

debug

Accessor to debugging flag.

clear

Clear the currently stored debugging information.

store

Store debugging information.

retrieve

Retrieve debugging information.

dumper

Uses 'on demand' call to Data::Dumper::Dumper().

SEE ALSO ^

Data::Phrasebook.

SUPPORT ^

Please see the README file.

AUTHOR ^

  Barbie, <barbie@cpan.org>
  for Miss Barbell Productions <http://www.missbarbell.co.uk>.

COPYRIGHT AND LICENSE ^

  Copyright (C) 2004-2012 Barbie for Miss Barbell Productions.

  This module is free software; you can redistribute it and/or
  modify it under the Artistic License v2.
syntax highlighting: