devteampro/magento2-playground

Playground for devs to quickly run & test services and methods.

1.0.1 2025-06-02 17:39 UTC

This package is auto-updated.

Last update: 2025-06-02 17:40:35 UTC


README

Playground enables developers to quickly test any code in their system and access any of the services in the app.

Install via composer

composer require devteampro/magento2-playground

php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy

Usage

To enable the playground, just copy the playground.php.dist file from module's root dir to dev/tools directory of the project dev/tools/playground.php.

If this module is installed manually in app/code then the path would be app/code/DTP/Playground/playground.php.dist.
Or if the module is installed via composer then the path would be vendor/devteampro/magento2-playground/playground.php.dist.

Add playground.php to .gitignore file

/dev/tools/playground.php

This file needs to return a closure. Here's an example:

<?php

use Magento\Framework\App\ObjectManager;
use Magento\Framework\App\Filesystem\DirectoryList;

return function(ObjectManager $ob) {
    $dir = $ob->get(DirectoryList::class);
    dump($dir->getRoot());
};

Run playground

You should be able to run this with: bin/magento dtp:playground.

Use a different path for playground

You can specify a different folder path for playground.php file if, don't want to add in dev/tools directory. Just update the pgDir argument in di.xml file

<type name="DTP\Playground\UI\Console\PlaygroundCommand">
        <arguments>
            <argument name="pgDir" xsi:type="const">DTP\Playground\UI\Console\PlaygroundDirResolver::PG_DIR_PATH</argument>
        </arguments>
    </type>