X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FCatalyst%2FView%2FComponent%2FSubInclude.pm;h=4bb7f6906986bb77befc4340db63fc73b00da423;hb=bff1b853c17ad52e468fe8984ab3b18964463c7f;hp=57fd5caa16e714612aaa3805f0f10071965f6859;hpb=cc37b7b32b018f25612606a817a0588d10acdf7a;p=catagits%2FCatalyst-View-Component-SubInclude.git diff --git a/lib/Catalyst/View/Component/SubInclude.pm b/lib/Catalyst/View/Component/SubInclude.pm index 57fd5ca..4bb7f69 100644 --- a/lib/Catalyst/View/Component/SubInclude.pm +++ b/lib/Catalyst/View/Component/SubInclude.pm @@ -15,11 +15,11 @@ Catalyst::View::Component::SubInclude - Use subincludes in your Catalyst views =head1 VERSION -Version 0.07_01 +Version 0.07_03 =cut -our $VERSION = '0.07_01'; +our $VERSION = '0.07_03'; $VERSION = eval $VERSION; =head1 SYNOPSIS @@ -41,46 +41,46 @@ Then, somewhere in your templates: C allows you to include content in your templates (or, more generally, somewhere in your view's C processing) -which comes from another action in your application. It's implemented as a +which comes from another action in your application. It's implemented as a L, so using L in your view is required. Simply put, it's a way to include the output of a Catalyst sub-request somewhere -in your page. +in your page. -It's built in an extensible way so that you're free to use sub-requests, Varnish -ESI (L) or any other +It's built in an extensible way so that you're free to use sub-requests, Varnish +ESI (L) or any other sub-include plugin you might want to implement. An LWP plugin seems useful and might be developed in the future. =head1 STASH FUNCTIONS This component does its magic by exporting a C coderef entry to the -stash. This way, it's easily accessible by the templates (which is the most +stash. This way, it's easily accessible by the templates (which is the most common use-case). =head2 C -This will render and return the body of the included resource (as specified by +This will render and return the body of the included resource (as specified by C<$path>) using the default subinclude plugin. =head2 C -This will render and return the body of the included resource (as specified by +This will render and return the body of the included resource (as specified by C<$path>) using the specified subinclude plugin. -The C function above is implemented basically as a shortcut which +The C function above is implemented basically as a shortcut which calls this function using the default plugin as the first parameter. =head1 SUBINCLUDE PLUGINS -The module comes with two subinclude plugins: +The module comes with two subinclude plugins: L, -L and +L and L. -By default, the C plugin will be used. This can be changed in the +By default, the C plugin will be used. This can be changed in the view's configuration options (either in the config file or in the view module -itself). +itself). Configuration file example: @@ -91,12 +91,12 @@ Configuration file example: =head2 C This method changes the current active subinclude plugin in runtime. It expects -the plugin suffix (e.g. C or C) or a fully-qualified class +the plugin suffix (e.g. C or C) or a fully-qualified class name in the C namespace. =head2 Writing plugins -If writing your own plugin, keep in kind plugins are required to implement a +If writing your own plugin, keep in kind plugins are required to implement a class method C with the following signature: sub generate_subinclude { @@ -116,12 +116,12 @@ has 'subinclude_plugin' => ( around 'new' => sub { my $next = shift; my $class = shift; - + my $self = $class->$next( @_ ); - + my $subinclude_plugin = $self->config->{subinclude_plugin} || 'SubRequest'; $self->set_subinclude_plugin( $subinclude_plugin ); - + $self; }; @@ -158,7 +158,7 @@ has _subinclude_plugin_class_instance_cache => ( sub _subinclude_plugin_class_instance { my ($self, $plugin) = @_; - + my $class = $plugin =~ /::/ ? $plugin : __PACKAGE__ . '::' . $plugin; my $cache = $self->_subinclude_plugin_class_instance_cache; @@ -168,7 +168,7 @@ sub _subinclude_plugin_class_instance { $self->config->{subinclude}->{ALL}||{}, $self->config->{subinclude}->{$plugin}||{} ); - + Class::MOP::load_class($class); return $cache->{$plugin} = $class->new($plugin_config); @@ -176,7 +176,7 @@ sub _subinclude_plugin_class_instance { =head1 SEE ALSO -L, +L, L, L, L @@ -192,12 +192,18 @@ your bug as I make changes. Nilson Santos Figueiredo Junior, C<< >> +=head1 CONTRIBUTORS + +Tomas Doran (t0m) C<< >. + =head1 SPONSORSHIP Development sponsored by Ionzero LLC L. =head1 COPYRIGHT & LICENSE +Copyright (C) 2010 Nilson Santos Figueiredo Junior and the above contributors. + Copyright (C) 2009 Nilson Santos Figueiredo Junior. Copyright (C) 2009 Ionzero LLC.