https://github.com/arokettu/phpstorm-metadata-export
Export PhpStorm Advanced Metadata from DI containers
https://github.com/arokettu/phpstorm-metadata-export
code-completion dependency-injection phpstorm pimple silex slim
Last synced: 3 months ago
JSON representation
Export PhpStorm Advanced Metadata from DI containers
- Host: GitHub
- URL: https://github.com/arokettu/phpstorm-metadata-export
- Owner: arokettu
- License: mit
- Created: 2018-02-20T23:46:32.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-06-27T00:29:46.000Z (4 months ago)
- Last Synced: 2025-07-20T10:41:31.097Z (3 months ago)
- Topics: code-completion, dependency-injection, phpstorm, pimple, silex, slim
- Language: PHP
- Size: 98.6 KB
- Stars: 12
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Metadata Exporter for PhpStorm
[![Packagist]][Packagist Link]
[![license]][MIT License]
[![Code Climate]][Code Climate Link]
[![Gitlab pipeline status]][pipelines]
[![Codecov]][codecov link]
[Packagist]: https://img.shields.io/packagist/v/arokettu/phpstorm-metadata-export.svg?style=flat-square
[license]: https://img.shields.io/github/license/arokettu/phpstorm-metadata-export.svg?style=flat-square
[Code Climate]: https://img.shields.io/codeclimate/maintainability/sandfoxme/phpstorm-metadata-export.svg?style=flat-square
[Gitlab pipeline status]: https://img.shields.io/gitlab/pipeline/sandfox/phpstorm-metadata-export/master.svg?style=flat-square
[Codecov]: https://img.shields.io/codecov/c/gl/sandfox/phpstorm-metadata-export?style=flat-square
[Packagist Link]: https://packagist.org/packages/arokettu/phpstorm-metadata-export
[pipelines]: https://gitlab.com/sandfox/phpstorm-metadata-export/-/pipelines
[codecov link]: https://codecov.io/gl/sandfox/phpstorm-metadata-export/
[Code Climate Link]: https://codeclimate.com/github/sandfoxme/phpstorm-metadata-export
Export [PhpStorm Advanced Metadata] from DI containers to enable code completion.
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.
[PhpStorm Advanced Metadata]: https://confluence.jetbrains.com/display/PhpStorm/PhpStorm+Advanced+Metadata
[Pimple Container Dumper]: https://github.com/Sorien/silex-pimple-dumper
## Installation
Install by composer
```sh
composer require arokettu/phpstorm-metadata-export --dev
```
## Container Support
Supported containers:
* [Pimple] (v3)
* [PHP-DI] (v6, v7)
* [Laminas ServiceManager] (v3, v4; permanently unstable)
Integration middlewares for:
* [PSR-15] (Mezzio, Slim 4, ...)
* [Slim 3]
[Pimple]: https://github.com/silexphp/Pimple
[PHP-DI]: http://php-di.org/
[Laminas ServiceManager]: https://docs.laminas.dev/laminas-servicemanager/
[Slim 3]: https://www.slimframework.com/
[PSR-15]: https://www.php-fig.org/psr/psr-15/
## Example
```php
addMiddleware(new \Arokettu\PhpStorm\Metadata\Integration\ContainerExportMiddleware($container, [
'filename' => $storePath,
]));
```
## Documentation
Read full documentation at
Also on Read the Docs:
## Support
Please file issues on our main repo at GitLab:
Feel free to ask any questions in our room on Gitter:
## License
The library is available as open source under the terms of the [MIT License].
See [LICENSE.md][MIT License].
[MIT License]: ./LICENSE.md