X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FView%2FComponent%2FSubInclude%2FSubRequest.pm;h=4b997c0f427c473a7b354d800240be8ef6a46795;hb=7c937cccd1caf12c59b11f07ee76144f770b3ad8;hp=cbf1886c125a0dfe798cd21a8180e304bd886996;hpb=307266327522e574890b4c59074c0598d17e8cd2;p=catagits%2FCatalyst-View-Component-SubInclude.git diff --git a/lib/Catalyst/View/Component/SubInclude/SubRequest.pm b/lib/Catalyst/View/Component/SubInclude/SubRequest.pm index cbf1886..4b997c0 100644 --- a/lib/Catalyst/View/Component/SubInclude/SubRequest.pm +++ b/lib/Catalyst/View/Component/SubInclude/SubRequest.pm @@ -2,14 +2,112 @@ package Catalyst::View::Component::SubInclude::SubRequest; use warnings; use strict; +use Carp qw/croak/; +use namespace::clean qw/croak/; + +=head1 NAME + +Catalyst::View::Component::SubInclude::SubRequest - Sub-requests plugin for C::V::Component::SubInclude + +=head1 VERSION + +Version 0.05 + +=cut + +our $VERSION = '0.05'; + +=head1 SYNOPSIS + +In your application class: + + package MyApp; + + use Catalyst qw/ + ConfigLoader + Static::Simple + ... + SubRequest + /; + +In your view class: + + package MyApp::View::TT; + use Moose; + + extends 'Catalyst::View::TT'; + with 'Catalyst::View::Component::SubInclude'; + + __PACKAGE__->config( subinclude_plugin => 'SubRequest' ); + +Then, somewhere in your templates: + + [% subinclude('/my/widget') %] + +=head1 DESCRIPTION + +C uses Catalyst sub-requests +to render the subinclude contents. + +It requires L. + +=head1 CLASS METHODS + +=head2 C + +This will make a sub-request call to the action specified by C<$path>. Note that +C<$path> should be the private action path - translation to the public path is +handled internally. + +So, after path translation, the call will be (roughly) equivalent to: + + $c->sub_request( $translated_path, {}, @args ); + +Notice that the stash will always be empty. This behavior could be configurable +in the future through an additional switch - for now, this behavior guarantees a +common interface for all plugins. + +=cut + sub generate_subinclude { - my ($class, $c, $path, $params) = @_; + my ($class, $c, $path, @params) = @_; my $stash = {}; croak "subincludes through subrequests require Catalyst::Plugin::SubRequest" unless $c->can('sub_request'); - $c->sub_request( $path, $stash, $params ); + my $args = ref $params[0] eq 'ARRAY' ? shift @params : []; + + my $dispatcher = $c->dispatcher; + my ($action) = $dispatcher->_invoke_as_path( $c, $path, $args ); + + my $uri = $c->uri_for( $action, $args, @params ); + + $c->sub_request( $uri->path, $stash, @params ); } +=head1 SEE ALSO + +L, +L + +=head1 AUTHOR + +Nilson Santos Figueiredo Junior, C<< >> + +=head1 SPONSORSHIP + +Development sponsored by Ionzero LLC L. + +=head1 COPYRIGHT & LICENSE + +Copyright (C) 2009 Nilson Santos Figueiredo Junior. + +Copyright (C) 2009 Ionzero LLC. + +This program is free software; you can redistribute it and/or modify it +under the same terms as Perl itself. + +=cut + 1;