sandfoxme/phpstorm-metadata-export

Export PhpStorm Advanced Metadata from DI containers

Metadata Exporter for PhpStorm

![Packagist] ![license] ![Code Climate] ![Gitlab pipeline status] ![Codecov], _(*1)

Export PhpStorm Advanced Metadata from DI containers to enable code completion., _(*2)

The library is inspired by Pimple Container Dumper for Silex, but it doesn't require IDE plugin because it uses native PhpStorm export format. It can integrate with any PSR-15 compliant framework and is extensible to support more DI containers and frameworks in the future., _(*3)

Installation

Install by composer, _(*4)

composer require arokettu/phpstorm-metadata-export --dev

Container Support

Supported containers:, _(*5)

• Pimple (v3)
• PHP-DI (v6, v7)
• Laminas ServiceManager (v3, v4; permanently unstable)

Integration middlewares for:, _(*6)

• PSR-15 (Mezzio, Slim 4, ...)
• Slim 3

Example

<?php

$container = new \DI\Container();
// .phpstorm.meta.php must be in a root path of your project
$storePath = __DIR__ '/.phpstorm.meta.php/sandfox_container_export.meta.php';

// just generate the file content
$metaPhp = \Arokettu\PhpStorm\Metadata\Generator::get([$container]);
file_put_contents($storePath, $metaPhp);

// use middleware (Slim 4 example)
$app = new \Slim\App();
$app->addMiddleware(new \Arokettu\PhpStorm\Metadata\Integration\ContainerExportMiddleware($container, [
    'filename' => $storePath,
]));

Documentation

Read full documentation at https://sandfox.dev/php/metadata-exporter-phpstorm.html, _(*7)

Also on Read the Docs: https://phpstorm-metadata-export.readthedocs.io/, _(*8)

Support

Please file issues on our main repo at GitLab: https://gitlab.com/sandfox/phpstorm-metadata-export/-/issues, _(*9)

Feel free to ask any questions in our room on Gitter: https://gitter.im/arokettu/community, _(*10)

License

The library is available as open source under the terms of the MIT License. See LICENSE.md., _(*11)