.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" Standard preamble:
.\" ========================================================================
.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.  \*(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-
.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\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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 "Mason::Plugin::Cache 3pm"
.TH Mason::Plugin::Cache 3pm "2012-10-29" "perl v5.14.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Mason::Plugin::Cache \- Provide component cache object and filter
.SH "VERSION"
.IX Header "VERSION"
version 0.05
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\&    my $result = $.cache\->get(\*(Aqkey\*(Aq);
\&    if (!defined($result)) {
\&        ... compute $result ...
\&        $.cache\->set(\*(Aqkey\*(Aq, $result, \*(Aq5 minutes\*(Aq);
\&    }
\&
\&    ...
\&
\&    % $.Cache(\*(Aqkey2\*(Aq, \*(Aq1 hour\*(Aq) {{
\&      <!\-\- this will be cached for an hour \-\->
\&    % }}
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Adds a \f(CW\*(C`cache\*(C'\fR method and \f(CW\*(C`Cache\*(C'\fR filter to access a cache (\s-1CHI\s0)
object with a namespace unique to the component.
.SH "INTERP PARAMETERS"
.IX Header "INTERP PARAMETERS"
.IP "cache_defaults" 4
.IX Item "cache_defaults"
Hash of parameters passed to cache constructor. Defaults to
.Sp
.Vb 1
\&    driver=>\*(AqFile\*(Aq, root_dir => \*(AqDATA_DIR/cache\*(Aq
.Ve
.Sp
which will create a basic file cache under Mason's data directory.
.IP "cache_root_class" 4
.IX Item "cache_root_class"
Class used to create a cache. Defaults to \s-1CHI\s0.
.SH "COMPONENT CLASS METHODS"
.IX Header "COMPONENT CLASS METHODS"
.IP "cache" 4
.IX Item "cache"
Returns a new cache object with the namespace set to the component's path.
Parameters to this method, if any, are combined with cache_defaults and
passed to the cache_root_class constructor.  The cache object is memoized
when no parameters are passed.
.Sp
.Vb 1
\&    my $result = $.cache\->get(\*(Aqkey\*(Aq);
.Ve
.SH "REQUEST METHODS"
.IX Header "REQUEST METHODS"
.IP "cache" 4
.IX Item "cache"
Same as calling \f(CW\*(C`cache\*(C'\fR on the current component class. This usage will be
familiar to Mason 1 users.
.Sp
.Vb 1
\&    my $result = $m\->cache\->get(\*(Aqkey\*(Aq);
.Ve
.SH "FILTERS"
.IX Header "FILTERS"
.ie n .IP "Cache ($key, $options, [%cache_params])" 4
.el .IP "Cache ($key, \f(CW$options\fR, [%cache_params])" 4
.IX Item "Cache ($key, $options, [%cache_params])"
Caches the content using \f(CW\*(C`$self\->cache\*(C'\fR and the supplied cache \fI\f(CI$key\fI\fR.
.Sp
\&\fI\f(CI$options\fI\fR is a scalar or hash reference. If a scalar, it is treated as the
\&\f(CW\*(C`expires_in\*(C'\fR duration and passed as the third argument to \f(CW\*(C`set\*(C'\fR. If it is a
hash reference, it may contain name/value pairs for both \f(CW\*(C`get\*(C'\fR and \f(CW\*(C`set\*(C'\fR.
.Sp
\&\fI\f(CI%cache_params\fI\fR, if any, are passed to \f(CW\*(C`$self\->cache\*(C'\fR.
.Sp
.Vb 3
\&    % $.Cache($my_key, \*(Aq1 hour\*(Aq) {{
\&      <!\-\- this will be cached for an hour \-\->
\&    % }}
\&
\&    % $.Cache($my_key, { expire_if => sub { $.refresh } }, driver => \*(AqRawMemory\*(Aq) {{
\&      <!\-\- this will be cached until $.refresh is true \-\->
\&    % }}
.Ve
.Sp
If neither \fI\f(CI$key\fI\fR nor \fI\f(CI$options\fI\fR are passed, the key is set to 'Default' and
the cache never expires.
.Sp
.Vb 3
\&    % $.Cache() {{
\&      <!\-\- cache this forever, or until explicitly removed \-\->
\&    % }}
.Ve
.SH "SUPPORT"
.IX Header "SUPPORT"
The mailing list for Mason and Mason plugins is
mason\-users@lists.sourceforge.net. You must be subscribed to send a message.
To subscribe, visit
https://lists.sourceforge.net/lists/listinfo/mason\-users <https://lists.sourceforge.net/lists/listinfo/mason-users>.
.PP
You can also visit us at \f(CW\*(C`#mason\*(C'\fR on <irc://irc.perl.org/#mason>.
.PP
Bugs and feature requests will be tracked at \s-1RT:\s0
.PP
.Vb 2
\&    http://rt.cpan.org/NoAuth/Bugs.html?Dist=Mason\-Plugin\-Cache
\&    bug\-mason\-plugin\-cache@rt.cpan.org
.Ve
.PP
The latest source code can be browsed and fetched at:
.PP
.Vb 2
\&    http://github.com/jonswar/perl\-mason\-plugin\-cache
\&    git clone git://github.com/jonswar/perl\-mason\-plugin\-cache.git
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mason
.SH "AUTHOR"
.IX Header "AUTHOR"
Jonathan Swartz <swartz@pobox.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2011 by Jonathan Swartz.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.