Enable Cache to Speed-up Osclass

Osclass provides multiple caching mechanisms to improve performance and reduce database load. Before enabling any cache method, ensure that the corresponding cache extension is installed and enabled on your server.

Supported Cache Methods

• File (default)
• APC / APCu
• Memcache
• Memcached
• Redis

Enabling Cache in Osclass

To enable caching, you must modify the config.php file in the root directory of your Osclass installation.

APC / APCu

Add the following line to config.php:

define('OSC_CACHE', 'apc');

Memcache

For Memcache, you need to specify the host and port of the Memcached server:

define('OSC_CACHE', 'memcache');
$_cache_config[] = array(
    'default_host'      => '127.0.0.1',
    'default_port'      => 11211,
    'default_weight'    => 1
);

Cache Implementation in Osclass

Adding Data to Cache

To store data in the cache, Osclass provides the osc_cache_add() function:

function osc_cache_add($key, $data, $expire = 0) {
  $key .= osc_current_user_locale();
  return Object_Cache_Factory::newInstance()->add($key, $data, $expire);
}

Retrieving Data from Cache

To fetch stored data, use the osc_cache_get() function:

function osc_cache_get($key, &$found) {
  $key .= osc_current_user_locale();
  return Object_Cache_Factory::newInstance()->get($key, $found);
}

Deleting Cached Data

To remove specific cached data:

function osc_cache_delete($key) {
  $key .= osc_current_user_locale();
  return Object_Cache_Factory::newInstance()->delete($key);
}

Flushing the Cache

To clear all cached data:

function osc_cache_flush() {
  return Object_Cache_Factory::newInstance()->flush();
}

Cache Initialization

Osclass initializes the cache system using the Object_Cache_Factory class. This class determines the cache type defined in config.php and loads the appropriate caching implementation.

class Object_Cache_Factory {
  private static $instance;

  public static function newInstance() {
    if(self::$instance == null) {
      self::$instance = self::getCache();
    }
    return self::$instance;
  }

  public static function getCache() {
    if(self::$instance == null) {
      $cache = defined('OSC_CACHE') ? OSC_CACHE : 'default';
      $cache_class = 'Object_Cache_' . $cache;
      $file = __DIR__ . '/caches/' . $cache_class . '.php';

      if(file_exists($file)) {
        require_once $file;
        if(class_exists($cache_class) && call_user_func([$cache_class, 'is_supported'])) {
          self::$instance = new $cache_class();
        } else {
          require_once __DIR__ . '/caches/Object_Cache_default.php';
          self::$instance = new Object_Cache_default();
        }
        return self::$instance;
      }
      throw new RuntimeException('Unknown cache');
    }
    return self::$instance;
  }
}

Troubleshooting Cache Issues

Cache Not Working

• Ensure that the required caching extension (APC, Memcached, Redis) is installed and enabled on your server.
• Check that the correct cache type is defined in config.php.

Slow Performance

• Memcache and Redis typically provide better performance than file-based caching.
• Ensure that the caching service is properly configured and running.

By configuring and properly implementing cache in Osclass, you can significantly improve website performance and reduce database load.