theofidry/psysh-bundle

A port of the PHP REPL PsySH for Symfony.

PsyshBundle

, _(*1)

A bundle to use the php REPL PsySH with [Symfony][2]. Learn more at psysh.org and check out the Interactive Debugging in PHP talk from OSCON on Presentate., _(*2)

What does it do exactly? * Loads PsySH with the application dependencies * Gives access to the following variables:, _(*3)

Aside from that it's the plain old PsySH! You can also customize it to add your own variables., _(*4)

Documentation

1. Install
2. Usage
   1. PsySH as a debugger
   2. Reflect like a boss
   3. PsySH for breakpoints
3. Customize PsySH
4. Credits

Install

You can use Composer to install the bundle to your project:, _(*5)

composer require --dev theofidry/psysh-bundle

Then, enable the bundle by updating your app/AppKernel.php file to enable the bundle:
(not needed on symfony 5, bundle is automaticaly registred in config/bundles.php), _(*6)

<?php
// app/AppKernel.php

public function registerBundles()
{
    //...

    if (in_array($this->getEnvironment(), ['dev', 'test'])) {
        //...
        $bundles[] = new Fidry\PsyshBundle\PsyshBundle();
    }

    return $bundles;
}

Usage

# Symfony > 4.0
bin/console psysh

or, _(*7)

use function psysh

class X
{
    function foo()
    {
        psysh(get_defined_vars(), $this);   // Debug with the current context
    }
}

, _(*8)

Go further., _(*9)

Customize PsySH

Adding a custom command

Adding a custom command for PsySH is as simple as defining a service with psysh.command tag!, _(*10)

services:
    my_psysh_command:
        class: Acme\Shell\MyCommand
        tags:
            - { name: psysh.command }

Or even simpler if you use Symfony 3.3+:, _(*11)

services:
    _defaults:
        autoconfigure: true
        autowire: true
        public: false

    Acme\Shell\MyCommand: ~

PsyshBundle provides autoconfiguration for custom Psysh command services, as long as they inherit from Psy\Command\ReflectingCommand or Psy\Command\Command., _(*12)

Adding custom variables

It is possible to add custom variables to the shell via configuration. Variables can be of any type, container parameters references (e.g. %kernel.debug%) or even services (prefixed with @, e.g. "@my_service")., _(*13)

# app/config/config_dev.yml

psysh:
    variables:
        foo: bar
        router: "@router"
        some: [thing, else]
        debug: "%kernel.debug%"

Now if you run php app/console psysh and then ls, you will see the variables $foo, $router, $some and $debug, in addition to already defined variables:, _(*14)

>>> ls
Variables: $foo, $router, $some, $debug...

Default variables are: - $container (the service container) - $kernel - $parameters (all container parameters) - $self (the PsySH shell itself), _(*15)

Credits

This bundle is developed by Théo FIDRY. This project has been made possible thanks to:, _(*16)

• Justin Hileman: author of PsySH and all the contributors of the PsySH project
• Adrian Palmer: gave the lead for porting PsySH on [Symfony][2]