jchook/house

House PHP — A minimal MVC Application Toolset

dev-master 2016-10-20 23:50 UTC

Requires

• php: >=5.4.0
• mthaml/mthaml: ~1.7

MIT

• Wes Roberts

README

A super-minimal pure PHP MVC toolkit.

Controller

The controller layer is the interface for your application. Use it to define a Route, accept a Request, and return a Response.

Hello World

We'll start with a Hello world route in app.php.

$app = new House\Router;
$app->get('/', function($req, $resp){
	return 'Hello World';			
});

Advanced route matching

The router is powerful in its simplicity.

• Exact string match
• Regular expressions
• Simplified expressions
• Arbitrary callbacks
• An array of the above

Try this simplified expression route that says hello to an arbitrary name.

$app->get('/hello/:name', function($req){
	return 'Hello ' . $req->param('name');
});

You can even nest routes based on criteria:

$app->group('/user', function($app){
	$app->put(function(){
		// Create user
	})
	->get('/:id', function(){
		// Retrieve user
	})
	->post('/:id', function(){
		// Update user
	})
	->delete('/:id', function(){
		// Delete user
	});
});

You can attach middleware to routes with before() and after().

$app->before('*', function($req, $resp){
	House\Log::info('Request: ' . $req);
	$resp->code(200);
});

You can optionally catch errors per route as well.

$app->error('*', function($req, $resp){
	House\Log::error($req->exception->getMessage());
	return 500;
});

Notice that controller return values are passed to $response->write().

• Strings write to the repsonse body
• Integers set the response code
• Arrays for Rack-style response

See example.php for more examples of exactly how badass Router is.

Model

The model layer is very basic. There is no ORM. If you need a more robust model layer, please see Symfony or php-activerecord. Otherwise, check this:

class User extends House\Model {}

// throws House\NotFound
User::find(['id' => 1]);

// returns array() 
$users = User::where(['status' => ['active', 'inactive']])->limit(5)->all();

Supported databases

• MySQL
• More to come..

View

The view layer is almost vanishingly small. It's so simple, it doesn't even need to exist. Returning a string from a controller method automatically calls $response->write($string).

So, view helpers are any method that return a string. We've bundled a few to get you started, but House could potentially support any template engine, flat file, etc. Since House is not a framework, there is no special View registry or folder, so you can easily install alternative template engines with composer and use them as-is.

Quickly configure your app to use Haml for example:

House\Haml::config([
	'cache' => sys_get_temp_dir() . '/haml',
	'views' => __DIR__ . '/views',
]);

function haml($view, $vars = array(), $config = array()) {
	return new House\Haml($view, $vars, $config);
}

Then implement it in your application with ease:

$app->get('/', function($req){
	return haml('index', $req->params());
});