Elgg / Elgg

engine/classes/Elgg/Cache/SimpleCache.php

<?php
namespace Elgg\Cache;

use Elgg\Config;
use Elgg\ViewsService;


/**
 * WARNING: API IN FLUX. DO NOT USE DIRECTLY.
 *
 * @access private
 *
 * @since 1.10.0
 */
class SimpleCache {

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

	/**
	 * Constructor
	 *
	 * @param Config $config Elgg's global configuration
	 */
	public function __construct(Config $config) {
		$this->config = $config;
	}

	/**
	 * Registers a view to simple cache.
	 *
	 * Simple cache is a caching mechanism that saves the output of
	 * a view and its extensions into a file.
	 *
	 * @warning Simple cached views must take no parameters and return
	 * the same content no matter who is logged in.
	 *
	 * @param string $view_name View name
	 *
	 * @return void
	 * @see elgg_get_simplecache_url()
	 */
	function registerView($view_name) {

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

		$view_name = ViewsService::canonicalizeViewName($view_name);
		elgg_register_external_view($view_name, true);
	}

	/**
	 * Get the URL for the cached view.
	 *
	 * Recommended usage is to just pass the entire view name as the first and only arg:
	 *
	 * ```
	 * $blog_js = $simpleCache->getUrl('blog/save_draft.js');
	 * $favicon = $simpleCache->getUrl('graphics/favicon.ico');
	 * ```
	 *
	 * For backwards compatibility with older versions of Elgg, you can also pass
	 * "js" or "css" as the first arg, with the rest of the view name as the second arg:
	 *
	 * ```
	 * $blog_js = $simpleCache->getUrl('js', 'blog/save_draft.js');
	 * ```
	 *
	 * This automatically registers the view with Elgg's simplecache.
	 *
	 * @param string $view    The full view name
	 * @param string $subview If the first arg is "css" or "js", the rest of the view name
	 *
	 * @return string
	 */
	function getUrl($view, $subview = '') {

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

		// handle `getUrl('js', 'js/blog/save_draft')`
		if (($view === 'js' || $view === 'css') && 0 === strpos($subview, $view . '/')) {
			$view = $subview;
			$subview = '';
		}

		// handle `getUrl('js', 'blog/save_draft')`
		if (!empty($subview)) {
			$view = "$view/$subview";
		}

		$view = ViewsService::canonicalizeViewName($view);

		// should be normalized to canonical form by now: `getUrl('blog/save_draft.js')`
		$this->registerView($view);
		return $this->getRoot() . $view;
	}

	/**
	 * Get the base url for simple cache requests
	 *
	 * @return string The simplecache root url for the current viewtype.
	 * @access private
	 */
	function getRoot() {

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

		$viewtype = elgg_get_viewtype();
		if ($this->isEnabled()) {
			$lastcache = (int) $this->config->lastcache;
		} else {
			$lastcache = 0;
		}

		return elgg_normalize_url("/cache/$lastcache/$viewtype/");
	}

	/**
	 * Is simple cache enabled
	 *
	 * @return bool
	 */
	function isEnabled() {

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

		return (bool) $this->config->simplecache_enabled;
	}

	/**
	 * Enables the simple cache.
	 *
	 * @see elgg_register_simplecache_view()
	 * @return void
	 */
	function enable() {

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

		$this->config->save('simplecache_enabled', 1);
		$this->invalidate();
	}

	/**
	 * Disables the simple cache.
	 *
	 * @warning Simplecache is also purged when disabled.
	 *
	 * @see elgg_register_simplecache_view()
	 * @return void
	 */
	function disable() {

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

		if ($this->config->simplecache_enabled) {
			$this->config->save('simplecache_enabled', 0);

			$this->invalidate();
		}
	}

	/**
	 * Returns the path to where views are simplecached.
	 *
	 * @return string
	 */
	private function getPath() {
		$realpath = realpath($this->config->cacheroot);
		return rtrim($realpath, DIRECTORY_SEPARATOR) . "/views_simplecache";
	}

	/**
	 * Deletes all cached views in the simplecache and sets the lastcache and
	 * lastupdate time to 0 for every valid viewtype.
	 *
	 * @return bool
	 */
	function invalidate() {

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

		_elgg_rmdir($this->getPath(), true);

		$time = time();
		$this->config->save("simplecache_lastupdate", $time);
		$this->config->lastcache = $time;

		return true;
	}

	/**
	 * Set up config appropriately on engine boot.
	 *
	 * @return void
	 */
	function init() {

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

		$lastcache = $this->config->lastcache;
		if (!defined('UPGRADING') && empty($lastcache)) {
			$this->config->lastcache = (int) $this->config->simplecache_lastupdate;
		}
	}
}