About Features Downloads Getting Started Documentation Events Support GitHub

Site Tools


development:architecture:caching

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Last revision Both sides next revision
development:architecture:caching [2016/05/09 20:24]
demiankatz
development:architecture:caching [2020/03/04 13:40]
demiankatz
Line 5: Line 5:
 ===== The Cache Manager and Its Caches ===== ===== The Cache Manager and Its Caches =====
  
-VuFind has a [[https://github.com/vufind-org/vufind/blob/master/module/VuFind/src/VuFind/Cache/Manager.php|VuFind\Cache\Manager]] class which pre-configures Zend Framework cache objects and/or directory locations for several named caches. Each of these caches is used slightly differently.+VuFind has a [[https://github.com/vufind-org/vufind/blob/master/module/VuFind/src/VuFind/Cache/Manager.php|VuFind\Cache\Manager]] class which pre-configures [[development:architecture:laminas|Laminas]] cache objects and/or directory locations for several named caches. Each of these caches is used slightly differently.
  
-  * config - stores top-level Zend Framework configurations; manually set up in [[https://github.com/vufind-org/vufind/blob/master/config/application.config.php|application.config.php]] but included in the cache manager to assist with automated cache clearing in the admin panel.+  * config - stores top-level Laminas configurations; manually set up in [[https://github.com/vufind-org/vufind/blob/master/config/application.config.php|application.config.php]] but included in the cache manager to assist with automated cache clearing in the admin panel.
   * cover - stores cover images; used by the [[https://github.com/vufind-org/vufind/blob/master/module/VuFind/src/VuFind/Cover/Loader.php|cover loader]] to store downloaded image files.   * cover - stores cover images; used by the [[https://github.com/vufind-org/vufind/blob/master/module/VuFind/src/VuFind/Cover/Loader.php|cover loader]] to store downloaded image files.
   * language - stores parsed i18n language files; set up as part of [[https://github.com/vufind-org/vufind/blob/v3.0/module/VuFind/src/VuFind/Service/Factory.php#L883|i18n initialization]].    * language - stores parsed i18n language files; set up as part of [[https://github.com/vufind-org/vufind/blob/v3.0/module/VuFind/src/VuFind/Service/Factory.php#L883|i18n initialization]]. 
Line 16: Line 16:
  
 The location of the cache may vary depending on various environment variables, your VuFind version, and whether you are running code through Apache or from the command line. See VuFind\Cache\Manager::getCacheDir for the rules that apply in your particular version of VuFind. The location of the cache may vary depending on various environment variables, your VuFind version, and whether you are running code through Apache or from the command line. See VuFind\Cache\Manager::getCacheDir for the rules that apply in your particular version of VuFind.
 +
 +===== Consumers of the Object Cache =====
 +
 +As noted above, VuFind's object cache is the best general-purpose place for storing data, as long as you use cache keys that do not conflict with other VuFind components. Here is a list of current keys reserved in the object cache (current as of VuFind 3.0):
 +
 +  * alephTranslator - used by VuFind\ILS\Driver\Aleph
 +  * edsAuthenticationToken - used by VuFindSearch\Backend\EDS\Backend
 +  * solrSearchAdvancedFacets*, solrSearchHomeFacets* - used by VuFind\Controller\SearchController
 +  * summonSearchAdvancedFacets - used by VuFind\Controller\SummonController
 +  * VoyagerRestful-* - used by VuFind\ILS\Driver\VoyagerRestful
development/architecture/caching.txt · Last modified: 2020/09/22 13:54 by demiankatz