lahaxearnaud/clockwork

Server-side component of Clockwork, a Chrome extension for PHP development

Clockwork

Clockwork is a Chrome extension for PHP development, extending Developer Tools with a new panel providing all kinds of information useful for debugging and profiling your PHP applications, including information about request, headers, get and post data, cookies, session data, database queries, routes, visualisation of application runtime and more., _(*1)

Not a Chrome user? Check out embeddable web app version of Clockwork, supporting many modern browsers along Chrome with out of the box support for Laravel and Slim. There are also a third-party Firebug extension and a CLI client app available., _(*2)

This repository contains server-side component of Clockwork that gathers all the data, stores them in JSON format and serves them for displaying in Chrome Developer Tools extension., _(*3)

Installation

This extension provides out of the box support for Laravel, Slim 2 and CodeIgniter 2.1 frameworks, you can add support for any other or custom framework via an extensible API., _(*4)

To install latest version simply add it to your composer.json:, _(*5)

"itsgoingd/clockwork": "~1.9"

Laravel

Once Clockwork is installed, you need to register Laravel service provider, in your app/config/app.php:, _(*6)

'providers' => array(
    ...
    'Clockwork\Support\Laravel\ClockworkServiceProvider'
)

When using Laravel 5, you need to add Clockwork middleware, in your app/Http/Kernel.php:, _(*7)

protected $middleware = [
    'Clockwork\Support\Laravel\ClockworkMiddleware',
    ...
]

By default, Clockwork will only be available in debug mode, you can change this and other settings in the configuration file. Use the following Artisan command to publish the configuration file into your config directory:, _(*8)

$ php artisan vendor:publish --provider='Clockwork\Support\Laravel\ClockworkServiceProvider'

For Laravel 4 you can do the same with this command:, _(*9)

$ php artisan config:publish itsgoingd/clockwork --path vendor/itsgoingd/clockwork/Clockwork/Support/Laravel/config/

Clockwork also comes with a facade, which provides an easy way to add records to the Clockwork log and events to the timeline. You can register the facade in your app/config/app.php:, _(*10)

'aliases' => array(
    ...
    'Clockwork' => 'Clockwork\Support\Laravel\Facade',
)

Now you can use the following commands:, _(*11)

Clockwork::startEvent('event_name', 'Event description.'); // event called 'Event description.' appears in Clockwork timeline tab

Clockwork::info('Message text.'); // 'Message text.' appears in Clockwork log tab
Log::info('Message text.'); // 'Message text.' appears in Clockwork log tab as well as application log file

Clockwork::info(array('hello' => 'world')); // logs json representation of the array
Clockwork::info(new Object()); // logs string representation of the objects if the object implements __toString magic method, logs json representation of output of toArray method if the object implements it, if neither is the case, logs json representation of the object cast to array

Clockwork::endEvent('event_name');

Lumen

Once Clockwork is installed, you need to register the Clockwork service provider, in your bootstrap/app.php:, _(*12)

$app->register(Clockwork\Support\Lumen\ClockworkServiceProvider::class);

You also need to add the Clockwork middleware, in the same file:, _(*13)

$app->middleware([
    ...
    Clockwork\Support\Lumen\ClockworkMiddleware::class
]);

By default, Clockwork will only be available in debug mode (APP_DEBUG set to true), you can change this and other settings via environment variables. Simply specify the setting as environment variable prefixed with CLOCKWORK_, eg. CLOCKWORK_ENABLE, full list of available settings., _(*14)

Clockwork also comes with a facade, which provides an easy way to add records to the Clockwork log and events to the timeline. The facade will be automatically registered when you enable facades for your Lumen app, in bootstrap/app.php:, _(*15)

$app->withFacades();

Now you can use the following commands:, _(*16)

Clockwork::startEvent('event_name', 'Event description.'); // event called 'Event description.' appears in Clockwork timeline tab

Clockwork::info('Message text.'); // 'Message text.' appears in Clockwork log tab
Log::info('Message text.'); // 'Message text.' appears in Clockwork log tab as well as application log file

Clockwork::info(array('hello' => 'world')); // logs json representation of the array
Clockwork::info(new Object()); // logs string representation of the objects if the object implements __toString magic method, logs json representation of output of toArray method if the object implements it, if neither is the case, logs json representation of the object cast to array

Clockwork::endEvent('event_name');

Slim 2

Once Clockwork is installed, you need to add Slim middleware to your app:, _(*17)

$app = new Slim(...);
$app->add(new Clockwork\Support\Slim\ClockworkMiddleware('/requests/storage/path'));

Clockwork is now available in Slim's DI container and can be used like this:, _(*18)

$app = Slim::getInstance();

$app->clockwork->startEvent('event_name', 'Event description.'); // event called 'Event description.' appears in Clockwork timeline tab

$app->clockwork->info('Message text.'); // 'Message text.' appears in Clockwork log tab
$app->log->info('Message text.'); // 'Message text.' appears in Clockwork log tab as well as application log file

$app->clockwork->endEvent('event_name');

CodeIgniter 2.1

Once Clockwork is installed, you need to copy the Clockwork controller from vendor/itsgoingd/clockwork/Clockwork/Support/CodeIgniter/Clockwork.php to your controllers directory and set up the following route:, _(*19)

$route['__clockwork/(.*)'] = 'clockwork/$1';

Finally, you need to set up the Clockwork hooks by adding following to your application/config/hooks.php file:, _(*20)

Clockwork\Support\CodeIgniter\Register::registerHooks($hook);

To use Clockwork within your controllers/models/etc. you will need to extend your CI_Controller class. (If you haven't done so already) Create a new file at application/core/MY_Controller.php., _(*21)

class MY_Controller extends CI_Controller
{
    public function __construct()
    {
        parent::__construct();
        $GLOBALS['EXT']->_call_hook('pre_controller_constructor');
     }
}

Now you can use the following commands in your CodeIgniter app:, _(*22)

$this->clockwork->startEvent('event_name', 'Event description.'); // event called 'Event description.' appears in Clockwork timeline tab

$this->clockwork->info('Message text.'); // 'Message text.' appears in Clockwork log tab

$this->clockwork->endEvent('event_name');

Other frameworks

There is a brief architecture overview available, that should provide some help when implementing support for new frameworks or custom applications., _(*23)

If you would like to see or are working on a support for yet unsupported framework feel free to open a new issue on github., _(*24)

Addons

• clockwork-cli - Command-line interface to Clockwork by ptrofimov
• guzzle-clockwork - Plugin for logging Guzzle requests to Clockwork by hannesvdvreken
• silverstripe-clockwork - Integration for SilverStripe CMS/framework by markguinn
• clockwork-firebug - Extension for Firebug (like for Chrome) by Pavel Sidorovich

Licence

Copyright (c) 2013 Miroslav Rigler, _(*25)

MIT License, _(*26)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:, _(*27)

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software., _(*28)

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE., _(*29)