GeneralCatalog -> rel-2_1 API documentation

NAME

Kernel::System::CacheInternal - cache lib

SYNOPSIS

All cache functions for internal cache management.

Notice: This module is storing the cache information in memory and also permanently (e. g. in file system). So you need to take care, that you have not several instances of the CacheInternalObject at one runtime, because the in memory cache will fail then.

PUBLIC INTERFACE

• new()

  create an object

  use Kernel::Config;
  use Kernel::System::Encode;
  use Kernel::System::Log;
  use Kernel::System::Main;
  use Kernel::System::CacheInternal;
  
  my $ConfigObject = Kernel::Config->new();
  my $EncodeObject = Kernel::System::Encode->new(
      ConfigObject => $ConfigObject,
  );
  my $LogObject = Kernel::System::Log->new(
      ConfigObject => $ConfigObject,
      EncodeObject => $EncodeObject,
  );
  my $MainObject = Kernel::System::Main->new(
      ConfigObject => $ConfigObject,
      EncodeObject => $EncodeObject,
      LogObject    => $LogObject,
  );
  my $CacheInternalObject = Kernel::System::CacheInternal->new(
      ConfigObject => $ConfigObject,
      LogObject    => $LogObject,
      MainObject   => $MainObject,
      EncodeObject => $EncodeObject,
      Type         => 'ObjectName', # only A-z chars usable
      TTL          => 60 * 60 * 24,
  );
  

• Set()

  set a new cache

  $CacheInternalObject->Set(
      Key   => 'SomeKey',
      Value => 'Some Value',
  );
  

• Get()

  return a cache

  my $Value = $CacheInternalObject->Get(
      Key  => 'SomeKey',
  );
  

• Delete()

  delete a cache

  $CacheInternalObject->Delete(
      Key  => 'SomeKey',
  );
  

• CleanUp()

  delete all caches

  $CacheInternalObject->CleanUp();
  

  If another cache type needs to be cleaned up, you can use the parameter 'OtherType'.

  $CacheInternalObject->CleanUp(OtherType => 'SomeType');
  

  This is useful for cleaning up dependent cache entries after the modification of objects (for example, cleaning up the group cache after modifying agents).

  NOTE: This 'OtherType'-cleanup only affects permanent caches. In-memory-caches in other CacheInternal objects cannot be cleaned up presently, therefore a refactoring of the entire caching architecture will be neccessary.

TERMS AND CONDITIONS

This software is part of the OTRS project (http://otrs.org/).

This software comes with ABSOLUTELY NO WARRANTY. For details, see the enclosed file COPYING for license information (AGPL). If you did not receive this file, see http://www.gnu.org/licenses/agpl.txt.

VERSION

$Revision: 1.4.2.1 $ $Date: 2011-04-07 20:15:56 $