Services.php

<?php namespace App\Config;

use CodeIgniter\HTTP\{Response, URI};
use CodeIgniter\Router\RouteCollectionInterface;

/**
 * Services Configuration file.
 *
 * Services are simply other classes/libraries that the system uses
 * to do its job. This is used by CodeIgniter to allow the core of the
 * framework to be swapped out easily without affecting the usage within
 * the rest of your application.
 *
 * This is used in place of a Dependency Injection container primarily
 * due to its simplicity, which allows a better long-term maintenance
 * of the applications built on top of CodeIgniter. A bonus side-effect
 * is that IDEs are able to determine what class you are calling
 * whereas with DI Containers there usually isn't a way for them to do this.
 *
 * @see http://blog.ircmaxell.com/2015/11/simple-easy-risk-and-change.html
 * @see http://www.infoq.com/presentations/Simple-Made-Easy
 */
class Services
{
	/**
	 * Cache for instance of any services that
	 * have been requested as a "shared" instance.
	 *
	 * @var array
	 */
	static protected $instances = [];

	//--------------------------------------------------------------------

	/**
	 * The Autoloader class is the central class that handles our
	 * spl_autoload_register method, and helper methods.
	 */
	public static function autoloader($getShared = false)
	{
		if (! $getShared)
		{
			return new \CodeIgniter\Autoloader\Autoloader();
		}

		return self::getSharedInstance('autoloader');
	}

	//--------------------------------------------------------------------

	/**
	 * The CLI Request class provides for ways to interact with
	 * a command line request.
	 */
	public static function clirequest(AppConfig $config=null, $getShared = false)
	{
		if (! is_object($config))
		{
			$config = new AppConfig();
		}

		if (! $getShared)
		{
			return new \CodeIgniter\HTTP\CLIRequest(
					$config,
					new \CodeIgniter\HTTP\URI()
			);
		}

		return self::getSharedInstance('clirequest');
	}

	//--------------------------------------------------------------------

	/**
	 * The CURL Request class acts as a simple HTTP client for interacting
	 * with other servers, typically through APIs.
	 */
	public static function curlrequest(array $options = [], $response = null, AppConfig $config = null, $getShared = false)
	{
		if ($getShared === true)
		{
			return self::getSharedInstance('curlrequest', $options, $response);
		}

		if (! is_object($config))
		{
			$config = new AppConfig();
		}

		if ( ! is_object($response))
		{
			$response = new Response($config);
		}

		return new \CodeIgniter\HTTP\CURLRequest(
				$config,
				new URI(),
				$response,
				$options
		);
	}

	//--------------------------------------------------------------------

	/**
	 * The Exceptions class holds the methods that handle:
	 *
	 *  - set_exception_handler
	 *  - set_error_handler
	 *  - register_shutdown_function
	 */
	public static function exceptions($getShared = false)
	{
		if (! $getShared)
		{
			return new \CodeIgniter\Debug\Exceptions();
		}

		return self::getSharedInstance('exceptions');
	}

	//--------------------------------------------------------------------

	/**
	 * The Iterator class provides a simple way of looping over a function
	 * and timing the results and memory usage. Used when debugging and
	 * optimizing applications.
	 */
	public static function iterator($getShared = false)
	{
		if (! $getShared)
		{
			return new \CodeIgniter\Debug\Iterator();
		}

		return self::getSharedInstance('iterator');
	}

	//--------------------------------------------------------------------

	/**
	 * The loader provides utility methods for looking for non-classes
	 * within namespaced folders, as well as convenience methods for
	 * loading 'helpers', and 'libraries'.
	 */
	public static function loader($getShared = false)
	{
	    if (! $getShared)
	    {
		    return new \CodeIgniter\Loader(new \App\Config\AutoloadConfig());
	    }

		return self::getSharedInstance('loader');
	}

	//--------------------------------------------------------------------


	/**
	 * The Logger class is a PSR-3 compatible Logging class that supports
	 * multiple handlers that process the actual logging.
	 */
	public static function logger($getShared = false)
	{
		if (! $getShared)
		{
			return new \CodeIgniter\Log\Logger(new \App\Config\LoggerConfig());
		}

		return self::getSharedInstance('logger');
	}

	//--------------------------------------------------------------------

	/**
	 * The Renderer class is the class that actually displays a file to the user.
	 * The default View class within CodeIgniter is intentionally simple, but this
	 * service could easily be replaced by a template engine if the user needed to.
	 */
	public static function renderer($viewPath = APPPATH.'views/', $getShared = false)
	{
		if (! $getShared)
		{
			return new \CodeIgniter\View\View($viewPath, self::loader(true));
		}

		return self::getSharedInstance('renderer');
	}

