1 package Catalyst::Action::Serialize;
4 use namespace::autoclean;
6 extends 'Catalyst::Action::SerializeBase';
7 use Module::Pluggable::Object;
15 default => sub { {} },
20 my ( $controller, $c ) = @_;
22 $self->maybe::next::method(@_);
24 return 1 if $c->req->method eq 'HEAD';
25 return 1 if $c->response->has_body;
26 return 1 if scalar @{ $c->error };
27 return 1 if $c->response->status =~ /^(?:204)$/;
28 return 1 if defined $c->stash->{current_view};
29 return 1 if defined $c->stash->{current_view_instance};
31 my ( $sclass, $sarg, $content_type ) =
32 $self->_load_content_plugins( "Catalyst::Action::Serialize",
34 unless ( defined($sclass) ) {
35 if ( defined($content_type) ) {
36 $c->log->info("Could not find a serializer for $content_type");
39 "Could not find a serializer for an empty content-type");
44 "Serializing with $sclass" . ( $sarg ? " [$sarg]" : '' ) ) if $c->debug;
46 $self->_encoders->{$sclass} ||= $sclass->new;
47 my $sobj = $self->_encoders->{$sclass};
51 if ( defined($sarg) ) {
52 $rc = $sobj->execute( $controller, $c, $sarg );
54 $rc = $sobj->execute( $controller, $c );
58 return $self->serialize_bad_request( $c, $content_type, $@ );
60 return $self->unsupported_media_type( $c, $content_type );
66 __PACKAGE__->meta->make_immutable;
72 Catalyst::Action::Serialize - Serialize Data in a Response
76 package Foo::Controller::Bar;
79 'default' => 'text/x-yaml',
80 'stash_key' => 'rest',
82 'text/html' => [ 'View', 'TT', ],
83 'text/x-yaml' => 'YAML',
84 'text/x-data-dumper' => [ 'Data::Serializer', 'Data::Dumper' ],
88 sub end :ActionClass('Serialize') {}
92 This action will serialize the body of an HTTP Response. The serializer is
93 selected by introspecting the HTTP Requests content-type header.
95 It requires that your Catalyst controller is properly configured to set up the
96 mapping between Content Type's and Serialization classes.
98 The specifics of serializing each content-type is implemented as a plugin to
99 L<Catalyst::Action::Serialize>.
101 Typically, you would use this ActionClass on your C<end> method. However,
102 nothing is stopping you from choosing specific methods to Serialize:
104 sub foo :Local :ActionClass('Serialize') {
105 .. populate stash with data ..
108 When you use this module, the request class will be changed to
109 L<Catalyst::Request::REST>.
115 Takes a hashref, mapping Content-Types to a given serializer plugin.
119 This is the 'fall-back' Content-Type if none of the requested or acceptable
120 types is found in the L</map>. It must be an entry in the L</map>.
124 Specifies the key of the stash entry holding the data that is to be serialized.
125 So if the value is "rest", we will serialize the data under:
129 =head2 content_type_stash_key
131 Specifies the key of the stash entry that optionally holds an overriding
132 Content-Type. If set, and if the specified stash entry has a valid value,
133 then it takes priority over the requested content types.
135 This can be useful if you want to dynamically force a particular content type,
136 perhaps for debugging.
138 =head1 HELPFUL PEOPLE
140 Daisuke Maki pointed out that early versions of this Action did not play
141 well with others, or generally behave in a way that was very consistent
142 with the rest of Catalyst.
146 For building custom error responses when serialization fails, you can create
147 an ActionRole (and use L<Catalyst::Controller::ActionRole> to apply it to the
148 C<end> action) which overrides C<unsupported_media_type> and/or C<_serialize_bad_request>
153 You likely want to look at L<Catalyst::Controller::REST>, which implements
154 a sensible set of defaults for doing a REST controller.
156 L<Catalyst::Action::Deserialize>, L<Catalyst::Action::REST>
160 See L<Catalyst::Action::REST> for authors.
164 You may distribute this code under the same terms as Perl itself.