Review basic mapping

doctrine · Jul 3, 2024 · 4e5a6b2 · 4e5a6b2
1 parent 369abc5
commit 4e5a6b2
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 30 deletions.
diff --git a/docs/en/reference/annotations-reference.rst b/docs/en/reference/annotations-reference.rst
@@ -20,7 +20,7 @@ Change the metadata driver configuration to use the ``AttributeDriver``:
     - $config->setMetadataDriverImpl(AnnotationsDriver::create(__DIR__ . '/Documents'));
     + $config->setMetadataDriverImpl(AttributeDriver::create(__DIR__ . '/Documents'));
 
-Replace the `@ORM\Document` annotations with the `#[ORM\Document]` attribute.
+Replace the ``@ORM\Document`` annotations with the ``#[ORM\Document]`` attribute.
 
 .. code-block:: diff
 

diff --git a/docs/en/reference/basic-mapping.rst b/docs/en/reference/basic-mapping.rst
@@ -11,22 +11,18 @@ Mapping Drivers
 Doctrine provides several different ways for specifying object
 document mapping metadata:
 
--  Attributes
--  XML
+-  `Attributes <annotations-reference>`_
+-  `XML <xml-mapping>`_
 -  Raw PHP Code
 
 .. note::
 
-    If you're wondering which mapping driver gives the best
-    performance, the answer is: None. Once the metadata of a class has
-    been read from the source (attributes or xml) it is stored
-    in an instance of the
-    ``Doctrine\ODM\MongoDB\Mapping\ClassMetadata`` class and these
-    instances are stored in the metadata cache. Therefore at the end of
-    the day all drivers perform equally well. If you're not using a
-    metadata cache (not recommended!) then the XML driver might have a
-    slight edge in performance due to the powerful native XML support
-    in PHP.
+    If you're wondering which mapping driver gives the best performance, the
+    answer is: None. Once the metadata of a class has been read from the source
+    (Attributes or XML) it is stored in an instance of the
+    ``Doctrine\ODM\MongoDB\Mapping\ClassMetadata`` class and these instances are
+    stored in the metadata cache. Therefore all drivers perform equally well at
+    runtime.
 
 Introduction to Attributes
 --------------------------
@@ -61,6 +57,8 @@ to be designated as a document. This can be done through the
 
         namespace Documents;
 
+        use Doctrine\ODM\MongoDB\Mapping\Annotations\Document;
+
         #[Document]
         class User
         {
@@ -90,6 +88,8 @@ option as follows:
 
         namespace Documents;
 
+        use Doctrine\ODM\MongoDB\Mapping\Annotations\Document;
+
         #[Document(db: 'my_db', collection: 'users')]
         class User
         {
@@ -243,11 +243,14 @@ Here is an example:
 
         namespace Documents;
 
+        use Doctrine\ODM\MongoDB\Mapping\Annotations\Document;
+        use Doctrine\ODM\MongoDB\Mapping\Annotations\Id;
+
         #[Document]
         class User
         {
             #[Id]
-            private string $id;
+            public string $id;
         }
 
     .. code-block:: xml
@@ -280,16 +283,16 @@ Here is an example how to manually set a string identifier for your documents:
 
         <?php
 
+        namespace Documents;
+
+        use Doctrine\ODM\MongoDB\Mapping\Annotations\Document;
+        use Doctrine\ODM\MongoDB\Mapping\Annotations\Id;
+
         #[Document]
         class MyPersistentClass
         {
             #[Id(strategy: 'NONE', type: 'string')]
-            private string $id;
-
-            public function setId(string $id): void
-            {
-                $this->id = $id;
-            }
+            public string $id;
 
             //...
         }
@@ -406,13 +409,16 @@ Example:
 
         namespace Documents;
 
+        use Doctrine\ODM\MongoDB\Mapping\Annotations\Document;
+        use Doctrine\ODM\MongoDB\Mapping\Annotations\Field;
+
         #[Document]
         class User
         {
             // ...
 
             #[Field(type: 'string')]
-            private string $username;
+            public string $username;
         }
 
     .. code-block:: xml
@@ -445,7 +451,7 @@ as follows:
         class User
         {
             #[Field(name: 'db_name')]
-            private string $name;
+            public string $name;
         }
 
     .. code-block:: xml

diff --git a/docs/en/reference/xml-mapping.rst b/docs/en/reference/xml-mapping.rst
@@ -7,7 +7,7 @@ form of XML documents.
 The XML driver is backed by an XML Schema document that describes
 the structure of a mapping document. The most recent version of the
 XML Schema document is available online at
-`http://doctrine-project.org/schemas/odm/doctrine-mongo-mapping.xsd <http://doctrine-project.org/schemas/odm/doctrine-mongo-mapping.xsd>`_.
+`http://doctrine-project.org/schemas/odm/doctrine-mongo-mapping.xsd <https://www.doctrine-project.org/schemas/odm/doctrine-mongo-mapping.xsd>`_.
 The most convenient way to work with XML mapping files is to use an
 IDE/editor that can provide code-completion based on such an XML
 Schema document. The following is an outline of a XML mapping
@@ -25,13 +25,6 @@ trunk.
 
     </doctrine-mongo-mapping>
 
-.. note::
-
-    If you do not want to use latest XML Schema document please use link like
-    `http://doctrine-project.org/schemas/odm/doctrine-mongo-mapping-1.0.0-BETA12.xsd <http://doctrine-project.org/schemas/odm/doctrine-mongo-mapping-1.0.0-BETA12.xsd>`_.
-    You can change ``1.0.0-BETA12`` part of the URL to
-    `any other ODM version <https://github.com/doctrine/mongodb-odm/releases>`_.
-
 The XML mapping document of a class is loaded on-demand the first
 time it is requested and subsequently stored in the metadata cache.
 In order to work, this requires certain conventions: