concrete5cojp/concrete5_debugbar

A package to integrate PHP Debug Bar with concrete5 CMS.

concrete5 DebugBar

A package to integrate PHP Debug Bar with concrete5 CMS., _(*1)

Installation

Install the debug bar to the site that managed using composer

If you are managing your concrete5 site using concrete5/composer, you can manage this package with composer too., _(*2)

1. Modify your composer.json file

Add these packages to "require" section:, _(*3)

"concrete5cojp/concrete5_debugbar": "~0.2",
"slowprog/composer-copy-file": "~0.2"

Add these lines to "extra" section:, _(*4)

"copy-file": {
  "vendor/maximebf/debugbar/src/DebugBar/Resources/": "public/packages/concrete5_debugbar/vendor/maximebf/debugbar/src/DebugBar/Resources/"
}

Add "scripts" section:, _(*5)

"scripts": {
  "post-install-cmd": [
    "SlowProg\\CopyFile\\ScriptHandler::copy"
  ],
  "post-update-cmd": [
    "SlowProg\\CopyFile\\ScriptHandler::copy"
  ]
}

When you are managing your concrete5 site using composer, the vendor directory is outside from the document root. However, the debugbar package has some css/js/images in the vendor directory, so you have to move these static files. That's why we need to add the composer-copy-file package and the scripts section. You are also able to move Resources directory manually., _(*6)

Entire composer.json example:, _(*7)

{
  "name": "concrete5/composer",
  "description": "A fully featured skeleton for a composer managed concrete5 site",
  "type": "project",
  "license": "MIT",
  "prefer-stable": true,
  "autoload": {
    "psr-4": {
      "ConcreteComposer\\" : "./src"
    }
  },
  "require": {
    "composer/installers": "^1.3",
    "concrete5/core": "^8.3",
    "vlucas/phpdotenv": "^2.4",
    "concrete5cojp/concrete5_debugbar": "dev-master",
    "slowprog/composer-copy-file": "~0.2"
  },
  "config": {
    "preferred-install": "dist"
  },
  "extra": {
    "branch-alias": {
      "dev-8.x": "8.x-dev"
    },
    "installer-paths": {
      "public/concrete": ["type:concrete5-core"],
      "public/application/themes/{$name}": ["type:concrete5-theme"],
      "public/packages/{$name}": ["type:concrete5-package"],
      "public/application/blocks/{$name}": ["type:concrete5-block"]
    },
    "copy-file": {
      "vendor/maximebf/debugbar/src/DebugBar/Resources/": "public/packages/concrete5_debugbar/vendor/maximebf/debugbar/src/DebugBar/Resources/"
    }
  },
  "scripts": {
    "post-install-cmd": [
      "SlowProg\\CopyFile\\ScriptHandler::copy"
    ],
    "post-update-cmd": [
      "SlowProg\\CopyFile\\ScriptHandler::copy"
    ]
  }
}

2. Download the package

$ composer update

3. Install the package

$ ./public/concrete/bin/concrete5 c5:package-install concrete5_debugbar

Install the debug bar to the site that managed without using composer

First, download package files, _(*8)

$ cd ./packages
$ git clone git@github.com:concrete5cojp/concrete5_debugbar.git
$ cd concrete5_debugbar

Then update composer.json as, _(*9)

{
    "name": "concrete5cojp/concrete5_debugbar",
    "description": "A package to integrate PHP Debug Bar with concrete5 CMS.",
    "type": "concrete5-package",
    "license": "MIT",
    "minimum-stability": "stable",
    "require": {
        "maximebf/debugbar": ">=1.0.0"
    },
    "replace": {
        "psr/log": "*",
        "symfony/polyfill-mbstring": "*"
    },
    "autoload": {
        "psr-4": {
            "Concrete5Debugbar\\": "src/Concrete5Debugbar/"
        }
    }
}

Finally you can install the package, _(*10)

$ composer install
$ cd ../../
$ ./concrete/bin/concrete5 c5:package-install concrete5_debugbar

Usage

Messages

You can add messages to this tab using compatible usage with PSR-3 logger., _(*11)

\Core::make('debugbar/messages')->info('hello world');
\Core::make('debugbar/messages')->info($object);

, _(*12)

Timeline

Provides a way to log total execution time as well as taking "measures" (ie. measure the execution time of a particular operation)., _(*13)

\Core::make('debugbar/time')->startMeasure('longop', 'My long operation');
sleep(2);
\Core::make('debugbar/time')->stopMeasure('longop');

, _(*14)

Request

You can check how concrete5 retreive request data in this tab., _(*15)

, _(*16)

Database

You can check all sql queries on current request in this tab., _(*17)

, _(*18)

Logs

You can check application logs (same as dashboard/reports/logs but you can quick access!)., _(*19)

, _(*20)

Environment

Get some information about the server environment., _(*21)

, _(*22)