Skip to content
A command line REPL bundle for Symfony using PsySH.
Branch: master
Clone or download
Pull request Compare This branch is 94 commits ahead of navitronic:master.

README.md

PsyshBundle

Package version Build Status Scrutinizer Code Quality License

A bundle to use the php REPL PsySH with Symfony. Learn more at psysh.org and check out the Interactive Debugging in PHP talk from OSCON on Presentate.

What does it do exactly?

  • Loads PsySH with the application dependencies
  • Gives access to the following variables:
Variable Description
$container Instance of Symfony ServiceContainer
$kernel Instance of Symfony Kernel
$parameters Instance of Symfony parameters

Aside from that it's the plain old PsySH! You can also customize it to add your own variables.

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:

composer require --dev theofidry/psysh-bundle

Then, enable the bundle by updating your app/AppKernel.php file to enable the bundle:

<?php
// app/AppKernel.php

public function registerBundles()
{
    //...

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

    return $bundles;
}

Usage

# Symfony > 3.0
php bin/console psysh

# Symfony < 3.0
php app/console psysh

# Symfony > 4.0
bin/console psysh

or

use function Fidry\PsyshBundle\psysh

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

PsySH Shell

Go further.

Customize PsySH

Adding a custom command

Adding a custom command for PsySH is as simple as defining a service with psysh.command tag!

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

Or even simpler if you use Symfony 3.3+:

services:
    _defaults:
        autonfigure: 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.

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").

# 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:

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

Default variables are:

  • $container (the service container)
  • $kernel
  • $parameters (all container parameters)
  • $self (the PsySH shell itself)

Credits

This bundle is developed by Théo FIDRY. This project has been made possible thanks to:

You can’t perform that action at this time.