GitHunt
JA

JamesSwift/PHPBootsrap

An abstract php class for use when writing a module, designed to take care of all the boring loading/saving of config files.

PHPBootstrap v0.1.4 Creative Commons License

PHPBootstrap is an abstract php class, intended to be used as a starting point when writing modules.
For example my SWDAPI and
ImageManager modules both rely on this class
to handle the following tasks:

  • Loading and parsing config files
  • Saving config files
  • "Signing" config files to allow sanitisation checks to be bypassed next time the file is loaded.
  • Other simple tasks like sanitising file paths

Examples

To use PHPBootstrap in your class:

class MyClass extends \JamesSwift\PHPBootstrap\PHPBootstrap {

//define your object variables for example:
//public $publicVar;
//private $_privateVar;

	//Define this method:
	public function loadDefaultConfig(){
		//When called this should reset the class to default
	}

	//You also need to define this method
	protected function _sanitizeConfig($config){
	//When MyClass::loadConfig() is called, it passes
	//the config array to this method which should check
	//it for errors, sanitize it and return it
	return $config;
	}

}

Just doing the above would then give you class lots of powerful tools, for example:

$MyClass = new MyClass("config.json");

$MyClass = new MyClass(array("publicVar"=>"something"));

$MyClass->loadConfig("extraConfig.json");

$MyClass->saveConfig("enewConfig.json");

$signed = $MyClass->getSignedConfig();

Get The Code

git clone git://github.com/JamesSwift/PHPBootstrap.git

License

JamesSwift\PHPBootstrap by
James Swift
is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.

Contributors

Other
Created March 21, 2014
Updated March 19, 2017