#Mouse Small framework for bootstrapping programs whether they are simple command line scripts or large web applications. It is designed to be lightweight, only load necessary modules as needed, and be simple to drop into existing code.

#Quick Start Mouse uses individual modules that can be instantiated onto the \mouse\hole singleton using an unique key. The first step is to get the singleton of the mouse hole on to a variable or part of the class. The instance() function takes two arrays as its parameters. Each array consists of a module object key to data pair.

/*
 * Example #1
*/
$mouse = \mouse\hole::instance(
	[
		'output'	=> 'mouse\output\output', //Module object access Key => module name(\mouse\folder\file)
		'request'	=> 'mouse\request\http',
	],
	[
		'output'	=> [
			'cli_only'	=> false
		]
	]
);
$wantsNewsletter = $mouse->request->getBoolean('newsletter', "POST"); //Defaults to "REQUEST" for request variables.  Use "POST" to look only at POST variables.
if ($wantsNewsletter) {
	$mouse->output->addOutput("Customer does want newsletter.");
} else {
	$mouse->output->addOutput("Customer does not want newsletter.");
}

The first array is a single depth array containing module object keys to their namespaced module names. Module names consist of the mouse namespace, the module folder name(s), and finally the module file name. The module file name and class name should match.

The second array is a variable depth array containing module object keys to the settings for those modules.

When a module is instantiated on the \mouse\hole singleton it is assigned on to the object using the module object key provided. In the above example the HTTP request class is instantiated with the request module key and can be accessed through $mouse->request. If two different HTTP request modules were required then two can be instantiated with different module keys. $mouse = \mouse\hole::instance( [ 'request' => 'mouse\request\http', 'other_request' => 'mouse\request\http' ] );

From this point forward anytime the mouse hole is required simple calling \mouse\hole::instance(), or any variable it is assigned to, with no parameters will pass back the existing singleton. Additionally, calling it with new modules and settings will load those additional modules and settings onto the singleton. However, if it is being mixed into an existing application it is recommend to use the loadModules() and loadSettings() function calls off the local reference to the \mouse\hole singleton. Both functions take the same array parameters, respectively, as the call to \mouse\hole::instance().

/*
 * Example #2
*/
class myAwesomeApp {
	/**
	 * Mouse Object
	 *
	 * @var		object
	 */
	private $mouse = null;

	/**
	 * Constructor
	 *
	 * @access	public
	 * @param	array	Mouse Modules
	 * @param	array	Module Settings
	 * @return	void
	 */
	public function __construct($modules = [], $settings = []) {
		//Automatically load any modules and settings that are passed in at run time.
		$this->mouse = \mouse\hole::instance($modules, settings);
	}

	/**
	 * Loads and Returns the Request object.
	 *
	 * @access	public
	 * @return	object
	 */
	public function setupRequest() {
		$this->mouse->loadModules(
			[
				'request'	=> 'mouse\request\http',
			]
		);
		return $this->mouse->request;
	}
}

$myAwesomeApp = new myAwesomeApp();
$request = $myAwesomeApp->setupRequest();