Merge pull request #858 from doctrine/drop-annotations

remove obsolete annotation mapping

CHANGELOG.md

@@ -15,7 +15,7 @@ Changelog
 * DocumentManager::flush no longer saves the PHPCR session if there are no changes
   on the ODM layer.
 
-* Removed deprecated annotations for fields. Use `@Field(type="...")` instead.
+* Removed annotation mappings. Use attributes (or XML or YAML) instead.
 
 ### New Features
 

cli-config.doctrine_dbal.php.dist

@@ -37,10 +37,9 @@ if (isset($argv[1])
 
     /* prepare the doctrine configuration */
     $config = new \Doctrine\ODM\PHPCR\Configuration();
-    $driver = new \Doctrine\ODM\PHPCR\Mapping\Driver\AnnotationDriver(
-        new \Doctrine\Common\Annotations\AnnotationReader(),
+    $driver = new \Doctrine\ODM\PHPCR\Mapping\Driver\AttributeDriver([
         __DIR__ . '/lib/Doctrine/ODM/PHPCR/Document'
-    );
+    ]);
     $config->setMetadataDriverImpl($driver);
 
     $dm = \Doctrine\ODM\PHPCR\DocumentManager::create($session, $config);

cli-config.jackrabbit.php.dist

@@ -35,10 +35,9 @@ $session = $repository->login($credentials, $workspace);
 
 /* prepare the doctrine configuration */
 $config = new \Doctrine\ODM\PHPCR\Configuration();
-$driver = new \Doctrine\ODM\PHPCR\Mapping\Driver\AnnotationDriver(
-    new \Doctrine\Common\Annotations\AnnotationReader(),
+$driver = new \Doctrine\ODM\PHPCR\Mapping\Driver\AttributeDriver([
     __DIR__ . '/lib/Doctrine/ODM/PHPCR/Document'
-);
+]);
 $config->setMetadataDriverImpl($driver);
 
 $dm = \Doctrine\ODM\PHPCR\DocumentManager::create($session, $config);

composer.json

@@ -40,7 +40,7 @@
         "symfony/yaml": "^5.4 || ^6.0.19",
         "symfony/phpunit-bridge": "^5.4.21 || ^6.0.19",
         "liip/rmt": "^1.3",
-        "phpunit/phpunit": "^7.5 || ^8.0 || ^9.0"
+        "phpunit/phpunit": "^9.6.15"
     },
     "suggest": {
         "symfony/yaml": "^5.4 || ^6.0",

lib/Doctrine/ODM/PHPCR/Document/AbstractFile.php

@@ -3,8 +3,8 @@
 namespace Doctrine\ODM\PHPCR\Document;
 
 use Doctrine\ODM\PHPCR\HierarchyInterface;
-use PHPCR\NodeInterface;
 use Doctrine\ODM\PHPCR\Mapping\Attributes as PHPCR;
+use PHPCR\NodeInterface;
 
 /**
  * This class represents an abstract "file".

lib/Doctrine/ODM/PHPCR/Document/File.php

@@ -77,6 +77,8 @@ public function getContent(): Resource
      * Set the content for this file from the given resource or string.
      *
      * @param resource|string $content the content for the file
+     *
+     * @phpstan-param closed-resource|string $content
      */
     public function setFileContent($content): self
     {
@@ -99,6 +101,8 @@ public function setFileContent($content): self
      * Get a stream for the content of this file.
      *
      * @return resource the content for the file
+     *
+     * @phpstan-return closed-resource
      */
     public function getFileContentAsStream()
     {

lib/Doctrine/ODM/PHPCR/Document/Generic.php

@@ -11,8 +11,8 @@
 /**
  * This class represents an arbitrary node.
  *
- * It is used as a default document, for example with the ParentDocument annotation.
- * You can not use this to create nodes as it has no type annotation.
+ * It is used as a default document, for example with the ParentDocument mapping.
+ * You can not use this to create nodes as it has no type mapping.
  */
 #[PHPCR\Document]
 class Generic
@@ -30,7 +30,7 @@ class Generic
     protected string $nodename = '';
 
     #[PHPCR\ParentDocument]
-    protected object $parent;
+    protected ?object $parent;
 
     /**
      * @var Collection<object>
@@ -51,13 +51,14 @@ public function __construct()
     }
 
     /**
-     * Id (path) of this document
+     * Id (path) of this document.
      */
     public function getId(): string
     {
         if (!isset($this->id)) {
             throw new BadMethodCallException('Do not call getId on unsaved objects.');
         }
+
         return $this->id;
     }
 
@@ -95,6 +96,7 @@ public function getParentDocument(): object
         if (!isset($this->parent)) {
             throw new BadMethodCallException('Do not call getParentDocument on unsaved objects before setting the parent.');
         }
+
         return $this->parent;
     }
 

lib/Doctrine/ODM/PHPCR/Document/Resource.php

@@ -13,12 +13,10 @@
  */
 #[PHPCR\Document(nodeType: 'nt:resource')]
 class Resource
-{   #[PHPCR\Id]
+{
+    #[PHPCR\Id]
     protected string $id;
 
-    /**
-     * @var NodeInterface
-     */
     #[PHPCR\Node]
     protected NodeInterface $node;
 
@@ -30,6 +28,8 @@ class Resource
 
     /**
      * @var resource
+     *
+     * @phpstan-var closed-resource
      */
     #[PHPCR\Field(property: 'jcr:data', type: 'binary')]
     protected $data;
@@ -88,8 +88,10 @@ public function setParentDocument(object $parent): self
 
     /**
      * Set the data from a binary stream.
-
+     *
      * @param resource $data the contents of this resource
+     *
+     * @phpstan-param closed-resource $data the contents of this resource
      */
     public function setData($data): self
     {
@@ -102,6 +104,8 @@ public function setData($data): self
      * Get the binary data stream of this resource.
      *
      * @return resource
+     *
+     * @phpstan-return closed-resource
      */
     public function getData()
     {

lib/Doctrine/ODM/PHPCR/DocumentManager.php

@@ -107,7 +107,7 @@ public function hasLocaleChooserStrategy(): bool
     public function getLocaleChooserStrategy(): LocaleChooserInterface
     {
         if (!isset($this->localeChooserStrategy)) {
-            throw new InvalidArgumentException('You must configure a language chooser strategy when having documents with the translatable annotation');
+            throw new InvalidArgumentException('You must configure a language chooser strategy when having documents with the translatable mapping');
         }
 
         return $this->localeChooserStrategy;

lib/Doctrine/ODM/PHPCR/DocumentManagerInterface.php

@@ -153,7 +153,7 @@ public function findTranslation(?string $className, string $id, string $locale,
     /**
      * Quote a string for inclusion in an SQL2 query.
      *
-     * @see \PHPCR\PropertyType
+     * @see PropertyType
      */
     public function quote(string $val, int $type = PropertyType::STRING): string;