OFFLINE-GmbH / oc-clockwork-plugin

Debugging and profiling plugin for October CMS
MIT License
5 stars 2 forks source link
debugging octobercms octobercms-plugin profiling

Clockwork Plugin for October CMS

This plugin integrates the awesome itsgoingd/clockwork with October CMS.

Clockwork is a browser extension, providing tools for debugging and profiling your October CMS applications. Clockwork captures and visualizes the following data:

Usage

After the plugin installation is complete add the laravel.dont-discover part to the extra section of your project's composer.json like this:

  "extra": {
    "merge-plugin": {
      "include": [
        "plugins/*/*/composer.json"
      ],
      "recurse": true,
      "replace": false,
      "merge-dev": false
    },
    "laravel": {
      "dont-discover": [
        "itsgoingd/clockwork"
      ]
    }
  }

Then download the browser extension to get insights into your October CMS installation:

All Clockwork features are adapted to work with October CMS. For more information on how to use the clock helper function refer to the official Website.

Configuration

By default, Clockwork will only be available in debug mode, you can change this and more settings in the configuration file.

The plugin provides file based configuration options where you can overwrite all the Clockwork settings. Refer to the October documentation on how to overwrite these settings.

Twig helper functions

There are a few twig helper functions available you can use to interact with Clockwork from your views:

See https://github.com/OFFLINE-GmbH/oc-clockwork-plugin/blob/master/Plugin.php#L43 for more details.