Elgg / Elgg

engine/classes/Elgg/Cache/SystemCache.php

<?php
namespace Elgg\Cache;

use Elgg\Profilable;
use Elgg\Config;
use ElggFileCache;

/**
 * System Cache
 *
 * @access private
 * @since  1.10.0
 */
class SystemCache {

	use Profilable;

	/**
	 * @var Config
	 */
	private $config;

	/**
	 * @var ElggFileCache
	 */
	private $cache;

	/**
	 * Constructor
	 *
	 * @param ElggFileCache $cache  Elgg disk cache
	 * @param Config        $config Elgg config
	 */
	public function __construct(ElggFileCache $cache, Config $config) {
		$this->cache = $cache;
		$this->config = $config;
	}

	/**
	 * Reset the system cache by deleting the caches
	 *
	 * @return void
	 */
	function reset() {

It is generally recommended to explicitly declare the visibility for methods.

		$this->cache->clear();
	}
	
	/**
	 * Saves a system cache.
	 *
	 * @param string $type The type or identifier of the cache
	 * @param string $data The data to be saved
	 * @return bool
	 */
	function save($type, $data) {

It is generally recommended to explicitly declare the visibility for methods.

		if ($this->isEnabled()) {
			return $this->cache->save($type, $data);
		}
	
		return false;
	}
	
	/**
	 * Retrieve the contents of a system cache.
	 *
	 * @param string $type The type of cache to load
	 * @return string
	 */
	function load($type) {

It is generally recommended to explicitly declare the visibility for methods.

		if ($this->isEnabled()) {
			$cached_data = $this->cache->load($type);
			if ($cached_data) {
				return $cached_data;
			}
		}
	
		return null;
	}
	
	/**
	 * Is system cache enabled
	 *
	 * @return bool
	 */
	function isEnabled() {
		return (bool) $this->config->system_cache_enabled;
	}
	
	/**
	 * Enables the system disk cache.
	 *
	 * Uses the 'system_cache_enabled' config with a boolean value.
	 * Resets the system cache.
	 *
	 * @return void
	 */
	function enable() {

It is generally recommended to explicitly declare the visibility for methods.

		$this->config->save('system_cache_enabled', 1);
		$this->reset();
	}
	
	/**
	 * Disables the system disk cache.
	 *
	 * Uses the 'system_cache_enabled' config with a boolean value.
	 * Resets the system cache.
	 *
	 * @return void
	 */
	function disable() {

It is generally recommended to explicitly declare the visibility for methods.

		$this->config->save('system_cache_enabled', 0);
		$this->reset();
	}
	
	/**
	 * Initializes the simplecache lastcache variable and creates system cache files
	 * when appropriate.
	 *
	 * @access private
	 */
	function init() {

It is generally recommended to explicitly declare the visibility for methods.

		if (!$this->isEnabled()) {
			return;
		}

		// cache system data if enabled and not loaded
		if (!$this->config->system_cache_loaded) {
			_elgg_services()->views->cacheConfiguration($this);
		}
	
		if (!_elgg_services()->translator->wasLoadedFromCache()) {
			_elgg_services()->translator->reloadAllTranslations();

			foreach (_elgg_services()->translator->getLoadedTranslations() as $lang => $map) {
				$this->save("$lang.lang", serialize($map));
			}
		}
	}
}