Skip to content

Commit fa2b52c

Browse files
authored
[docs] Fix wording for attributes=>parameters. (#9265)
1 parent 5bf8140 commit fa2b52c

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

docs/en/reference/attributes-reference.rst

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,12 @@ inside the instance variables PHP DocBlock comment. Any value hold
5959
inside this variable will be saved to and loaded from the database
6060
as part of the lifecycle of the instance variables entity-class.
6161

62-
Required attributes:
62+
Required parameters:
6363

6464
- **type**: Name of the DBAL Type which does the conversion between PHP
6565
and Database representation.
6666

67-
Optional attributes:
67+
Optional parameters:
6868

6969
- **name**: By default the property name is used for the database
7070
column name also, however the ``name`` attribute allows you to
@@ -165,7 +165,7 @@ Examples:
165165
~~~~~~~~
166166
Add caching strategy to a root entity or a collection.
167167

168-
Optional attributes:
168+
Optional parameters:
169169

170170
- **usage**: One of ``READ_ONLY``, ``READ_WRITE`` or ``NONSTRICT_READ_WRITE``, By default this is ``READ_ONLY``.
171171
- **region**: An specific region name
@@ -210,7 +210,7 @@ Example:
210210

211211
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.
212212

213-
Required attributes:
213+
Required parameters:
214214

215215
- **class**: name of the class which should extend Doctrine\ORM\Id\AbstractIdGenerator
216216

@@ -244,13 +244,13 @@ actually instantiated as.
244244
If this attribute is not specified, the discriminator column defaults
245245
to a string column of length 255 called ``dtype``.
246246

247-
Required attributes:
247+
Required parameters:
248248

249249

250250
- **name**: The column name of the discriminator. This name is also
251251
used during Array hydration as key to specify the class-name.
252252

253-
Optional attributes:
253+
Optional parameters:
254254

255255

256256
- **type**: By default this is string.
@@ -319,7 +319,7 @@ attribute to establish the relationship between the two classes.
319319
The embedded attribute is required on an entity's member variable,
320320
in order to specify that it is an embedded class.
321321

322-
Required attributes:
322+
Required parameters:
323323

324324
- **class**: The embeddable class
325325

@@ -331,7 +331,7 @@ Required attributes:
331331
Required attribute to mark a PHP class as an entity. Doctrine manages
332332
the persistence of all classes marked as entities.
333333

334-
Optional attributes:
334+
Optional parameters:
335335

336336
- **repositoryClass**: Specifies the FQCN of a subclass of the
337337
``EntityRepository``. Use of repositories for entities is encouraged to keep
@@ -368,7 +368,7 @@ conjunction with #[Id].
368368
If this attribute is not specified with ``#[Id]`` the ``NONE`` strategy is
369369
used as default.
370370

371-
Optional attributes:
371+
Optional parameters:
372372

373373
- **strategy**: Set the name of the identifier generation strategy.
374374
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
424424
generate a database index on the specified table columns. It only
425425
has meaning in the ``SchemaTool`` schema generation context.
426426

427-
Required attributes:
427+
Required parameters:
428428

429429
- **name**: Name of the Index
430430
- **fields**: Array of fields. Exactly one of **fields, columns** is required.
431431
- **columns**: Array of columns. Exactly one of **fields, columns** is required.
432432

433433

434-
Optional attributes:
434+
Optional parameters:
435435

436436
- **options**: Array of platform specific options:
437437

@@ -548,7 +548,7 @@ The ``#[InverseJoinColumn]`` is the same as ``#[JoinColumn]`` and is used in the
548548
of a ``#[ManyToMany]`` attribute declaration to specifiy the details of the join table's
549549
column information used for the join to the inverse entity.
550550

551-
Optional attributes:
551+
Optional parameters:
552552

553553
- **name**: Column name that holds the foreign key identifier for
554554
this relation. In the context of ``#[JoinTable]`` it specifies the column
@@ -623,14 +623,14 @@ Example:
623623
Defines that the annotated instance variable holds a reference that
624624
describes a many-to-one relationship between two entities.
625625

626-
Required attributes:
626+
Required parameters:
627627

628628

629629
- **targetEntity**: FQCN of the referenced target entity. Can be the
630630
unqualified class name if both classes are in the same namespace.
631631
*IMPORTANT:* No leading backslash!
632632

633-
Optional attributes:
633+
Optional parameters:
634634

635635

636636
- **cascade**: Cascade Option
@@ -659,14 +659,14 @@ additional, optional attribute that has reasonable default
659659
configuration values using the table and names of the two related
660660
entities.
661661

662-
Required attributes:
662+
Required parameters:
663663

664664

665665
- **targetEntity**: FQCN of the referenced target entity. Can be the
666666
unqualified class name if both classes are in the same namespace.
667667
*IMPORTANT:* No leading backslash!
668668

669-
Optional attributes:
669+
Optional parameters:
670670

671671

672672
- **mappedBy**: This option specifies the property name on the
@@ -720,7 +720,7 @@ The ``#[MappedSuperclass]`` attribute cannot be used in conjunction with
720720
``#[Entity]``. See the Inheritance Mapping section for
721721
:doc:`more details on the restrictions of mapped superclasses <inheritance-mapping>`.
722722

723-
Optional attributes:
723+
Optional parameters:
724724

725725
- **repositoryClass**: Specifies the FQCN of a subclass of the EntityRepository.
726726
That will be inherited for all subclasses of that Mapped Superclass.
@@ -756,13 +756,13 @@ be specified. When no
756756
:ref:`#[JoinColumn] <attrref_joincolumn>` is specified it defaults to using the target entity table and
757757
primary key column names and the current naming strategy to determine a name for the join column.
758758

759-
Required attributes:
759+
Required parameters:
760760

761761
- **targetEntity**: FQCN of the referenced target entity. Can be the
762762
unqualified class name if both classes are in the same namespace.
763763
*IMPORTANT:* No leading backslash!
764764

765-
Optional attributes:
765+
Optional parameters:
766766

767767
- **cascade**: Cascade Option
768768
- **fetch**: One of LAZY or EAGER
@@ -786,13 +786,13 @@ Example:
786786
#[OneToMany]
787787
~~~~~~~~~~~~
788788

789-
Required attributes:
789+
Required parameters:
790790

791791
- **targetEntity**: FQCN of the referenced target entity. Can be the
792792
unqualified class name if both classes are in the same namespace.
793793
*IMPORTANT:* No leading backslash!
794794

795-
Optional attributes:
795+
Optional parameters:
796796

797797
- **cascade**: Cascade Option
798798
- **orphanRemoval**: Boolean that specifies if orphans, inverse
@@ -916,11 +916,11 @@ For use with ``#[GeneratedValue(strategy: "SEQUENCE")]`` this
916916
attribute allows to specify details about the sequence, such as
917917
the increment size and initial values of the sequence.
918918

919-
Required attributes:
919+
Required parameters:
920920

921921
- **sequenceName**: Name of the sequence
922922

923-
Optional attributes:
923+
Optional parameters:
924924

925925
- **allocationSize**: Increment the sequence by the allocation size
926926
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
954954
not specified the table name will default to the entity's
955955
unqualified classname.
956956

957-
Required attributes:
957+
Required parameters:
958958

959959
- **name**: Name of the table
960960

961-
Optional attributes:
961+
Optional parameters:
962962

963963
- **schema**: Name of the schema the table lies in.
964964

@@ -985,12 +985,12 @@ generate a database unique constraint on the specified table
985985
columns. It only has meaning in the SchemaTool schema generation
986986
context.
987987

988-
Required attributes:
988+
Required parameters:
989989

990990
- **name**: Name of the Index
991991
- **columns**: Array of columns.
992992

993-
Optional attributes:
993+
Optional parameters:
994994

995995
- **options**: Array of platform specific options:
996996

0 commit comments

Comments
 (0)