wizaplace/twig-object-dump

Simple Twig extension improving templates debugging

v1.0.0 2017-02-24 13:47 UTC

Requires

• php: ^7.0
• symfony/framework-bundle: ^3.0
• symfony/twig-bundle: ^3.0
• symfony/var-dumper: ^3.0

Requires (Dev)

• m6web/coke: ~2.0
• wizaplace/php-coding-standard: ~1.0

MIT

• Wizaplace Tech Team

• debug
• twig
• dump
• object

README

Twig object dumper is a simple Twig extension improving templates debugging : it helps front-end developers to interact the right way with back-end objects.

Usage

With this code :

class Product
{
    private $stockQuantity;

    public function isInStock() : bool
    {
        return $this->stockQuantity > 0;
    }
}

Standard Twig dump function displays :

Product {#762 ▼
  -stockQuantity: 3
}

Which is not a good information : stockQuantity is private and not usable.

Whereas the new d function displays the right way to access object's properties :

WizaTech\Product
    isInStock() : bool

Installation

$ composer require wizaplace/twig-object-dump

Don't forget to load the new bundle in the app/AppKernel.php :

$bundles = [
    // ...
    new Wizaplace\TwigObjectDumpBundle\TwigObjectDumpBundle(),
];

This extension checks the twig environment and do nothing if it's set to debug.

Installation for dev

You can use Vagrant to setup a 'ready for dev' environment :

$ cp Vagrantfile.dist Vagrantfile
$ vagrant up
$ vagrant ssh

Load dependencies with Composer :

$ composer install

Coding Style

To ensure that you use the right coding standard, use coke :

$ vendor/bin/coke

Credits

Developed by Wizaplace.

License

This project is licensed under the MIT license.