Merge pull request #5942 from Erikvv/patch-1
Add @CustomIdGenerator to documentation
This commit is contained in:
commit
184f7d3285
@ -37,6 +37,7 @@ Index
|
|||||||
- :ref:`@ColumnResult <annref_column_result>`
|
- :ref:`@ColumnResult <annref_column_result>`
|
||||||
- :ref:`@Cache <annref_cache>`
|
- :ref:`@Cache <annref_cache>`
|
||||||
- :ref:`@ChangeTrackingPolicy <annref_changetrackingpolicy>`
|
- :ref:`@ChangeTrackingPolicy <annref_changetrackingpolicy>`
|
||||||
|
- :ref:`@CustomIdGenerator <annref_customidgenerator>`
|
||||||
- :ref:`@DiscriminatorColumn <annref_discriminatorcolumn>`
|
- :ref:`@DiscriminatorColumn <annref_discriminatorcolumn>`
|
||||||
- :ref:`@DiscriminatorMap <annref_discriminatormap>`
|
- :ref:`@DiscriminatorMap <annref_discriminatormap>`
|
||||||
- :ref:`@Embeddable <annref_embeddable>`
|
- :ref:`@Embeddable <annref_embeddable>`
|
||||||
@ -233,6 +234,30 @@ Example:
|
|||||||
*/
|
*/
|
||||||
class User {}
|
class User {}
|
||||||
|
|
||||||
|
.. _annref_customidgenerator:
|
||||||
|
|
||||||
|
@CustomIdGenerator
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
|
This annotations allows you to specify a user-provided class to generate identifiers. This annotation only works when both :ref:`@Id <annref_id>` and :ref:`@GeneratedValue(strategy="CUSTOM") <annref_generatedvalue>` are specified.
|
||||||
|
|
||||||
|
Required attributes:
|
||||||
|
|
||||||
|
- **class**: name of the class which should extend Doctrine\ORM\Id\AbstractIdGenerator
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
.. code-block:: php
|
||||||
|
|
||||||
|
<?php
|
||||||
|
/**
|
||||||
|
* @Id
|
||||||
|
* @Column(type="integer")
|
||||||
|
* @GeneratedValue(strategy="CUSTOM")
|
||||||
|
* @CustomIdGenerator(class="My\Namespace\MyIdGenerator")
|
||||||
|
*/
|
||||||
|
public $id;
|
||||||
|
|
||||||
.. _annref_discriminatorcolumn:
|
.. _annref_discriminatorcolumn:
|
||||||
|
|
||||||
@DiscriminatorColumn
|
@DiscriminatorColumn
|
||||||
|
Loading…
x
Reference in New Issue
Block a user