CODEWITHSUNDEEP
phpphpstormslim
peregraum
peregraum

Reputation: 537

PHPStorm and Slim 3.X DIC

I recently moved from Slim 2.X to Slim 3.X and I've found a problem that may be a little stupid but annoys me in some ways.
The newly Slim 3.X, as a difference between the older 2.X version, it implements a new container system using Dependency Injection Containers (DIC) build on Pimple.

As I've been reading, I find this a very great enhancement because it lets you manage your PHP app in a lot of different ways.
When I started playing around with the new things it has, I found something confusing that maybe is something I'm missing.

I use PHPStorm; one of the things that I like about this IDE is its code-completion and the facility for writing code and understanding classes (I'm actually a student, so this helps me a lot).
When I write a Slim route, if I want to access, for example, to my view object stored inside the container, I have to refer to it with the $this->view variable. The thing is that, normally, PHPStorm lists me the methods and properties inside an object when I mention it, but that didn't happen with the $this object.

I suppose that, inside a route, Slim stores all route functionalities and all the container objects into the $this assigner.

$container = $app->getContainer();
$container['view'] = new \Slim\Views\PhpRenderer('protected/views/');

$app->get('/products', function(Request $request, Response $response) {
    $response = $this->view->render($response, 'products.php');
    return $response;
})->setName('products');

When I access my /products route, it successfully renders my products template and shows what it's expected to show, so no problems with that.
The matter with it is that I want PHPStorm to know that $this variable inside a route it stores all the containers that are set previously before the route is called.

I thought about /* @var */ and /* @global */ or something like this but after searching for a while and trying different things, I haven't found anything that could work.

In conclusion, what I'm trying to say is if it's possible that PHPStorm could list me the properties and methods of the container objects like this: PHPStorm auto-completion feature for objects

but with the $this object inside a route: Missing auto-completion feature in this object

Thanks!

Upvotes: 3

Views: 1087

Answers (2)

AmigaAbattoir
AmigaAbattoir

Reputation: 749

I was trying to find something like this for Eclipse, and someone suggested you modify the properties with PHPDOCS of Slim\App. Since I didn't want to change the Slim files themself, I tried to make an empty class that extends Slim\App, and use PHPDOCS to add propeties to that:

/**
 * OurApp
 *
 * Extends Slim\App with properties so we have code completion for a bunch of stuff!
 *
 * @property-read SomeClass $something
 * @property-read SomeotherClass $someOtherThing
 * @property-read string $someString
 * @property-read \Slim\Views\PhpRenderer $renderer
 */
class OurApp extends \Slim\App {}
$app = new OurApp($settings);

And that works nicely. This way you can start typing $app-> and get the completion for whatever is in the standard Slim\App and get something, someOtherThing and someString, etc. For our project we changed to a bunch of values in the $container items Dependency.php that we needed to access.

Upvotes: 1

Rob Allen
Rob Allen

Reputation: 12778

The easiest way to do this is to have separate Action classes rather than use closures. This also has the benefit of being easier to test.

Firstly create your action, inject its dependencies into its constructor and write an `__invoke`` method that will be called by Slim: 

class ProductsListAction {
    protected $view;

    public function __construct(\Slim\Views\PhpRenderer $view) {
        $this->view = $view;
    }

    public function __invoke($request, $response, $args) {
        $response = $this->view->render($response, 'products.php');
        return $response;
    }
}

For this to work, you now need a DIC factory for it:

$container['ProductsListAction'] = function ($c) {
    return new ProductsListAction($c['view']);
};

You can now register your new action as a route callable:

$app->get('/products', 'ProductListAction');

Now, PhpStorm will correctly autocomplete within your ProductsListAction class.

Upvotes: 5

Related Questions