AOEpeople / languagevisibility

Classes/CacheManager.php

<?php

namespace AOE\Languagevisibility;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2016 AOE GmbH <dev@aoe.com>
 *
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *
 *  This script is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/

/**
 * Class CacheManager
 * @package AOE\Languagevisibility
 */
class CacheManager {

	/**
	 * @var boolean
	 */
	protected static $useCache;

	/**
	 * @var boolean
	 */
	protected static $enableCache = TRUE;

	/**
	 * @var CacheManager
	 */
	protected static $instance;

	/**
	 * @var array
	 */
	protected static $confArray = array();

	/**
	 * @var array
	 */
	protected $cache = array();

	/**
	 * Class constructor
	 *
	 * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

	 */
	protected function __construct() {
		if (!isset(self::$useCache)) {
			self::$useCache = FALSE;

			if (empty(self::$confArray)) {
				self::$confArray = @unserialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf']['languagevisibility']);
			}

			if (is_array(self::$confArray) && self::$confArray['useCache']) {
				self::$useCache = (1 === (int)self::$confArray['useCache']);
			}
		}
	}

	/**
	 * Method to determine if preCaching should be used or not.
	 *
	 * @return boolean
	 */
	public static function isCacheEnabled() {
		return (self::$useCache && self::$enableCache);
	}

	/**
	 * Use this method to force the cache usage.
	 *
	 * @return void
	 */
	public static function enableCache() {
		self::$enableCache = TRUE;
	}

	/**
	 * Use this method to unforce the cache usage.
	 *
	 * @return void
	 */
	public static function disableCache() {
		self::$enableCache = FALSE;
	}

	/**
	 * Flushed all caches.
	 *
	 * @return void
	 */
	public function flushAllCaches() {
		$this->cache = array();
	}

	/**
	 * Returns the cache array for a given name space.
	 *
	 * @param $namespace
	 * @return array
	 */
	public function get($namespace) {
		if (array_key_exists($namespace, $this->cache) && self::isCacheEnabled()) {
			return $this->cache[$namespace];
		} else {
			return array();
		}
	}

	/**
	 * Method to write content into the cache.
	 *
	 * @param $namespace
	 * @param $content
	 * @return void
	 */
	public function set($namespace, $content) {
		$this->cache[$namespace] = $content;
	}

	/**
	 * Returns an instance of the cacheManager singleton.
	 *
	 * @return CacheManager
	 */
	public static function getInstance() {
		if (! self::$instance instanceof CacheManager) {
			self::$instance = new CacheManager();
		}

		return self::$instance;
	}

	/**
	 * Prevent from cloning
	 *
	 * @param void
	 * @return void
	 */
	public final function __clone() {
		trigger_error('Clone is not allowed for ' . get_class($this) . ' (Singleton)', E_USER_ERROR);
	}
}