Browse Source

* Add Laminas to readme and doc

* Add links to readme
tags/1.5.0
Anton Smirnov 1 month ago
parent
commit
b2dfec4348
2 changed files with 31 additions and 18 deletions
  1. +23
    -12
      README.md
  2. +8
    -6
      docs/main.rst

+ 23
- 12
README.md View File

@@ -4,12 +4,14 @@
[![license](https://img.shields.io/github/license/sandfoxme/phpstorm-metadata-export.svg)](https://opensource.org/licenses/MIT)
[![Code Climate](https://img.shields.io/codeclimate/maintainability/sandfoxme/phpstorm-metadata-export.svg)](https://codeclimate.com/github/sandfoxme/phpstorm-metadata-export)

Export [PhpStorm Advanced Metadata](https://confluence.jetbrains.com/display/PhpStorm/PhpStorm+Advanced+Metadata)
from DI containers to enable code completion.
Export [PhpStorm Advanced Metadata] from DI containers to enable code completion.

The library is inspired by [Pimple Container Dumper](https://github.com/Sorien/silex-pimple-dumper) for Silex but
doesn't require IDE plugin because it uses native PhpStorm export format. It also supports Slim and is extensible to
support more DI containers and frameworks in future.
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 also supports Slim and is extensible to support more DI containers and frameworks in future.

[PhpStorm Advanced Metadata]: https://confluence.jetbrains.com/display/PhpStorm/PhpStorm+Advanced+Metadata
[Pimple Container Dumper]: https://github.com/Sorien/silex-pimple-dumper

## Installation

@@ -23,15 +25,23 @@ composer require sandfoxme/phpstorm-metadata-export --dev

Supported containers:

* Pimple
* PHP-DI
* Zend ServiceManager (experimental)
* [Pimple]
* [PHP-DI]
* [Laminas ServiceManager] / [Zend ServiceManager] (experimental)

Integration middlewares for:

* Slim
* Silex
* Psr-15
* [Slim]
* [Silex]
* [PSR-15] (Zend Expressive, Mezzo, Slim 4, ...)

[Pimple]: https://pimple.symfony.com/
[PHP-DI]: http://php-di.org/
[Laminas ServiceManager]: https://docs.laminas.dev/laminas-servicemanager/
[Zend ServiceManager]: https://docs.zendframework.com/zend-servicemanager/
[Slim]: https://www.slimframework.com/
[Silex]: https://silex.symfony.com/
[PSR-15]: https://www.php-fig.org/psr/psr-15/

## Documentation

@@ -39,6 +49,7 @@ Read full documentation at <https://sandfox.dev/php/phpstorm-metadata-export.htm

## License

The library is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
The library is available as open source under the terms of the [MIT License].
See LICENSE.md

[MIT License]: https://opensource.org/licenses/MIT

+ 8
- 6
docs/main.rst View File

@@ -31,12 +31,14 @@ PHP-DI

The library has full support for the PHP-DI version 6.*

Zend ServiceManager
-------------------

The library has partial support for the Zend ServiceManager. Please note that there's no open and public way
of iterating over SM entries so the implementation is tied to the internal structure not covered by
the semantic version compatibility promise. Feel free to open an issue if it is broken for some scenario
Laminas (Zend) ServiceManager
-----------------------------

The library has partial support for the Laminas ServiceManager and Zend ServiceManager.
Please note that there's no open and public way of iterating over SM entries
so the implementation is tied to the internal structure
not covered by the semantic version compatibility promise.
Feel free to open an issue if it is broken for some scenario.

Obviously the implementation also cannot create hints for abstract factories


Loading…
Cancel
Save