Git Product home page Git Product logo

phpbootsrap's Introduction

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.