NAME
Catalyst::Model::HTMLFormhandler - Proxy a directory of HTML::Formhandler forms
SYNOPSIS
For Catalyst v5.90090+
package MyApp;
use Catalyst;
MyApp->request_class_traits(['Catalyst::TraitFor::Request::ContentNegotiationHelpers']);
MyApp->setup;For Catalyst older than v5.90090
package MyApp;
use Catalyst;
use CatalystX::RoleApplicator;
MyApp->apply_request_class_roles('Catalyst::TraitFor::Request::ContentNegotiationHelpers');
MyApp->setup;In a controller:
package MyApp::Controller::Example;
use Moose;
use MooseX::MethodAttributes;
sub myaction :Local {
my ($self, $c) = @_;
my $best_media_type = $c->req->choose_media_type('application/json', 'text/html');
}DESCRIPTION
When using Catalyst and developing web APIs it can be desirable to examine the state of HTTP Headers of the request to make decisions about what to do, for example what format to return (HTML, XML, JSON, other). This role can be applied to your Catalyst::Request to add some useful helper methods for the more common types of server side content negotiation.
Most of the real work is done by HTTP::Headers::ActionPack::ContentNegotiation, this role just seeks to make it easier to use those features.
ATTRIBUTES
This role defines the following attributes.
content_negotiator
This is a 'bare' attribute with no direct accessors. It expose a few methods to assist in content negotation.
METHODS
This role defines the following methods:
choose_media_type (@array_of_types)
Given an array of possible media types ('application/json', 'text/html', etc.) return the one that is the best match for the current request.
choose_language (@array_of_langauges)
Given an array of possible media types ('en-US', 'es', etc.) return the one that is the best match for the current request.
choose_charset (@array_of_character_sets)
Given an array of possible media types ("UTF-8", "US-ASCII", etc.) return the one that is the best match for the current request.
choose_encoding (@array_of_encodings)
Given an array of possible encodings ("gzip", "identity", etc.) return the one that is the best match for the current request.
raw_choose_media_type
raw_choose_language
raw_choose_charset
raw_choose_encoding
These are methods that map directly to the underlying HTTP::Headers::ActionPack::ContentNegotiation object. The are basicallty the same functionality except they require two arguments (an additional one to support the HTTP header string). You generally won't need them unless you need to compare am HTTP header that is not one that is part of the current request.
AUTHOR
John Napiorkowski email:jjnapiork@cpan.org
SEE ALSO
Catalyst, Catalyst::Model, HTML::Formhandler, Module::Pluggable
COPYRIGHT & LICENSE
Copyright 2015, John Napiorkowski email:jjnapiork@cpan.org
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.