PHPackages tonybogdanov/magic-services-bundle - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Framework](/categories/framework) 4. / 5. tonybogdanov/magic-services-bundle ActiveSymfony-bundle[Framework](/categories/framework) tonybogdanov/magic-services-bundle ================================== Auto-magic service definition generator for Symfony 4.0+ / 5.0+ v1.18.2(5y ago)11.7kMITPHPCI failing Since Feb 22Pushed 5y ago1 watchersCompare [ Source](https://github.com/TonyBogdanov/magic-services-bundle)[ Packagist](https://packagist.org/packages/tonybogdanov/magic-services-bundle)[ RSS](/packages/tonybogdanov-magic-services-bundle/feed)WikiDiscussions master Synced today READMEChangelog (10)Dependencies (10)Versions (30)Used By (0) [![Latest Stable Version](https://camo.githubusercontent.com/b5d503c1ea725251ccf8daab6447465d79a830e33e8d98fa9cf4b4f05a62b6e6/68747470733a2f2f706f7365722e707567782e6f72672f746f6e79626f6764616e6f762f6d616769632d73657276696365732d62756e646c652f762f737461626c65)](https://packagist.org/packages/tonybogdanov/magic-services-bundle)[![License](https://camo.githubusercontent.com/6b77d823f88f16d8bbfb8d65b7fd41aee0b5f9b480a3817c4932c43615f0922e/68747470733a2f2f706f7365722e707567782e6f72672f746f6e79626f6764616e6f762f6d616769632d73657276696365732d62756e646c652f6c6963656e7365)](https://packagist.org/packages/tonybogdanov/magic-services-bundle) Installation ------------ [](#installation) ``` composer require tonybogdanov/magic-services-bundle ``` Configuration ------------- [](#configuration) Example: ``` magic_services: definitions: autowire: false autoconfigure: false path: '%kernel.project_dir%/config/magic_services.yaml' services: - '%kernel.project_dir%/src' aware: path: '%kernel.project_dir%/src/DependencyInjection/Aware' namespace: 'App\DependencyInjection\Aware' parameters: - regex: '/^kernel\.(.+)$/i' name: 'ParameterKernel$1' - regex: '/^app\.(.+)$/i' name: 'ParameterApp$1' tags: - regex: '/^twig\.(.+)$/i' name: 'TagKernel$1' - regex: '/^app\.(.+)$/i' name: 'TagApp$1' services: - type: 'Doctrine\Common\Annotations\Reader' service: '@Doctrine\Common\Annotations\Reader' name: 'AnnotationReader' - type: 'Psr\Log\LoggerInterface' service: '@logger' name: 'Logger' - 'Doctrine\ORM\EntityManager' ``` `definitions.autowire` Set this to `TRUE` to generate a `_defaults.autowire: true` entry in the generated service definitions. Defaults to: `FALSE`. `definitions.autoconfigure` Set this to `TRUE` to generate a `_defaults.autoconfigure: true` entry in the generated service definitions. Defaults to: `FALSE`. `definitions.path` Path to the configuration file where generated magic service definitions will be stored (must end with `.yml` or `.yaml`). Make sure to load the definitions file. Defaults to: `'%kernel.project_dir%/config/magic_services.yaml'`. --- `definitions.services` An array of folders to scan when looking up magic service classes. Defaults to: `[ '%kernel.project_dir%/src' ]` --- `aware.path` Path to the folder where *aware* interfaces and traits will be generated. It should be part of your package so that composer can autoload the files. Defaults to: `'%kernel.project_dir%/src/DependencyInjection/Aware'` --- `aware.namespace` The namespace under which all generated *aware* interfaces and traits will live. Example: The final class name of an *aware* interface with the name `FontManager` and configured namespace `App\DependencyInjection\Aware` will be `App\DependencyInjection\Aware\FontManager\FontManagerAwareInterface`. Defaults to: `'App\DependencyInjection\Aware'` --- `aware.parameters` An array of definitions for generating *aware* interfaces from container parameters. Each entry must be an array, or when automatic generation of optional settings is sufficient, you can also use a string (will be used as the `regex` sub-setting). Defaults to: `[]` --- `aware.parameters.*.regex` A regular expression for matching one or more parameters defined in the container, to generate *aware* interfaces for. Required, no default. --- `aware.parameters.*.name` An optional name for the generated *aware* interface. You can also use capturing groups from the regular expression to insert matched parts here. If this is omitted, a name will be automatically selected by prepending the name of the matched parameter with a `parameter` prefix. For example, for the `kernel.project_dir` parameter, the following name will be used: `ParameterKernelProject_Dir`. The **final** *aware* name will be normalized (see Normalization). --- `aware.tags` An array of definitions for generating *aware* interfaces from tagged services. Each entry must be an array, or when automatic generation of optional settings is sufficient, you can also use a string (will be used as the `regex` sub-setting). Defaults to: `[]` --- `aware.tags.*.regex` A regular expression for matching one or more tags defined in the container, to generate *aware* interfaces for. Required, no default. --- `aware.parameters.*.name` An optional name for the generated *aware* interface. You can also use capturing groups from the regular expression to insert matched parts here. If this is omitted, a name will be automatically selected by prepending the name of the matched parameter with a `parameter` prefix. For example, for the `kernel.project_dir` parameter, the following name will be used: `ParameterKernelProject_Dir`. The **final** *aware* name will be normalized (see Normalization). --- `aware.services` An array of definitions for generating *aware* interfaces from services. Each entry must be an array, or when automatic generation of optional settings is sufficient, you can also use a string (will be used as the `type` sub-setting). Defaults to: `[]` --- `aware.services.*.type` The type of the object an *aware* interface is being generated for. This should be a full class or interface name. Required, no default. --- `aware.services.*.service` An optional name of a service, of the configured type, to be used for dependency injection. If this is omitted, a service with the name of the configured type will be assumed. This is useful when using a magic service, or an interface. --- `aware.services.*.name` An optional name for the generated *aware* interface. The **final** *aware* name will be normalized (see Normalization). If this is omitted, a name will be automatically selected from the base name of the configured type after stripping an `Interface` suffix (if such is present). For example, for a configured type `Doctrine\Common\Annotations\Reader` the selected name will be `Reader`. Use this to specify more concrete names to avoid duplication. This name will be used when generating the final *aware* interface and trait, as well as the getters / setters. For example, for an `AnnotationReader` name & `Doctrine\Common\Annotations\Reader`type, the following *aware* interface & trait will be generated: ``` Configured\Aware\Namespace\AnnotationReader\AnnotationReaderAwareInterface; Configured\Aware\Namespace\AnnotationReader\AnnotationReaderAwareTrait; ``` and the following getters / setters: ``` getAnnotationReader(): \Doctrine\Common\Annotations\Reader; setAnnotationReader( \Doctrine\Common\Annotations\Reader $annotationReader ); ``` Commands -------- [](#commands) `services:aware:dump` Dumps a table of resources to have *aware* interfaces & traits generated for them, depending on the configured parameters in `magic_services.aware.parameters` and services in `magic_services.aware.services`. Use `--parameters` or `-p` to dump parameters. Use `--services` or `-s` to dump services. Use `-ps` to dump both. --- `services:aware:generate` Generates *aware* interfaces and traits for parameters & services as discovered & described in `services:aware:dump`. Use `--parameters` or `-p` to generate parameters. Use `--services` or `-s` to generate services. Use `-ps` to dump both. --- `services:definitions:dump` Dumps a table of detected magic services depending on the configured paths in `magic_services.definitions.services`. Use `--previews` or `-p` to preview the to be generated definitions. --- `services:definitions:generate` Generates service definitions for services as discovered & described in `services:definitions:dump`. Dumps the definitions in the path specified by `magic_services.definitions.path`. Annotations ----------- [](#annotations) `TonyBogdanov\MagicServices\Annotation\MagicService` Add this annotation to any class you want to have service definition generated for. If your class uses *aware* interfaces or implements `TonyBogdanov\MagicServices\Aware\ServiceAwareInterface`, you don't need to also add the annotation. The annotation, however, allows you to further customize the generated definition: --- `@MagicService(ignore=true)` This will mark the inspected class as ignored by the magic services definition generator. This could be useful when you need to write the definition yourself, but the class still implements the ServiceAwareInterface (or uses *aware* interfaces) and thus is considered for generation. --- `@MagicService(setters=false)` This will mark the service as not supporting magic setters and that it must have all of its dependencies injected as constructor arguments instead. --- `@MagicService(tags={"console.command","another_tag"}` This allows you to specify [tags](https://symfony.com/doc/current/service_container/tags.html) for the service. --- `@MagicService(public=true)` This will mark the generated service as [public](https://symfony.com/doc/current/service_container.html#public-versus-private-services). Normalization ------------- [](#normalization) When generating the final *aware* interface / trait name, a normalization process is performed on the input. When it is a class / interface name, only the base name is used. The sequence is split into words, where each word may only contain lowercase or uppercase latin letters, numbers and an underscore. Everything else is replaced with a single space. The first letters of all words are then capitalized and the spaces are removed, but underscores are kept. Example: - `kernel.project_dir` becomes `KernelProject_Dir` - `App\Service\FontManager` becomes `FontManager`. *Aware* interfaces / traits will use this name as both a folder and a class name, adding an additional `AwareInterface` and `AwareTrait` suffix respectively. Pseudo-Console -------------- [](#pseudo-console) Sometimes you might need to use the magic services generation capabilities outside of a Symfony application. An example of this would be during the development of a bundle, if you don't have a corresponding bootstrapped Symfony app. To ease the use of this tool, it comes with a built-in bootstrapped micro installation of Symfony, exposing only the magic services commands. To use it simply locate the `./bin/console` executable within this package and use it as you would use Symfony's console, specifying a path to a YAML file containing your magic services configuration. Example: ``` ./vendor/magic-services-bundle/bin/console /path/to/config/services.yaml services:aware:dump -ps ``` > ### NOTE > > [](#note) > > If you are using this method you have to keep in mind that any parameters or services you try to reference in the configuration file will be resolved in the context of the micro-kernel. > > For example, a `%kernel.project_dir%` parameter will resolve to the project directory of the magic services bundle and not the bundle / project invoking the console. > > To be able to unambiguously reference local paths, you can use the magic parameters (only available with this custom console) `%__file__%` and `%__dir__%` resolving to, respectively, the path to the configuration file and the folder of the configuration file, e.g. `/path/to/config/services.yaml` and `/path/to/config`. ### Health Score 32 — LowBetter than 71% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity17 Limited adoption so far Community9 Small or concentrated contributor base Maturity67 Established project with proven stability Bus Factor1 Top contributor holds 96.3% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~8 days Total 29 Last Release 2038d ago Major Versions v0.5 → v1.02020-02-27 PHP version history (2 changes)v0.1PHP ^7.3 v1.16PHP ^7.4 ### Community Maintainers ![](https://www.gravatar.com/avatar/d19fd78c717e55b5e5cd750fa075b3c776c27f39c9f7c7414c4666d4b87f929d?d=identicon)[TonyBogdanov](/maintainers/TonyBogdanov) --- Top Contributors [![TonyBogdanov](https://avatars.githubusercontent.com/u/3586948?v=4)](https://github.com/TonyBogdanov "TonyBogdanov (26 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (1 commits)") ### Embed Badge ![Health badge](/badges/tonybogdanov-magic-services-bundle/health.svg) ``` [![Health](https://phpackages.com/badges/tonybogdanov-magic-services-bundle/health.svg)](https://phpackages.com/packages/tonybogdanov-magic-services-bundle) ``` ### Alternatives [shopware/platform The Shopware e-commerce core 3.3k1.5M3](/packages/shopware-platform)[sulu/sulu Core framework that implements the functionality of the Sulu content management system 1.3k1.3M152](/packages/sulu-sulu)[prestashop/prestashop PrestaShop is an Open Source e-commerce platform, committed to providing the best shopping cart experience for both merchants and customers. 9.0k15.4k](/packages/prestashop-prestashop)[sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.4k5.6M647](/packages/sylius-sylius)[ec-cube/ec-cube EC-CUBE EC open platform. 78527.0k1](/packages/ec-cube-ec-cube)[drupal/core Drupal is an open source content management platform powering millions of websites and applications. 19462.3M1.3k](/packages/drupal-core) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)