lib/Catalyst/Log.pm

   1 package Catalyst::Log;
   2
   3 use strict;
   4 use base 'Class::Accessor::Fast';
   5 use Data::Dumper;
   6
   7 $Data::Dumper::Terse = 1;
   8
   9 =head1 NAME
  10
  11 Catalyst::Log - Catalyst Log Class
  12
  13 =head1 SYNOPSIS
  14
  15 See L<Catalyst>.
  16
  17 =head1 DESCRIPTION
  18
  19 Simple logging functionality for Catalyst.
  20
  21 =head1 METHODS
  22
  23 =over 4
  24
  25 =item $c->debug($msg)
  26
  27 Logs a debugging message.
  28
  29 =cut
  30
  31 sub debug { _format( 'debug', $_[1] ) }
  32
  33 =item $c->dump($ref)
  34
  35 Logs a formatted dump of a variable passed by reference (uses C<Data::Dumper>).
  36
  37 =cut
  38
  39 sub dump { _format( 'dump', Dumper( $_[1] ) ) }
  40
  41 =item $c->error($msg)
  42
  43 Logs an error message.
  44
  45 =cut
  46
  47 sub error { _format( 'error', $_[1] ) }
  48
  49 =item $c->info($msg)
  50
  51 Logs an informational message.
  52
  53 =cut
  54
  55 sub info { _format( 'info', $_[1] ) }
  56
  57 =item $c->warn($msg)
  58
  59 Logs a warning message.
  60
  61 =cut
  62
  63 sub warn { _format( 'warn', $_[1] ) }
  64
  65 sub _format {
  66     print STDERR '[' . localtime(time) . "] [catalyst] [$_[0]] $_[1]\n";
  67 }
  68
  69 =back
  70
  71 =head1 SEE ALSO
  72
  73 L<Catalyst>.
  74
  75 =head1 AUTHOR
  76
  77 Sebastian Riedel, C<sri@cpan.org>
  78
  79 =head1 COPYRIGHT
  80
  81 This program is free software, you can redistribute it and/or modify it under
  82 the same terms as Perl itself.
  83
  84 =cut
  85
  86 1;