cache/upgrade.txt

   1 This files describes API changes in /cache/stores/* - cache store plugins.
   2 Information provided here is intended especially for developers.
   3
   4 === 2.9 ===
   5 * Cache data source aggregation functionality has been removed. This functionality was found to be broken and unused.
   6   It was decided that rather than fixing it it should be removed.
   7   As well as the processing code being removed the following API changes have been made.
   8   The following changes have come about because of it:
   9    - cache_definition::$datasourceaggregate is deprecated an unused.
  10    - cache_definition::load Argument 3 (final arg) is now unused.
  11    - cache_factory::create_cache_from_definition Argument 4 (final arg) is now unused.
  12    - cache::make Argument 4 (final arg) is now unused.
  13 * cache_config_phpunittest has been renamed to cache_config_testing
  14 * New method cache_store::ready_to_be_used_for_testing() that returns true|false if the store is suitable and ready for use as the primary store during unit and acceptance tests.
  15 * cache_helper::get_stats structure we changed to include the cache mode.
  16
  17 === 2.7 ===
  18 * cache_store::is_ready is no longer abstract, calling cache_store::are_requirements_met by default.
  19
  20 === 2.6 ===
  21 * All cache instances are recorded and subsequent requests are given a reference to the original instance.
  22 * The persistent option for the cache definition has been deprecated. Please use the staticacceleration option instead.
  23 * There is a new static acceleration option. If enabled data passing through the cache is held onto.
  24 * The persistentmaxsize option has been renamed to staticaccelerationsize. It does the same thing.
  25 * cache_definition::should_be_persistent has been deprecated. Please call cache_definition::use_static_acceleration instead.
  26 * cache_definition::get_persistent_max_size has been deprecated. Please call cache_definition::get_static_acceleration_size instead.
  27 * cache::is_using_persist_cache() has been deprecated. Please call  cache::use_static_acceleration()
  28 * cache::is_in_persist_cache() has been deprecated. Please call  cache::static_acceleration_has()
  29 * cache::get_from_persist_cache() has been deprecated. Please call  cache::static_acceleration_get()
  30 * cache::set_in_persist_cache() has been deprecated. Please call  cache::static_acceleration_set()
  31 * cache::delete_from_persist_cache() has been deprecated. Please call cache::static_acceleration_delete()
  32 * If you have any custom cache loaders you will need to rename these methods if you have overriden them and adjust any calls you may have made to them.
  33
  34 === 2.5 ===
  35 * cleanup method renamed to instance_deleted.
  36   It is now called when the store is deleted as all comments suggested anyway.
  37 * instance_created method added.
  38   It is called when the store is created for the very first time.