1 package Catalyst::Action::Serialize;
4 use namespace::autoclean;
6 extends 'Catalyst::Action::SerializeBase';
7 use Module::Pluggable::Object;
10 our $VERSION = '0.91';
11 $VERSION = eval $VERSION;
16 default => sub { {} },
21 my ( $controller, $c ) = @_;
23 $self->maybe::next::method(@_);
25 return 1 if $c->req->method eq 'HEAD';
26 return 1 if $c->response->has_body;
27 return 1 if scalar @{ $c->error };
28 return 1 if $c->response->status =~ /^(?:204)$/;
30 my ( $sclass, $sarg, $content_type ) =
31 $self->_load_content_plugins( "Catalyst::Action::Serialize",
33 unless ( defined($sclass) ) {
34 if ( defined($content_type) ) {
35 $c->log->info("Could not find a serializer for $content_type");
38 "Could not find a serializer for an empty content-type");
43 "Serializing with $sclass" . ( $sarg ? " [$sarg]" : '' ) ) if $c->debug;
45 $self->_encoders->{$sclass} ||= $sclass->new;
46 my $sobj = $self->_encoders->{$sclass};
50 if ( defined($sarg) ) {
51 $rc = $sobj->execute( $controller, $c, $sarg );
53 $rc = $sobj->execute( $controller, $c );
57 return $self->_serialize_bad_request( $c, $content_type, $@ );
59 return $self->_unsupported_media_type( $c, $content_type );
65 __PACKAGE__->meta->make_immutable;
71 Catalyst::Action::Serialize - Serialize Data in a Response
75 package Foo::Controller::Bar;
78 'default' => 'text/x-yaml',
79 'stash_key' => 'rest',
81 'text/html' => [ 'View', 'TT', ],
82 'text/x-yaml' => 'YAML',
83 'text/x-data-dumper' => [ 'Data::Serializer', 'Data::Dumper' ],
87 sub end :ActionClass('Serialize') {}
91 This action will serialize the body of an HTTP Response. The serializer is
92 selected by introspecting the HTTP Requests content-type header.
94 It requires that your Catalyst controller is properly configured to set up the
95 mapping between Content Type's and Serialization classes.
97 The specifics of serializing each content-type is implemented as a plugin to
98 L<Catalyst::Action::Serialize>.
100 Typically, you would use this ActionClass on your C<end> method. However,
101 nothing is stopping you from choosing specific methods to Serialize:
103 sub foo :Local :ActionClass('Serialize') {
104 .. populate stash with data ..
107 When you use this module, the request class will be changed to
108 L<Catalyst::Request::REST>.
114 Takes a hashref, mapping Content-Types to a given serializer plugin.
118 This is the 'fall-back' Content-Type if none of the requested or acceptable
119 types is found in the L</map>. It must be an entry in the L</map>.
123 Specifies the key of the stash entry holding the data that is to be serialized.
124 So if the value is "rest", we will serialize the data under:
128 =head2 content_type_stash_key
130 Specifies the key of the stash entry that optionally holds an overriding
131 Content-Type. If set, and if the specified stash entry has a valid value,
132 then it takes priority over the requested content types.
134 This can be useful if you want to dynamically force a particular content type,
135 perhaps for debugging.
137 =head1 HELPFUL PEOPLE
139 Daisuke Maki pointed out that early versions of this Action did not play
140 well with others, or generally behave in a way that was very consistent
141 with the rest of Catalyst.
145 You likely want to look at L<Catalyst::Controller::REST>, which implements
146 a sensible set of defaults for doing a REST controller.
148 L<Catalyst::Action::Deserialize>, L<Catalyst::Action::REST>
152 See L<Catalyst::Action::REST> for authors.
156 You may distribute this code under the same terms as Perl itself.