You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en/reference/attributes-reference.rst
+27-27Lines changed: 27 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,12 +59,12 @@ inside the instance variables PHP DocBlock comment. Any value hold
59
59
inside this variable will be saved to and loaded from the database
60
60
as part of the lifecycle of the instance variables entity-class.
61
61
62
-
Required attributes:
62
+
Required parameters:
63
63
64
64
- **type**: Name of the DBAL Type which does the conversion between PHP
65
65
and Database representation.
66
66
67
-
Optional attributes:
67
+
Optional parameters:
68
68
69
69
- **name**: By default the property name is used for the database
70
70
column name also, however the ``name`` attribute allows you to
@@ -165,7 +165,7 @@ Examples:
165
165
~~~~~~~~
166
166
Add caching strategy to a root entity or a collection.
167
167
168
-
Optional attributes:
168
+
Optional parameters:
169
169
170
170
- **usage**: One of ``READ_ONLY``, ``READ_WRITE`` or ``NONSTRICT_READ_WRITE``, By default this is ``READ_ONLY``.
171
171
- **region**: An specific region name
@@ -210,7 +210,7 @@ Example:
210
210
211
211
This attribute allows you to specify a user-provided class to generate identifiers. This attribute only works when both :ref:`#[Id] <attrref_id>` and :ref:`#[GeneratedValue(strategy: "CUSTOM")] <attrref_generatedvalue>` are specified.
212
212
213
-
Required attributes:
213
+
Required parameters:
214
214
215
215
- **class**: name of the class which should extend Doctrine\ORM\Id\AbstractIdGenerator
216
216
@@ -244,13 +244,13 @@ actually instantiated as.
244
244
If this attribute is not specified, the discriminator column defaults
245
245
to a string column of length 255 called ``dtype``.
246
246
247
-
Required attributes:
247
+
Required parameters:
248
248
249
249
250
250
- **name**: The column name of the discriminator. This name is also
251
251
used during Array hydration as key to specify the class-name.
252
252
253
-
Optional attributes:
253
+
Optional parameters:
254
254
255
255
256
256
- **type**: By default this is string.
@@ -319,7 +319,7 @@ attribute to establish the relationship between the two classes.
319
319
The embedded attribute is required on an entity's member variable,
320
320
in order to specify that it is an embedded class.
321
321
322
-
Required attributes:
322
+
Required parameters:
323
323
324
324
- **class**: The embeddable class
325
325
@@ -331,7 +331,7 @@ Required attributes:
331
331
Required attribute to mark a PHP class as an entity. Doctrine manages
332
332
the persistence of all classes marked as entities.
333
333
334
-
Optional attributes:
334
+
Optional parameters:
335
335
336
336
- **repositoryClass**: Specifies the FQCN of a subclass of the
337
337
``EntityRepository``. Use of repositories for entities is encouraged to keep
@@ -368,7 +368,7 @@ conjunction with #[Id].
368
368
If this attribute is not specified with ``#[Id]`` the ``NONE`` strategy is
369
369
used as default.
370
370
371
-
Optional attributes:
371
+
Optional parameters:
372
372
373
373
- **strategy**: Set the name of the identifier generation strategy.
374
374
Valid values are ``AUTO``, ``SEQUENCE``, ``IDENTITY``, ``UUID``
@@ -424,14 +424,14 @@ Attribute is used on the entity-class level. It provides a hint to the SchemaToo
424
424
generate a database index on the specified table columns. It only
425
425
has meaning in the ``SchemaTool`` schema generation context.
426
426
427
-
Required attributes:
427
+
Required parameters:
428
428
429
429
- **name**: Name of the Index
430
430
- **fields**: Array of fields. Exactly one of **fields, columns** is required.
431
431
- **columns**: Array of columns. Exactly one of **fields, columns** is required.
432
432
433
433
434
-
Optional attributes:
434
+
Optional parameters:
435
435
436
436
- **options**: Array of platform specific options:
437
437
@@ -548,7 +548,7 @@ The ``#[InverseJoinColumn]`` is the same as ``#[JoinColumn]`` and is used in the
548
548
of a ``#[ManyToMany]`` attribute declaration to specifiy the details of the join table's
549
549
column information used for the join to the inverse entity.
550
550
551
-
Optional attributes:
551
+
Optional parameters:
552
552
553
553
- **name**: Column name that holds the foreign key identifier for
554
554
this relation. In the context of ``#[JoinTable]`` it specifies the column
@@ -623,14 +623,14 @@ Example:
623
623
Defines that the annotated instance variable holds a reference that
624
624
describes a many-to-one relationship between two entities.
625
625
626
-
Required attributes:
626
+
Required parameters:
627
627
628
628
629
629
- **targetEntity**: FQCN of the referenced target entity. Can be the
630
630
unqualified class name if both classes are in the same namespace.
631
631
*IMPORTANT:* No leading backslash!
632
632
633
-
Optional attributes:
633
+
Optional parameters:
634
634
635
635
636
636
- **cascade**: Cascade Option
@@ -659,14 +659,14 @@ additional, optional attribute that has reasonable default
659
659
configuration values using the table and names of the two related
660
660
entities.
661
661
662
-
Required attributes:
662
+
Required parameters:
663
663
664
664
665
665
- **targetEntity**: FQCN of the referenced target entity. Can be the
666
666
unqualified class name if both classes are in the same namespace.
667
667
*IMPORTANT:* No leading backslash!
668
668
669
-
Optional attributes:
669
+
Optional parameters:
670
670
671
671
672
672
- **mappedBy**: This option specifies the property name on the
@@ -720,7 +720,7 @@ The ``#[MappedSuperclass]`` attribute cannot be used in conjunction with
720
720
``#[Entity]``. See the Inheritance Mapping section for
721
721
:doc:`more details on the restrictions of mapped superclasses <inheritance-mapping>`.
722
722
723
-
Optional attributes:
723
+
Optional parameters:
724
724
725
725
- **repositoryClass**: Specifies the FQCN of a subclass of the EntityRepository.
726
726
That will be inherited for all subclasses of that Mapped Superclass.
@@ -756,13 +756,13 @@ be specified. When no
756
756
:ref:`#[JoinColumn] <attrref_joincolumn>` is specified it defaults to using the target entity table and
757
757
primary key column names and the current naming strategy to determine a name for the join column.
758
758
759
-
Required attributes:
759
+
Required parameters:
760
760
761
761
- **targetEntity**: FQCN of the referenced target entity. Can be the
762
762
unqualified class name if both classes are in the same namespace.
763
763
*IMPORTANT:* No leading backslash!
764
764
765
-
Optional attributes:
765
+
Optional parameters:
766
766
767
767
- **cascade**: Cascade Option
768
768
- **fetch**: One of LAZY or EAGER
@@ -786,13 +786,13 @@ Example:
786
786
#[OneToMany]
787
787
~~~~~~~~~~~~
788
788
789
-
Required attributes:
789
+
Required parameters:
790
790
791
791
- **targetEntity**: FQCN of the referenced target entity. Can be the
792
792
unqualified class name if both classes are in the same namespace.
793
793
*IMPORTANT:* No leading backslash!
794
794
795
-
Optional attributes:
795
+
Optional parameters:
796
796
797
797
- **cascade**: Cascade Option
798
798
- **orphanRemoval**: Boolean that specifies if orphans, inverse
@@ -916,11 +916,11 @@ For use with ``#[GeneratedValue(strategy: "SEQUENCE")]`` this
916
916
attribute allows to specify details about the sequence, such as
917
917
the increment size and initial values of the sequence.
918
918
919
-
Required attributes:
919
+
Required parameters:
920
920
921
921
- **sequenceName**: Name of the sequence
922
922
923
-
Optional attributes:
923
+
Optional parameters:
924
924
925
925
- **allocationSize**: Increment the sequence by the allocation size
926
926
when its fetched. A value larger than 1 allows optimization for
@@ -954,11 +954,11 @@ placed on the entity-class level and is optional. If it is
954
954
not specified the table name will default to the entity's
955
955
unqualified classname.
956
956
957
-
Required attributes:
957
+
Required parameters:
958
958
959
959
- **name**: Name of the table
960
960
961
-
Optional attributes:
961
+
Optional parameters:
962
962
963
963
- **schema**: Name of the schema the table lies in.
964
964
@@ -985,12 +985,12 @@ generate a database unique constraint on the specified table
985
985
columns. It only has meaning in the SchemaTool schema generation
986
986
context.
987
987
988
-
Required attributes:
988
+
Required parameters:
989
989
990
990
- **name**: Name of the Index
991
991
- **columns**: Array of columns.
992
992
993
-
Optional attributes:
993
+
Optional parameters:
994
994
995
995
- **options**: Array of platform specific options:
0 commit comments