.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Gantry::Plugins::PageCache 3"
.TH Gantry::Plugins::PageCache 3 "2008-01-18" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Gantry::Plugins::PageCache \- A plugin for caching application pages
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
In Apache Perl startup or app.cgi or app.server:
.PP
.Vb 8
\&    <Perl>
\&        # ...
\&        use MyApp qw{ 
\&            -Engine=CGI 
\&            -TemplateEngine=TT 
\&            Cache::FastMap # or Cache::Storable 
\&            PageCache 
\&        };
.Ve
.PP
.Vb 1
\&    </Perl>
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The purpose of the plugin is to store and retrieve cached application pages.
.PP
Note that you must include PageCache in the list of imported items when you use 
your base app module. 
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
The following items can be set by configuration. If any of the following 
match then caching will be enabled. 
.PP
** At least one cache criteria must be set.
.PP
Cache pages based on a certain action.
.PP
.Vb 1
\& $self->gantry_pagecache_action( 'do_edit,do_delete,do_view' );
.Ve
.PP
Cache pages based on the mime types.
.PP
.Vb 1
\& $self->gantry_pagecache_mime_type( 'text/html,text/rss' );
.Ve
.PP
Cache every page that is produced by a controller.
.PP
.Vb 1
\& $self->gantry_pagecache_location( '/controller1' );
.Ve
.PP
Cache distinct pages produced by a controller.
.PP
.Vb 1
\& $self->gantry_pagecache_uri( '/controller1/rss' );
.Ve
.SH "METHODS"
.IX Header "METHODS"
.IP "get_callbacks" 4
.IX Item "get_callbacks"
For use by Gantry.pm. Registers the callbacks needed for cache  management
during the PerlHandler Apache phase or its moral equivalent.
.IP "gantry_pagecache_store" 4
.IX Item "gantry_pagecache_store"
Callback to store the cached page.
.IP "gantry_pagecache_retrieve" 4
.IX Item "gantry_pagecache_retrieve"
Callback to retrieve the cached page.
.IP "gantry_pagecache_location" 4
.IX Item "gantry_pagecache_location"
Location(s) to cache
.IP "gantry_pagecache_action" 4
.IX Item "gantry_pagecache_action"
Action(s) to cache
.IP "gantry_pagecache_crud" 4
.IX Item "gantry_pagecache_crud"
Boolean accessor for whether to attempt caching of \s-1CRUD\s0 behaviors.
.IP "gantry_pagecache_mime_type" 4
.IX Item "gantry_pagecache_mime_type"
\&\s-1MIME\s0 type(s) to cache
.IP "gantry_pagecache_uri" 4
.IX Item "gantry_pagecache_uri"
\&\s-1URI\s0(s) to cache
.IP "gantry_pagecache" 4
.IX Item "gantry_pagecache"
Holds the cache key if caching is enabled
.SH "TODO"
.IX Header "TODO"
Add a caching scheme where you can use an SQL::Abstract like syntax.
.PP
.Vb 15
\& {
\&    -and => {
\&        mime_type = [
\&            'text/html',
\&            'text/rss',
\&        ],
\&        location = [
\&            '/controller1',
\&            '/controller2',
\&        ],
\&    },
\&    -or => {
\&        mime_type => { '!=', 'img/gif' } 
\&    }
\& }
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.Vb 1
\&    Gantry
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Tim Keefer <tim@timkeefer.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2007 Tim Keefer
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.6 or,
at your option, any later version of Perl 5 you may have available.