Add constructor parameters in CustomIdGenerator annotation #5015

New Issue

admin · 2026-01-22T14:56:36+01:00

admin commented

2026-01-22 14:56:36 +01:00

Originally created by @aledeg on GitHub (Feb 10, 2016).

It would be nice to be able to add parameters to the constructor to change the generator behavior. In my case, I would like to inject the length of the generated value.

In that case, we could use the following definition in the annotations:

@CustomIdGenerator(class="MyBundle\Doctrine\MyGenerator", arguments={"arg1","arg2"})

It will be working with the following class:

namespace MyBundle\Doctrine;

use Doctrine\ORM\Id\AbstractIdGenerator;
use Doctrine\ORM\EntityManager;

class MyGenerator extends AbstractIdGenerator
{
    public function __construct($arg1, $arg2)
    {
        // do something here
    }

    public function generate(EntityManager $em, $entity)
    {
        // do something here
    }

}

Originally created by @aledeg on GitHub (Feb 10, 2016). It would be nice to be able to add parameters to the constructor to change the generator behavior. In my case, I would like to inject the length of the generated value. In that case, we could use the following definition in the annotations: ``` @CustomIdGenerator(class="MyBundle\Doctrine\MyGenerator", arguments={"arg1","arg2"}) ``` It will be working with the following class: ``` php namespace MyBundle\Doctrine; use Doctrine\ORM\Id\AbstractIdGenerator; use Doctrine\ORM\EntityManager; class MyGenerator extends AbstractIdGenerator { public function __construct($arg1, $arg2) { // do something here } public function generate(EntityManager $em, $entity) { // do something here } } ```

admin added the Improvement label 2026-01-22 14:56:36 +01:00

admin commented

2026-01-22 14:56:36 +01:00

@Ocramius commented on GitHub (Feb 10, 2016):

Since it is a custom generator, why not make the arguments part of the constructor defaults? What is the advantage of pushing this config into the mapping? (you still don't get access to external services anyway)

@Ocramius commented on GitHub (Feb 10, 2016): Since it is a custom generator, why not make the arguments part of the constructor defaults? What is the advantage of pushing this config into the mapping? (you still don't get access to external services anyway)

admin commented

2026-01-22 14:56:37 +01:00

@aledeg commented on GitHub (Feb 10, 2016):

Sure, but how do I pass different arguments for different entities?
If I want to generate an unique string but with different length for different entities using the same generator, how do I do that?

@aledeg commented on GitHub (Feb 10, 2016): Sure, but how do I pass different arguments for different entities? If I want to generate an unique string but with different length for different entities using the same generator, how do I do that?

admin commented

2026-01-22 14:56:37 +01:00

@Ocramius commented on GitHub (Feb 10, 2016):

Sure, but how do I pass different arguments for different entities?

You don't, you simply code in a more specific way:

@CustomIdGenerator(class="MyBundle\Doctrine\CatGenerator")

@CustomIdGenerator(class="MyBundle\Doctrine\DogGenerator")

@Ocramius commented on GitHub (Feb 10, 2016): > Sure, but how do I pass different arguments for different entities? You don't, you simply code in a more specific way: ``` @CustomIdGenerator(class="MyBundle\Doctrine\CatGenerator") ``` ``` @CustomIdGenerator(class="MyBundle\Doctrine\DogGenerator") ```

admin commented

2026-01-22 14:56:38 +01:00

@Ocramius commented on GitHub (Feb 10, 2016):

The point is: unless defining a custom generator with proper constructor injection is possible, allowing just config injection will simply lead to a half-baked solution.

@Ocramius commented on GitHub (Feb 10, 2016): The point is: unless defining a custom generator with proper constructor injection is possible, allowing just config injection will simply lead to a half-baked solution.

admin commented

2026-01-22 14:56:38 +01:00

@aledeg commented on GitHub (Feb 10, 2016):

I see your point.

So I need to create an abstract class defining all my logic. And then I create classes with different implementations with different parameters.

@aledeg commented on GitHub (Feb 10, 2016): I see your point. So I need to create an abstract class defining all my logic. And then I create classes with different implementations with different parameters.

admin commented

2026-01-22 14:56:38 +01:00

@Ocramius commented on GitHub (Feb 10, 2016):

@aledeg that said, the issue could stay open if we have a way to inject ID generator instances

@Ocramius commented on GitHub (Feb 10, 2016): @aledeg that said, the issue could stay open if we have a way to inject ID generator _instances_

admin commented

2026-01-22 14:56:39 +01:00

@aledeg commented on GitHub (Feb 10, 2016):

I am looking forward to see that implemented :)

@aledeg commented on GitHub (Feb 10, 2016): I am looking forward to see that implemented :)

admin commented

2026-01-22 14:56:39 +01:00

@Craige commented on GitHub (May 4, 2017):

Any word on this? I think it would be very useful to be able to inject generator instances into the @CustomIdGenerator. The generator is pretty inflexible without that ability.

For example, if I want my generator to do something intensive and cache the result for future use, I would have to hard code in the cache directory rather than pass it in from the service container. What I would like to do is instantiate and pass configuration options to my custom Generator, and then pass that Generator instance to the @CustomIdGenerator

@Craige commented on GitHub (May 4, 2017): Any word on this? I think it would be very useful to be able to inject generator instances into the `@CustomIdGenerator`. The generator is pretty inflexible without that ability. For example, if I want my generator to do something intensive and cache the result for future use, I would have to hard code in the cache directory rather than pass it in from the service container. What I would like to do is instantiate and pass configuration options to my custom Generator, and then pass that Generator _instance_ to the `@CustomIdGenerator`

admin commented

2026-01-22 14:56:40 +01:00

@nicolas-grekas commented on GitHub (Jan 28, 2021):

This is implemented in v3 apparently.

@nicolas-grekas commented on GitHub (Jan 28, 2021): This is implemented in v3 apparently.

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: doctrine/archived-orm#5015