puli/discovery
Publishes and discovers artifacts across Puli packages.
Maintainers
Requires
- php: ^5.3.9|^7.0
- ramsey/uuid: ^2.8
- webmozart/assert: ^1.0
- webmozart/expression: ^1.0
Requires (Dev)
- phpunit/phpunit: ^4.6
- puli/repository: ^1.0-beta9
- sebastian/version: ^1.0.1
- webmozart/json: ^1.2
- webmozart/key-value-store: ^1.0-beta7
Suggests
- puli/repository: to bind and discover Puli resources
- webmozart/json: to use the JSON discovery
- webmozart/key-value-store: to use the key-value store discovery
Provides
None
Conflicts
None
Replaces
None
MIT 3fcb42bbbf27e7baa6d978c93be966ee4c2f6085
- Bernhard Schussek <bschussek.woop@gmail.com>
This package is auto-updated.
Last update: 2026-06-08 03:30:56 UTC
README
π Build Status
π Build status
π Scrutinizer Code Quality
π Latest Stable Version
π Total Downloads
π Dependency Status
Latest release: 1.0.0-beta9
PHP >= 5.3.9
The Puli Discovery Component supports binding of Puli resources to binding
types. Binding types can be defined with the addBindingType() method of the
EditableDiscovery interface:
use Puli\Discovery\Api\Type\BindingType; use Puli\Discovery\Binding\Initializer\ResourceBindingInitializer; use Puli\Discovery\InMemoryDiscovery; $discovery = new InMemoryDiscovery(array( // $repo is a Puli\Repository\Api\ResourceRepository instance new ResourceBindingInitializer($repo), )); $discovery->addBindingType(new BindingType('doctrine/xml-mapping'));
Resource Bindings
Resources in the repository can then be bound to the defined type by passing a
ResourceBinding to addBinding():
use Puli\Discovery\Binding\ResourceBinding; $discovery->addBinding(new ResourceBinding('/app/config/doctrine/*.xml', 'doctrine/xml-mapping'));
With findBindings(), you can later retrieve all the bindings for the type:
foreach ($discovery->findBindings('doctrine/xml-mapping') as $binding) { foreach ($binding->getResources() as $resource) { // do something... } }
The following Discovery implementations are currently supported:
Read the Resource Discovery guide in the Puli documentation to learn more about resource discovery.
Class Bindings
You can also bind classes to binding types. By convention, the common interface of all bound classes is used as binding type:
$discovery->addBindingType(new BindingType(Plugin::class));
Classes can be bound by adding ClassBinding instances:
use Puli\Discovery\Binding\ClassBinding; $discovery->addBinding(new ClassBinding(MyPlugin::class, Plugin::class));
As before, use findBindings() to find all bindings for a binding type:
foreach ($discovery->findBindings(Plugin::class) as $binding) { $pluginClass = $binding->getClassName(); $plugin = new $pluginClass(); // do something... }
Authors
Installation
Follow the Installation guide guide to install Puli in your project.
Documentation
Read the Puli Documentation to learn more about Puli.
Contribute
Contributions to Puli are always welcome!
- Report any bugs or issues you find on the issue tracker.
- You can grab the source code at Puliβs Git repository.
Support
If you are having problems, send a mail to bschussek@gmail.com or shout out to @webmozart on Twitter.
License
All contents of this package are licensed under the MIT license.
