How to pass service to own bundle configuration - symfony

I'm developing a bundle and want to set up existed cache service (implements Doctrine\Common\Cache\CacheProvider) to my service. The existed service name will be set up in configuration of bundle:
services:
cache:
class: Doctrine\Common\Cache\FilesystemCache
arguments: ["%kernel.cache_dir%/cache"]
my_bundle:
cache_provider: cache
When I try get this service with $container->get($config['cache_provider']); in MyBundleExtension, I have this error:
The service definition "cache" does not exist.
and calling of $container->has($config['cache_provider']); returns false.
I injects #service_container to my service and gets cache in it - it works. But injecting of container is not good practice.
Do you have any ideas about it?

Related

Naming a service changes dependency injection behavior in Symfony

I have a factory service class which needs access to Symfony´s (v6.0.2) service_container and is specified in the services.yaml as follows:
App\Service\SomeService:
public: true
arguments: ['%some_arguments%']
calls:
- [ setContainer, [ '#service_container' ] ]
It works fine and I can access the service container and all the other injected arguments from within my service as desired.
However, if I change the service definition into a named service like this - without changing anything else:
app.some_service:
class: App\Service\SomeService
public: true
arguments: ['%some_arguments%']
calls:
- [ setContainer, [ '#service_container' ] ]
I still have access to the injected arguments ("%some_arguments%"), but the service container suddenly becomes null.
I would expect the behavior of the dependency injection to be the same - regardless of whether I use a named service or not.
Does the DI behavior change as soon as I give my service a name or do I need to take another approach if I want to give my service a name?

Custom normalizer not passed name converter service

