Reformatted documentation

[catagits/Catalyst-Runtime.git] / lib / Catalyst / Log.pm

diff --git a/lib/Catalyst/Log.pm b/lib/Catalyst/Log.pm
index 9792393..4b3c3c3 100644 (file)
--- a/lib/Catalyst/Log.pm
+++ b/lib/Catalyst/Log.pm
@@ -7,6 +7,8 @@ use Data::Dumper;
 our %LEVELS = ();
 
 __PACKAGE__->mk_accessors('level');
+__PACKAGE__->mk_accessors('body');
+__PACKAGE__->mk_accessors('abort');
 
 {
     my @levels = qw[ debug info warn error fatal ];
@@ -69,7 +71,19 @@ sub _log {
     my $level   = shift;
     my $time    = localtime(time);
     my $message = join( "\n", @_ );
-    printf( STDERR "[%s] [catalyst] [%s] %s\n", $time, $level, $message );
+    $self->{body} .=
+      sprintf( "[%s] [catalyst] [%s] %s\n", $time, $level, $message );
+}
+
+sub _flush {
+    my $self = shift;
+    if ( $self->abort || !$self->body ) {
+        $self->abort(undef);
+    }
+    else {
+        print( STDERR $self->body );
+    }
+    $self->body(undef);
 }
 
 1;
@@ -109,74 +123,80 @@ Your logging object is expected to provide the interface described here.
 
 =head1 LOG LEVELS
 
-=over 4
-
-=item debug
+=head2 debug
 
     $log->is_debug;
     $log->debug($message);
 
-=item info
+=head2 info
 
     $log->is_info;
     $log->info($message);
 
-=item warn
+=head2 warn
 
     $log->is_warn;
     $log->warn($message);
 
-=item error
+=head2 error
 
     $log->is_error;
     $log->error($message);
 
-=item fatal
+=head2 fatal
 
     $log->is_fatal;
     $log->fatal($message);
 
-=back
-
 =head1 METHODS
 
-=over 4
-
-=item new
+=head2 new
 
-Constructor, defaults to enable all levels unless levels a provieded in
+Constructor. Defaults to enable all levels unless levels are provided in
 arguments.
 
     $log = Catalyst::Log->new;
-    $log = Catalyst::Log->new( 'warn', 'error', 'fatal' );
+    $log = Catalyst::Log->new( 'warn', 'error' );
 
-=item levels
+=head2 levels
 
 Set log levels
 
     $log->levels( 'warn', 'error', 'fatal' );
 
-=item enable
+=head2 enable
 
 Enable log levels
 
     $log->enable( 'warn', 'error' );
 
-=item disable
+=head2 disable
 
 Disable log levels
 
     $log->disable( 'warn', 'error' );
 
-=item is_debug
-=item is_error
-=item is_fatal
-=item is_info
-=item is_warn
+=head2 is_debug
+
+=head2 is_error
+
+=head2 is_fatal
+
+=head2 is_info
+
+=head2 is_warn
 
 Is the log level active?
 
-=back
+=head2 abort
+
+Should Catalyst emit logs for this request? Will be reset at the end of 
+each request. 
+
+*NOTE* This method is not compatible with other log apis, so if you plan
+to use Log4Perl or another logger, you should call it like this:
+
+    $c->log->abort(1) if $c->log->can('abort');
 
 =head1 SEE ALSO