1 package Catalyst::Action::Serialize;
4 use namespace::autoclean;
6 extends 'Catalyst::Action::SerializeBase';
7 use Module::Pluggable::Object;
10 our $VERSION = '1.13';
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)$/;
29 return 1 if defined $c->stash->{current_view};
30 return 1 if defined $c->stash->{current_view_instance};
32 my ( $sclass, $sarg, $content_type ) =
33 $self->_load_content_plugins( "Catalyst::Action::Serialize",
35 unless ( defined($sclass) ) {
36 if ( defined($content_type) ) {
37 $c->log->info("Could not find a serializer for $content_type");
40 "Could not find a serializer for an empty content-type");
45 "Serializing with $sclass" . ( $sarg ? " [$sarg]" : '' ) ) if $c->debug;
47 $self->_encoders->{$sclass} ||= $sclass->new;
48 my $sobj = $self->_encoders->{$sclass};
52 if ( defined($sarg) ) {
53 $rc = $sobj->execute( $controller, $c, $sarg );
55 $rc = $sobj->execute( $controller, $c );
59 return $self->serialize_bad_request( $c, $content_type, $@ );
61 return $self->unsupported_media_type( $c, $content_type );
67 __PACKAGE__->meta->make_immutable;
73 Catalyst::Action::Serialize - Serialize Data in a Response
77 package Foo::Controller::Bar;
80 'default' => 'text/x-yaml',
81 'stash_key' => 'rest',
83 'text/html' => [ 'View', 'TT', ],
84 'text/x-yaml' => 'YAML',
85 'text/x-data-dumper' => [ 'Data::Serializer', 'Data::Dumper' ],
89 sub end :ActionClass('Serialize') {}
93 This action will serialize the body of an HTTP Response. The serializer is
94 selected by introspecting the HTTP Requests content-type header.
96 It requires that your Catalyst controller is properly configured to set up the
97 mapping between Content Type's and Serialization classes.
99 The specifics of serializing each content-type is implemented as a plugin to
100 L<Catalyst::Action::Serialize>.
102 Typically, you would use this ActionClass on your C<end> method. However,
103 nothing is stopping you from choosing specific methods to Serialize:
105 sub foo :Local :ActionClass('Serialize') {
106 .. populate stash with data ..
109 When you use this module, the request class will be changed to
110 L<Catalyst::Request::REST>.
116 Takes a hashref, mapping Content-Types to a given serializer plugin.
120 This is the 'fall-back' Content-Type if none of the requested or acceptable
121 types is found in the L</map>. It must be an entry in the L</map>.
125 Specifies the key of the stash entry holding the data that is to be serialized.
126 So if the value is "rest", we will serialize the data under:
130 =head2 content_type_stash_key
132 Specifies the key of the stash entry that optionally holds an overriding
133 Content-Type. If set, and if the specified stash entry has a valid value,
134 then it takes priority over the requested content types.
136 This can be useful if you want to dynamically force a particular content type,
137 perhaps for debugging.
139 =head1 HELPFUL PEOPLE
141 Daisuke Maki pointed out that early versions of this Action did not play
142 well with others, or generally behave in a way that was very consistent
143 with the rest of Catalyst.
147 For building custom error responses when serialization fails, you can create
148 an ActionRole (and use L<Catalyst::Controller::ActionRole> to apply it to the
149 C<end> action) which overrides C<unsupported_media_type> and/or C<_serialize_bad_request>
154 You likely want to look at L<Catalyst::Controller::REST>, which implements
155 a sensible set of defaults for doing a REST controller.
157 L<Catalyst::Action::Deserialize>, L<Catalyst::Action::REST>
161 See L<Catalyst::Action::REST> for authors.
165 You may distribute this code under the same terms as Perl itself.