rmasters/stack-timer

Simple StackPHP middleware for timing

v1.0.0 2014-01-07 19:02 UTC

Requires

• symfony/http-foundation: 2.4.1
• symfony/http-kernel: 2.4.1

Requires (Dev)

• mockery/mockery: dev-master
• phpunit/phpunit: 3.*
• satooshi/php-coveralls: dev-master
• stack/builder: 1.0.*
• stack/run: 1.0.*

MIT

• Ross Masters

README

A simple StackPHP middleware that reports on the time it takes the inner middlewares/app to run. Written to figure out what Stack can do 😃

Usage

Simply wrap your application in the timer middleware and the load time will be injected into the response body.

$app = new App(); // implements HttpKernelInterface
$timer = new StackTimer($app);

$request = Request::createFromGlobals();
$timer->handle($request)->send();

Options

Pass an array with any of the following keys to StackTimer::__construct(HttpKernelInterface, array):

• inject (boolean, default: false) - whether to inject into the response body,
• callbacks (callable|callable[]) - an array of closures/callables that are passed the following arguments: function(HttpFoundation\Request $request, float $microseconds).
• format (string, default: {ms}ms) - the text to be injected, see list of replaced strings below.
• wrapper (string, default: <div style="...">%s</div>) - HTML the text is contained in, must contain a single %s where the text will be added.
• injection (string, default: </body>) - where to inject the snippet, this is passed through preg_quote and cannot contain regular expressions.
• inject_before (boolean, default: true) - whether to inject the snippet before the injection point (i.e. before </body>).