Catalyst::Action::Deserialize man page on Pidora

Man page or keyword search:  
man Server   31170 pages
apropos Keyword Search (all sections)
Output format
Pidora logo
[printable version]

Catalyst::Action::DeseUseriContributed Perl DoCatalyst::Action::Deserialize(3)

NAME
       Catalyst::Action::Deserialize - Deserialize Data in a Request

SYNOPSIS
	   package Foo::Controller::Bar;

	   __PACKAGE__->config(
	       'default'   => 'text/x-yaml',
	       'stash_key' => 'rest',
	       'map'	   => {
		   'text/x-yaml'	=> 'YAML',
		   'text/x-data-dumper' => [ 'Data::Serializer', 'Data::Dumper' ],
	       },
	   );

	   sub begin :ActionClass('Deserialize') {}

DESCRIPTION
       This action will deserialize HTTP POST, PUT, OPTIONS and DELETE
       requests.  It assumes that the body of the HTTP Request is a serialized
       object.	The serializer is selected by introspecting the requests
       content-type header.

       If you want deserialize any other HTTP method besides POST, PUT,
       OPTIONS and DELETE you can do this by setting the
       "deserialize_http_methods" list via "action_args".  Just modify the
       config in your controller and define a list of HTTP methods the
       deserialization should happen for:

	   __PACKAGE__->config(
	       action_args => {
		   '*' => {
		       deserialize_http_methods => [qw(POST PUT OPTIONS DELETE GET)]
		   }
	       }
	   );

       See also "action_args" in Catalyst::Controller.

       The specifics of deserializing each content-type is implemented as a
       plugin to Catalyst::Action::Deserialize.	 You can see a list of
       currently implemented plugins in Catalyst::Controller::REST.

       The results of your Deserializing will wind up in $c->req->data.	 This
       is done through the magic of Catalyst::Request::REST.

       While it is common for this Action to be called globally as a "begin"
       method, there is nothing stopping you from using it on a single
       routine:

	  sub foo :Local :Action('Deserialize') {}

       Will work just fine.

       When you use this module, the request class will be changed to
       Catalyst::Request::REST.

CUSTOM ERRORS
       For building custom error responses when de-serialization fails, you
       can create an ActionRole (and use Catalyst::Controller::ActionRole to
       apply it to the "begin" action) which overrides
       "unsupported_media_type" and/or "_serialize_bad_request" methods.

SEE ALSO
       You likely want to look at Catalyst::Controller::REST, which implements
       a sensible set of defaults for a controller doing REST.

       Catalyst::Action::Serialize, Catalyst::Action::REST

AUTHORS
       See Catalyst::Action::REST for authors.

LICENSE
       You may distribute this code under the same terms as Perl itself.

perl v5.14.2			  2012-07-02  Catalyst::Action::Deserialize(3)
[top]

List of man pages available for Pidora

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net