.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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" ''
.    ds C`
.    ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Rose::DB::Cache::Entry 3pm"
.TH Rose::DB::Cache::Entry 3pm "2023-03-04" "perl v5.36.0" "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"
Rose::DB::Cache::Entry \- A cache entry for use with Rose::DB::Cache objects.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  package My::DB::Cache::Entry;
\&
\&  use base \*(AqRose::DB::Cache::Entry\*(Aq;
\&  ...
\&
\&  package My::DB::Cache;
\&
\&  use base \*(AqRose::DB::Cache\*(Aq;
\&
\&  use My::DB::Cache::Entry;
\&
\&  _\|_PACKAGE_\|_\->entry_class(\*(AqMy::DB::Cache::Entry\*(Aq);
\&  ...
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Rose::DB::Cache::Entry provides both an \s-1API\s0 and a default implementation of a cache entry for use with Rose::DB::Cache objects.  A Rose::DB::Cache\-derived class uses Rose::DB::Cache::Entry\-derived objects to store cache entries.
.PP
The default implementation includes attributes for storing the cache key, the cached Rose::DB\-derived object itself, and some boolean flags.  Subclasses can add new attributes as desired.
.SH "CONSTRUCTORS"
.IX Header "CONSTRUCTORS"
.IP "\fBnew \s-1PARAMS\s0\fR" 4
.IX Item "new PARAMS"
Constructs a new Rose::DB::Cache::Entry object based on \s-1PARAMS,\s0 where \s-1PARAMS\s0 are name/value pairs.  Any object method is a valid parameter name.
.SH "OBJECT METHODS"
.IX Header "OBJECT METHODS"
.IP "\fBcreated_during_apache_startup [\s-1BOOL\s0]\fR" 4
.IX Item "created_during_apache_startup [BOOL]"
Get or set a boolean value indicating whether or not the db object this cache entry contains was created while the apache server was starting up.
.IP "\fBdb [\s-1DB\s0]\fR" 4
.IX Item "db [DB]"
Get or set the Rose::DB\-derived object stored in this cache entry.
.IP "\fBkey [\s-1KEY\s0]\fR" 4
.IX Item "key [KEY]"
Get or set the cache key for this entry.
.IP "\fBprepared [\s-1BOOL\s0]\fR" 4
.IX Item "prepared [BOOL]"
Get or set a boolean value indicating whether or not a cache entry is \*(L"prepared.\*(R"  The interpretation of this flag is up to the Rose::DB::Cache\-derived class that uses this entry class.
.IP "\fBis_prepared\fR" 4
.IX Item "is_prepared"
Returns true if prepared is true, false otherwise.
.SH "AUTHOR"
.IX Header "AUTHOR"
John C. Siracusa (siracusa@gmail.com)
.SH "LICENSE"
.IX Header "LICENSE"
Copyright (c) 2010 by John C. Siracusa.  All rights reserved.  This program is
free software; you can redistribute it and/or modify it under the same terms
as Perl itself.