remove $class->import from C::Test as it will break code that does not overload Catal...
[catagits/Catalyst-Runtime.git] / lib / Catalyst / Log.pm
index af779be..4ae49a0 100644 (file)
@@ -12,58 +12,68 @@ Catalyst::Log - Catalyst Log Class
 
 =head1 SYNOPSIS
 
+    $log = $c->log;
+    $log->debug(@message);
+    $log->error(@message);
+    $log->info(@message);
+    $log->warn(@message);
+
 See L<Catalyst>.
 
 =head1 DESCRIPTION
 
-Simple logging functionality for Catalyst.
+This module provides the default, simple logging functionality for Catalyst.
+If you want something different set C<$c->log> in your application module, e.g.:
+
+    $c->log( MyLogger->new );
+
+Your logging object is expected to provide the interface described here.
+
 
 =head1 METHODS
 
 =over 4
 
-=item $c->debug($msg)
+=item $log->debug(@message)
 
 Logs a debugging message.
 
 =cut
 
-sub debug { _format( 'debug', $_[1] ) }
-
-=item $c->dump($ref)
-
-Logs a formatted dump of a variable passed by reference (uses C<Data::Dumper>).
-
-=cut
+sub debug { shift->_format( 'debug', @_ ) }
 
-sub dump { _format( 'dump', Dumper( $_[1] ) ) }
+sub dump { shift->_format( 'dump', Dumper( $_[1] ) ) }
 
-=item $c->error($msg)
+=item $log->error(@message)
 
 Logs an error message.
 
 =cut
 
-sub error { _format( 'error', $_[1] ) }
+sub error { shift->_format( 'error', @_ ) }
 
-=item $c->info($msg)
+=item $log->info(@message)
 
 Logs an informational message.
 
 =cut
 
-sub info { _format( 'info', $_[1] ) }
+sub info { shift->_format( 'info', @_ ) }
 
-=item $c->warn($msg)
+=item $log->warn(@message)
 
 Logs a warning message.
 
 =cut
 
-sub warn { _format( 'warn', $_[1] ) }
+sub warn { shift->_format( 'warn', @_ ) }
 
 sub _format {
-    print STDERR '[' . localtime(time) . "] [catalyst] [$_[0]] $_[1]\n";
+    my $class   = shift;
+    my $level   = shift;
+    my $time    = localtime(time);
+    my $message = join( "\n", @_ );
+    printf( STDERR "[%s] [catalyst] [%s] %s\n", $time, $level, $message );
 }
 
 =back