I'm working on creating a custom (de)normalizer to handle entities. I have created the normalizer and allowed the service container to autowire/autoconfig. The service is selected correctly during deserialization, but I'm having trouble with the name converter. I want to use the MetadataAwareNameConverter service since I'm using the #SerializedName annotation in my entity. No matter what I do, it is always null in the custom normalizer. I have tried a number of methods of getting the name converter service:
Setting it explicitly in my class constructor
Setting it in the service definition (effectively getting rid of autowire/autoconfig)
Setting MetadataAwareNameConverter as the default in framework.yaml (I discovered it is the default already).
Copied an existing normalizer into my src and renamed it to see if it got the correct name converter (it still didn't work)
Built in normalizers are getting a name converter without issue, it is just my custom normalizer that is having this issue.
Is there anything else I should try? Am I missing a step in setting up my service? Any direction is appreciated.
UPDATE - when I dump the service container, the name converter service is missing from the arguments list
---------------- ----------------------------------------------------------
Option Value
---------------- ----------------------------------------------------------
Service ID App\Normalizer\QNormalizer
Class App\Normalizer\QNormalizer
Tags serializer.normalizer
Public no
Synthetic no
Lazy no
Shared yes
Abstract no
Autowired yes
Autoconfigured yes
Arguments Service(serializer.mapping.class_metadata_factory)
-----THIS IS WHERE THE NAME CONVERTER SHOULD BE----
Service(property_accessor)
Service(property_info)
Service(serializer.mapping.class_discriminator_resolver)
Manually injecting MetadataAwareNameConverter in services.yaml solved problem for me.
App\Serializer\CustomNormalizer:
arguments:
$nameConverter: '#serializer.name_converter.metadata_aware'
I faced same issue.
In my case it was a missconfiguration of services happened because of framework was configured to autoconfigure services (It's default framework configuration).
In result I had my custom normalizer duplicated in list of services.
First one is autoconfigured without priority
Second one is declared by me and having name converter injected:
Service Id
Priority
Class Name
App\Adapter\Symfony\Serializer\Normalizer\TranslationNormalizer
App\Adapter\ApiPlatform\Serializer\Normalizer\ItemNormalizer
api_platform.serializer.normalizer.item
-895
App\Adapter\ApiPlatform\Serializer\Normalizer\ItemNormalizer
Declaration:
api_platform.serializer.normalizer.item:
class: App\Adapter\ApiPlatform\Serializer\Normalizer\ItemNormalizer
arguments:
$nameConverter: '#serializer.name_converter.metadata_aware'
autoconfigure: false
tags:
- {name: serializer.normalizer, priority: -895}
Since autoconfigured normalizer have higher priority in list - it was picked by serializer so my SerializedName annotation wasn't working.
Solution is to disable autoconfiguration for first on service:
App\Adapter\ApiPlatform\Serializer\Normalizer\ItemNormalizer:
autoconfigure: false

How to exclude Domain from autowiring when declaring service with Symfony 4.1.3?

I'm working on a light DDD app with Symfony 4. In my services.yaml file, I configured the autowiring as such:
services:
# default configuration for services in *this* file
_defaults:
autowire: true # Automatically injects dependencies in your services.
autoconfigure: true # Automatically registers your services as commands, event subscribers, etc.
public: false # Allows optimizing the container by removing unused services; this also means
# fetching services directly from the container via $container->get() won't work.
# The best practice is to be explicit about your dependencies anyway.
# makes classes in src/ available to be used as services
# this creates a service per class whose id is the fully-qualified class name
App\:
resource: '../src/*'
exclude: '../src/{DataFixtures,Migrations,Tests,Domain/IceCream/IceCream.php,Domain/Cake/Cake.php,Domain/Candy/Candy.php}'
I excluded all the entities since they're not services. As you might have noticed, I listed all corresponding files because when I type :
exclude: '../src/{DataFixtures,Migrations,Tests,Domain}'
a runtime exception is raised: Cannot autowire service : "App\Application\Query\Cake\CakesQueryHandler": argument "$cakeRepository" of method "__construct()" references interface "App\Domain\Cake\CakeRepositoryInterface" but no such service exists. You should maybe alias this interface to the existing "App\Infrastructure\Doctrine\Repository\Cake\CakeRepository" service.
The first service, which is a queryhandler, is not autowired.
How can I exclude the whole Domain without having to type all files within it ?
Thank you for your help.
As you said to me directly, the runtime error you have is :
(1/1) RuntimeException
Cannot autowire service "App\Application\Query\Cake\CakesQueryHandler": argument "$cakeRepository" of method "__construct()" references interface "App\Domain\Cake\CakeRepositoryInterface" but no such service exists. You should maybe alias this interface to the existing "App\Infrastructure\Doctrine\Repository\Cake\CakeRepository" service.
In your query handler, you want to inject a service with is typed as App\Domain\Cake\CakeRepositoryInterface.
As a matter of fact, you have declared a service for your category repository with the name : App\Infrastructure\Doctrine\Repository\Cake\CakeRepository.
To fix this, you need to add an alias from your interface to your repository in your services.yaml file :
App\Domain\Cake\CakeRepositoryInterface: '#App\Infrastructure\Doctrine\Repository\Cake\CakeRepository'

symfony2 configure service with data from another service

Is it possible in Symfony2 to configure a service by injecting data from another service? For example, by calling a getter on another service?
In my specific case I am creating a (reusable) service that can handle translatable entity fields. For this I need a list of available locales in the application. I have looked at some other bundles that also work with locales, but they always use a static array from the configuration. For example:
a2lix_translation_form:
locales: [en, fr, nl]
This configuration usually ends up mapping to the service in the form of a constructor parameter or setter via the bundle configuration. For example:
class SomeService {
function __construct(array $locales) { ... }
// or
function setLocales(array $locales) { ... }
}
But in my case the list of available locales is not always static and often comes from the database. I have created a Locale service in my application with a method getLocales that returns an array. But how do I get that array into my service that needs it?
The service I am creating that needs a list of locales is split off into a separate reusable bundle. I don't want to inject the Locale service directly because that service is specific to the application, and not the bundle I am creating. I want users of my bundle to be able to provide a static list of locales, or point towards a service that has all the locales.
I would solve this problem using semantic configuration and config defintions. It works pretty similar to how FOSUserBundle asks for a driver and uses different settings depending on your choice (orm, mongodb, propel).
You could add something like this to your config.yml:
a2lix_locale:
provider: default # database
# ... additional settings which are optional,
# but required by provider, e.g. database settings
Your bundle's Configuration.php would verify that a valid provider was selected and that additional settings are set according to what each provider requires. Again, FOSUserBundle provides a great example for how to do this.
Additionally in your bundle's MyBundleExtension.php in /DependencyInjection you can access the service container and pass for instance the parameter locale to your default service in order for it to use the application's default locale provided in parameters.yml.

Pass Doctrine Entity Manager to a Service

I want to pass in the Doctrine Entity Manager so I can access my repositories etc. but I'm having some trouble.
My service is defined:
mlbp_beer.rest.controller:
class: MLBP\BeerBundle\Controller\RestController
arguments:
em: "#doctrine.orm.entity_manager"
This gives me an error:
ParameterNotFoundException: The service "mlbp_beer.rest.controller" has a dependency on a non-existent parameter "doctrine.orm.entity_manager".
Thanks for the help!
That looks right? Make sure rest is defined in your routing.yml like so.. Clear the cache too!
rest:
resource: mlbp_beer.rest.controller
type: rest

Resources