Add pod for the external method 'psgienv'

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

diff --git a/lib/Catalyst/Log.pm b/lib/Catalyst/Log.pm
index 382a3e9..42aff02 100644 (file)
--- a/lib/Catalyst/Log.pm
+++ b/lib/Catalyst/Log.pm
@@ -13,7 +13,22 @@ our %LEVEL_MATCH = (); # Stored as additive, thus debug = 31, warn = 30 etc
 has level => (is => 'rw');
 has _body => (is => 'rw');
 has abort => (is => 'rw');
-has psgienv => (is => 'rw', predicate => 'has_psgienv', clearer => 'clear_psgienv');
+has _psgi_logger => (is => 'rw', predicate => '_has_psgi_logger', clearer => '_clear_psgi_logger');
+has _psgi_errors => (is => 'rw', predicate => '_has_psgi_errors', clearer => '_clear_psgi_errors');
+
+sub clear_psgi {
+    my $self = shift;
+    $self->_clear_psgi_logger;
+    $self->_clear_psgi_errors;
+}
+
+sub psgienv {
+    my ($self, $env) = @_;
+
+    $self->_psgi_logger($env->{'psgix.logger'}) if $env->{'psgix.logger'};
+    $self->_psgi_errors($env->{'psgi.errors'}) if $env->{'psgi.errors'};
+}
+
 
 {
     my @levels = qw[ debug info warn error fatal ];
@@ -92,13 +107,13 @@ sub _log {
     my $self    = shift;
     my $level   = shift;
     my $message = join( "\n", @_ );
-    $message .= "\n" unless $message =~ /\n$/;
-    if ($self->can('has_psgienv') and $self->has_psgienv and $self->psgienv->{'psgix.logger'}) {
-        $self->psgienv->{'psgix.logger'}->({
+    if ($self->can('_has_psgi_logger') and $self->_has_psgi_logger) {
+        $self->_psgi_logger->({
                 level => $level,
                 message => $message,
             });
     } else {
+        $message .= "\n" unless $message =~ /\n$/;
         my $body = $self->_body;
         $body .= sprintf( "[%s] %s", $level, $message );
         $self->_body($body);
@@ -118,8 +133,8 @@ sub _flush {
 
 sub _send_to_log {
     my $self = shift;
-    if ($self->can('has_psgienv') and $self->has_psgienv) {
-        $self->psgienv->{'psgi.errors'}->print(@_);
+    if ($self->can('_has_psgi_errors') and $self->_has_psgi_errors) {
+        $self->_psgi_errors->print(@_);
     } else {
         print STDERR @_;
     }
@@ -275,6 +290,17 @@ This protected method is what actually sends the log information to STDERR.
 You may subclass this module and override this method to get finer control
 over the log output.
 
+=head2 psgienv $env
+
+    $log->psgienv($env);
+
+NOTE: This is not meant for public consumption.
+
+Set the PSGI environment for this request. This ensures logs will be sent to
+the right place. If the environment has a C<psgix.logger>, it will be used. If
+not, we will send logs to C<psgi.errors> if that exists. As a last fallback, we
+will send to STDERR as before.
+
 =head2 meta
 
 =head1 SEE ALSO