X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FAction%2FSerialize.pm;h=c5f6b712e73dda5d9a0fcb8cf984c2cac934e2f9;hb=be3c588afb1dd6d6c8e6171c01c3d38afa75d6d5;hp=10cf82e96a2a43e48a30379a42c1f7fd9ff21b3a;hpb=e601addaf89882fccbc824c1a53328f0d049b32b;p=catagits%2FCatalyst-Action-REST.git diff --git a/lib/Catalyst/Action/Serialize.pm b/lib/Catalyst/Action/Serialize.pm index 10cf82e..c5f6b71 100644 --- 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, +# Created by: Adam Jacob, Marchex, # # $Id$ @@ -17,15 +17,27 @@ sub execute { my $self = shift; my ( $controller, $c ) = @_; - $self->NEXT::execute( @_ ); + $self->NEXT::execute(@_); return 1 if $c->req->method eq 'HEAD'; return 1 if length( $c->response->body ); return 1 if scalar @{ $c->error }; return 1 if $c->response->status =~ /^(?:204|3\d\d)$/; - my ($sclass, $sarg, $content_type) = $self->_load_content_plugins("Catalyst::Action::Serialize", $controller, $c); - return 1 unless defined $sclass; + my ( $sclass, $sarg, $content_type ) = + $self->_load_content_plugins( "Catalyst::Action::Serialize", + $controller, $c ); + unless ( defined($sclass) ) { + if ( defined($content_type) ) { + $c->log->info("Could not find a serializer for $content_type"); + } else { + $c->log->info( + "Could not find a serializer for an empty content type"); + } + return 1; + } + $c->log->debug( + "Serializing with $sclass" . ( $sarg ? " [$sarg]" : '' ) ) if $c->debug; my $rc; if ( defined($sarg) ) { @@ -33,11 +45,11 @@ sub execute { } else { $rc = $sclass->execute( $controller, $c ); } - if ($rc eq 0) { - return $self->_unsupported_media_type($c, $content_type); - } elsif ($rc ne 1) { - return $self->_serialize_bad_request($c, $content_type, $rc); - } + if ( $rc eq 0 ) { + return $self->_unsupported_media_type( $c, $content_type ); + } elsif ( $rc ne 1 ) { + return $self->_serialize_bad_request( $c, $content_type, $rc ); + } return 1; } @@ -53,13 +65,12 @@ Catalyst::Action::Serialize - Serialize Data in a Response package Foo::Controller::Bar; __PACKAGE__->config( - serialize => { - 'default' => 'YAML', - 'stash_key' => 'rest', - 'map' => { - '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' ], } ); @@ -70,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. +The specifics of serializing each content-type is implemented as a plugin to +L. Typically, you would use this ActionClass on your C method. However, nothing is stopping you from choosing specific methods to Serialize: @@ -84,15 +94,19 @@ nothing is stopping you from choosing specific methods to Serialize: .. populate stash with data .. } +When you use this module, the request class will be changed to +L. + =head1 CONFIGURATION =over 4 =item default -The default Serialization format. See the next section for -available options. This is used if a requested content-type -is not recognized. +The Content-Type of the default Serialization format. This must be a +Content-Type associated with a plugin in the "map" section below. + +This is used if a requested content-type is not recognized. =item stash_key @@ -131,3 +145,4 @@ Marchex, Inc. paid me while I developed this module. (http://www.marchex.com) You may distribute this code under the same terms as Perl itself. =cut +