	//--------------------------------------------------------------------

	/**
	 * The Request class models an HTTP request.
	 */
	public static function request(AppConfig $config = null, $getShared = false)
	{
		if (! is_object($config))
		{
			$config = new AppConfig();
		}

		if (! $getShared)
		{
			return new \CodeIgniter\HTTP\IncomingRequest(
					$config,
					new \CodeIgniter\HTTP\URI()
			);
		}

		return self::getSharedInstance('request');
	}

	//--------------------------------------------------------------------

	/**
	 * The Response class models an HTTP response.
	 */
	public static function response(AppConfig $config = null, $getShared = false)
	{
		if (! is_object($config))
		{
			$config = new AppConfig();
		}

		if (! $getShared)
		{
			return new \CodeIgniter\HTTP\Response($config);
		}

		return self::getSharedInstance('response');
	}

	//--------------------------------------------------------------------

	/**
	 * The Routes service is a class that allows for easily building
	 * a collection of routes.
	 */
	public static function routes($getShared = false)
	{
		if (! $getShared)
		{
			return new \CodeIgniter\Router\RouteCollection();
		}

		return self::getSharedInstance('routes');
	}

	//--------------------------------------------------------------------

	/**
	 * The Router class uses a RouteCollection's array of routes, and determines
	 * the correct Controller and Method to execute.
	 */
	public static function router(RouteCollectionInterface $routes = null, $getShared = false)
	{
		if ($getShared === true)
		{
			return self::getSharedInstance('router', $routes);
		}

		if (empty($routes))
		{
			$routes = self::routes();
		}

		return new \CodeIgniter\Router\Router($routes);
	}

	//--------------------------------------------------------------------

	/**
	 * The Security class provides a few handy tools for keeping the site
	 * secure, most notably the CSRF protection tools.
	 */
	public static function security(AppConfig $config = null, $getShared = false)
	{
		if (! is_object($config))
		{
			$config = new AppConfig();
		}

		if (! $getShared)
		{
			return new \CodeIgniter\Security\Security($config);
		}

		return self::getSharedInstance('security');
	}

	//--------------------------------------------------------------------

	/**
	 * @param AppConfig|null $config
	 * @param bool           $getShared
	 *
	 * @return \CodeIgniter\Session\Session
	 */
	public static function session(AppConfig $config = null, $getShared = false)
	{
		if (! is_object($config))
		{
			$config = new AppConfig();
		}

		if (! $getShared)
		{
			$driverName = $config->sessionDriver;
			$driver = new $driverName($config);
			$driver->setLogger(self::logger(true));

			$session = new \CodeIgniter\Session\Session($driver, $config);
			$session->setLogger(self::logger());
			$session->initialize();

			return $session;
		}

		return self::getSharedInstance('session');
	}

	//--------------------------------------------------------------------

	/**
	 * The Timer class provides a simple way to Benchmark portions of your
	 * application.
	 */
	public static function timer($getShared = false)
	{
		if (! $getShared)
		{
			return new \CodeIgniter\Debug\Timer();
		}

		return self::getSharedInstance('timer');
	}

	//--------------------------------------------------------------------

	public static function toolbar(AppConfig $config = null, $getShared = false)
	{
		if (! is_object($config))
		{
			$config = new AppConfig();
		}

		if (! $getShared)
		{
			return new \CodeIgniter\Debug\Toolbar($config);
		}

		return self::getSharedInstance('security');
	}

	//--------------------------------------------------------------------

	/**
	 * The URI class provides a way to model and manipulate URIs.
	 */
	public static function uri($uri = null, $getShared = false)
	{
		if (! $getShared)
		{
			return new \CodeIgniter\HTTP\URI($uri);
		}

		return self::getSharedInstance('uri', $uri);
	}

	//--------------------------------------------------------------------


	//--------------------------------------------------------------------
	// Utility Methods - DO NOT EDIT
	//--------------------------------------------------------------------

	/**
	 * Returns a shared instance of any of the class' services.
	 *
	 * $key must be a name matching a service.
	 *
	 * @param string $key
	 */
	protected static function getSharedInstance(string $key, ...$params)
	{
		if (! isset(static::$instances[$key]))
		{
			static::$instances[$key] = self::$key(...$params);
		}

		return static::$instances[$key];
	}

	//--------------------------------------------------------------------

	/**
	 * Provides the ability to perform case-insensitive calling of service
	 * names.
	 *
	 * @param string $name
	 * @param array  $arguments
	 */
	public static function __callStatic(string $name, array $arguments)
	{
		$name = strtolower($name);

		if (method_exists('App\Config\Services', $name))
		{
			return Services::$name(...$arguments);
		}
	}

	//--------------------------------------------------------------------


}