zvps/phalconphp-debug-assets

Localised debug page assets for PhalconPHP.


License
BSD-3-Clause

Documentation

PhalconPHP Debug Assets

This repository allows developers to pull the debug page assets locally, especially useful for projects:

  • requiring a secure environment with no remote assets
  • local development with no internet connection (developing on the move/commuting)

Installation

Example composer file:

{
    "name": "vendor/example-project",
    "description": "Example Composer File.",
    "authors": [
        {
            "name": "example",
            "email": "email@example.com"
        }
    ],
    "minimum-stability": "dev",
    "config" : {
        "optimize-autoloader": true,
        "sort-packages": true
    },
    "require" : {
        "php" : ">=7.2",
        "ext-phalcon" : "^3.4",
        "fabfuel/prophiler": "~1.5",
        "phalcon/incubator": "3.4.x"
    },
    "require-dev": {
        "phalcon/devtools": "~3.4",
        "phalcon/ide-stubs": "*",
        "ralouphie/getallheaders": "2.0.5",
        "zvps/phalconphp-debug-assets": "4.x-dev"
    },
    "repositories": [
        {
            "type": "vcs",
            "url":  "git@github.com:zVPS/phalconphp-debug-assets.git"
        }
    ],
    "scripts": {
        "post-install-cmd": [
            "SlowProg\\CopyFile\\ScriptHandler::copy"
        ],
        "post-update-cmd": [
            "SlowProg\\CopyFile\\ScriptHandler::copy"
        ]
    },
    "extra": {
        "copy-file-dev": {
            "vendor/zvps/phalconphp-debug-assets/debug/": "public/debug/"
        }
    }
}

If your project has a different location for assets / webroot then change public/debug/ to the correct path relative to the project root.

Setup

It would be recommended to only load these files and setup the debug class for development environments. Our front controller looks a bit like this:

    $config = new ConfigIni(APP_DIR . '/config/app.ini');
    if (!$config instanceof ConfigIni) {
        throw new \Exception("Config file app.ini missing or unable to be loaded.");
    }

    /** start composer autoloader */
    require_once ( APP_DIR . $config->application->vendorDir . '/autoload.php' );

    ($config->application->debug) ? (new \Phalcon\Debug())->listen(true, true)->setUri('/debug/') : false;

Only setting up the /debug/ folder for environments set to show exceptions and debug pages.