Koha/Caches.pm

   1 package Koha::Caches;
   2
   3 # This file is part of Koha.
   4 #
   5 # Koha is free software; you can redistribute it and/or modify it
   6 # under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # Koha is distributed in the hope that it will be useful, but
  11 # WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  17
  18 =head1 NAME
  19
  20 Koha::Caches - Cache handling
  21
  22 =head1 SYNOPSIS
  23
  24 my $cache = Koha::Caches->get_instance();
  25
  26 =head1 DESCRIPTION
  27
  28 Description
  29
  30 =head1 CLASS METHODS
  31
  32 =cut
  33
  34 use Modern::Perl;
  35
  36 use Koha::Cache;
  37
  38 our $singleton_caches;
  39
  40 =head2 get_instance
  41
  42 This gets a shared instance of the cache, set up in a very default way. This is
  43 the recommended way to fetch a cache object. If possible, it'll be
  44 persistent across multiple instances.
  45
  46 =cut
  47
  48 sub get_instance {
  49     my ($class, $subnamespace) = @_;
  50     $subnamespace //= '';
  51     $singleton_caches->{$subnamespace} = Koha::Cache->new({}, { subnamespace => $subnamespace } )
  52         unless $singleton_caches->{$subnamespace};
  53     return $singleton_caches->{$subnamespace};
  54 }
  55
  56 =head2 flush_L1_caches
  57
  58 =cut
  59
  60 sub flush_L1_caches {
  61     return unless $singleton_caches;
  62     for my $cache ( values %$singleton_caches ) {
  63         $cache->flush_L1_cache;
  64     }
  65 }
  66
  67 1;