hypercharge/php-middleware

Generalized middleware implementation for PHP.

dev-master 2014-01-27 18:10 UTC

Requires

• php: >=5.3

Requires (Dev)

• phpunit/phpunit: ~3.7.0

MIT

• Jan Mentzel

• php
• middleware

README

This is a generalized library for using middleware patterns within your PHP projects.

php-middleware is a PHP port of the ruby middleware library.

Only a subset of ruby middleware is implemented yet. Stay tuned to see more features ported.

To get started, the best place to look is the user guide.

Installation

This project is distributed as a composer package.

in your project root folder create a composer.json file

{
  "require": {
    "hypercharge/php-middleware": "dev-master"
  }
}

In a shell cd to your project root folder and run the command

$ php composer.phar install

A Basic Example

Below is a basic example of the library in use. If you don't understand what middleware is, please read the ruby middleware doc. This example is simply meant to give you a quick idea of what the library looks like.

<?php
// basic env instance class
class LogEnv {
	public $log = array();

	public function to_string() {
		return join($this->log, "\n");
	}
}

// Basic middleware that just logs the inbound and
// outbound steps to env
class Trace implements Middleware\Middleware {
	private $app;
	private $value;
	public function __construct($app, $value) {
		$this->app = $app;
		$this->value = $value;
	}
	public function call($env) {
		$env->log[] = '--> '.$this->value;
		$this->app->call($env);
		$env->log[] = '<-- '.$this->value;
	}
}

// the env object passed to each middleware call($env) method
$env = new LogEnv();

// build the actual middleware stack which runs a sequence
// of slightly different versions of our middleware
$stack = new Middleware\Builder();
$stack
	->uses('Trace', 'A')
	->uses('Trace', 'B')
	->uses('Trace', 'C');

// run it
$stack->call($env);

echo $env->to_string();

And the output:

--> A
--> B
--> C
<-- C
<-- B
<-- A

Run The Tests

$ ./vendor/bin/phpunit