Add content_type_stash_key to enable a stash entry to override the serialize content...

[catagits/Catalyst-Action-REST.git] / lib / Catalyst / Action / Serialize.pm

diff --git a/lib/Catalyst/Action/Serialize.pm b/lib/Catalyst/Action/Serialize.pm
index 2ec7add..bdf0e73 100644 (file)
--- a/lib/Catalyst/Action/Serialize.pm
+++ b/lib/Catalyst/Action/Serialize.pm
@@ -1,6 +1,6 @@
 #
 # Catlyst::Action::Serialize.pm
-# Created by: Adam Jacob, Marchex, <adam@marchex.com>
+# Created by: Adam Jacob, Marchex, <adam@hjksolutions.com>
 #
 # $Id$
 
@@ -29,15 +29,15 @@ sub execute {
         $controller, $c );
     unless ( defined($sclass) ) {
         if ( defined($content_type) ) {
-            $c->log->debug("Could not find a serializer for $content_type");
+            $c->log->info("Could not find a serializer for $content_type");
         } else {
-            $c->log->debug(
+            $c->log->info(
                 "Could not find a serializer for an empty content type");
         }
         return 1;
     }
     $c->log->debug(
-        "Serializing with $sclass" . ( $sarg ? " [$sarg]" : '' ) );
+        "Serializing with $sclass" . ( $sarg ? " [$sarg]" : '' ) ) if $c->debug;
 
     my $rc;
     if ( defined($sarg) ) {
@@ -65,14 +65,12 @@ Catalyst::Action::Serialize - Serialize Data in a Response
     package Foo::Controller::Bar;
 
     __PACKAGE__->config(
-        serialize => {
-            'default'   => 'YAML',
-            'stash_key' => 'rest',
-            'map'       => {
-                               'text/html'          => [ 'View', 'TT', ],
-                'text/x-yaml'        => 'YAML',
-                'text/x-data-dumper' => [ 'Data::Serializer', 'Data::Dumper' ],
-            },
+        'default'   => 'text/x-yaml',
+        'stash_key' => 'rest',
+        'map'       => {
+            'text/html'          => [ 'View', 'TT', ],
+            'text/x-yaml'        => 'YAML',
+            'text/x-data-dumper' => [ 'Data::Serializer', 'Data::Dumper' ],
         }
     );
 
@@ -83,12 +81,11 @@ Catalyst::Action::Serialize - Serialize Data in a Response
 This action will serialize the body of an HTTP Response.  The serializer is
 selected by introspecting the HTTP Requests content-type header.
 
-It requires that your Catalyst controller have a "serialize" entry
-in it's configuration, which sets up the mapping between Content Type's
-and Serialization classes.
+It requires that your Catalyst controller is properly configured to set up the
+mapping between Content Type's and Serialization classes.
 
-The specifics of serializing each content-type is implemented as
-a plugin to L<Catalyst::Action::Serialize>.
+The specifics of serializing each content-type is implemented as a plugin to
+L<Catalyst::Action::Serialize>.
 
 Typically, you would use this ActionClass on your C<end> method.  However,
 nothing is stopping you from choosing specific methods to Serialize:
@@ -102,26 +99,30 @@ L<Catalyst::Request::REST>.
 
 =head1 CONFIGURATION
 
-=over 4
+=head2 map
 
-=item default
+Takes a hashref, mapping Content-Types to a given serializer plugin.
 
-The default Serialization format.  See the next section for
-available options.  This is used if a requested content-type
-is not recognized.
+=head2 default
 
-=item stash_key 
+This is the 'fall-back' Content-Type if none of the requested or acceptable
+types is found in the L</map>. It must be an entry in the L</map>.
 
-We will serialize the data that lives in this location in the stash.  So
-if the value is "rest", we will serialize the data under:
+=head2 stash_key 
+
+Specifies the key of the stash entry holding the data that is to be serialized.
+So if the value is "rest", we will serialize the data under:
 
   $c->stash->{'rest'}
 
-=item map
+=head2 content_type_stash_key
 
-Takes a hashref, mapping Content-Types to a given plugin.
+Specifies the key of the stash entry that optionally holds an overriding
+Content-Type. If set, and if the specified stash entry has a valid value,
+then it takes priority over the requested content types.
 
-=back
+This can be useful if you want to dynamically force a particular content type,
+perhaps for debugging.
 
 =head1 HELPFUL PEOPLE