1 package Catalyst::Action::Serialize;
4 use namespace::autoclean;
6 extends 'Catalyst::Action::SerializeBase';
7 use Module::Pluggable::Object;
13 default => sub { {} },
18 my ( $controller, $c ) = @_;
20 $self->maybe::next::method(@_);
22 return 1 if $c->req->method eq 'HEAD';
23 return 1 if $c->response->has_body;
24 return 1 if scalar @{ $c->error };
25 return 1 if $c->response->status =~ /^(?:204)$/;
26 return 1 if defined $c->stash->{current_view};
27 return 1 if defined $c->stash->{current_view_instance};
29 # on 3xx responses, serialize if there's something to
30 # serialize, no-op if not
32 $controller->{'serialize'} ?
33 $controller->{'serialize'}->{'stash_key'} :
34 $controller->{'stash_key'}
36 return 1 if $c->response->status =~ /^(?:3\d\d)$/ && ! defined $c->stash->{$stash_key};
38 my ( $sclass, $sarg, $content_type ) =
39 $self->_load_content_plugins( "Catalyst::Action::Serialize",
41 unless ( defined($sclass) ) {
42 if ( defined($content_type) ) {
43 $c->log->info("Could not find a serializer for $content_type");
46 "Could not find a serializer for an empty content-type");
51 "Serializing with $sclass" . ( $sarg ? " [$sarg]" : '' ) ) if $c->debug;
53 $self->_encoders->{$sclass} ||= $sclass->new;
54 my $sobj = $self->_encoders->{$sclass};
58 if ( defined($sarg) ) {
59 $rc = $sobj->execute( $controller, $c, $sarg );
61 $rc = $sobj->execute( $controller, $c );
65 return $self->serialize_bad_request( $c, $content_type, $@ );
67 return $self->unsupported_media_type( $c, $content_type );
73 __PACKAGE__->meta->make_immutable;
79 Catalyst::Action::Serialize - Serialize Data in a Response
83 package Foo::Controller::Bar;
86 'default' => 'text/x-yaml',
87 'stash_key' => 'rest',
89 'text/html' => [ 'View', 'TT', ],
90 'text/x-yaml' => 'YAML',
91 'text/x-data-dumper' => [ 'Data::Serializer', 'Data::Dumper' ],
95 sub end :ActionClass('Serialize') {}
99 This action will serialize the body of an HTTP Response. The serializer is
100 selected by introspecting the HTTP Requests content-type header.
102 It requires that your Catalyst controller is properly configured to set up the
103 mapping between Content Type's and Serialization classes.
105 The specifics of serializing each content-type is implemented as a plugin to
106 L<Catalyst::Action::Serialize>.
108 Typically, you would use this ActionClass on your C<end> method. However,
109 nothing is stopping you from choosing specific methods to Serialize:
111 sub foo :Local :ActionClass('Serialize') {
112 .. populate stash with data ..
115 When you use this module, the request class will be changed to
116 L<Catalyst::Request::REST>.
122 Takes a hashref, mapping Content-Types to a given serializer plugin.
126 This is the 'fall-back' Content-Type if none of the requested or acceptable
127 types is found in the L</map>. It must be an entry in the L</map>.
131 Specifies the key of the stash entry holding the data that is to be serialized.
132 So if the value is "rest", we will serialize the data under:
136 =head2 content_type_stash_key
138 Specifies the key of the stash entry that optionally holds an overriding
139 Content-Type. If set, and if the specified stash entry has a valid value,
140 then it takes priority over the requested content types.
142 This can be useful if you want to dynamically force a particular content type,
143 perhaps for debugging.
145 =head1 HELPFUL PEOPLE
147 Daisuke Maki pointed out that early versions of this Action did not play
148 well with others, or generally behave in a way that was very consistent
149 with the rest of Catalyst.
153 For building custom error responses when serialization fails, you can create
154 an ActionRole (and use L<Catalyst::Controller::ActionRole> to apply it to the
155 C<end> action) which overrides C<unsupported_media_type> and/or C<_serialize_bad_request>
160 You likely want to look at L<Catalyst::Controller::REST>, which implements
161 a sensible set of defaults for doing a REST controller.
163 L<Catalyst::Action::Deserialize>, L<Catalyst::Action::REST>
167 See L<Catalyst::Action::REST> for authors.
171 You may distribute this code under the same terms as Perl itself.