ClassMetadata mapping for timeseries

Ticket doctrine#2533

lib/Doctrine/ODM/MongoDB/Mapping/ClassMetadata.php

@@ -420,6 +420,34 @@
      */
     public $collectionMax;
 
+        /**
+     * READ-ONLY: If the collection is fixed size, its size in bytes.
+     *
+     * @var int|null
+     */
+    public $collectionSize;
+
+    /**
+     * READ-ONLY: If the collection is fixed size, the maximum number of elements to store in the collection.
+     *
+     * @var int|null
+     */
+    public $collectionMax;
+
+    /**
+     * READ-ONLY: If the collection should be a timeseries
+     *
+     * @var array{timeField:string,metaField?:string,granularity?:string}|null
+     */
+    public $collectionTimeseries;
+
+    /**
+     * READ-ONLY: If the collection is timeseries, sets automatic removal for the collection.
+     *
+     * @var int|null
+     */
+    public $collectionExpireAfterSeconds;
+
     /**
      * READ-ONLY Describes how MongoDB clients route read operations to the members of a replica set.
      *
@@ -653,6 +681,13 @@
      */
     public $isMappedSuperclass = false;
 
+     /**
+     * READ-ONLY: Whether this class describes the mapping of Timeseries.
+     *
+     * @var bool
+     */
+    public $isTimeSeriesDocument = false;
+
     /**
      * READ-ONLY: Whether this class describes the mapping of a embedded document.
      *
@@ -1387,7 +1422,7 @@ public function getCollection(): string
      * Sets the collection this Document is mapped to.
      *
      * @param array|string $name
-     * @psalm-param array{name: string, capped?: bool, size?: int, max?: int}|string $name
+     * @psalm-param array{name: string, capped?: bool, size?: int, max?: int}|array{name: string, timeseries?: array{timeField:string,metaField?:string,granularity?:string}, expireAfterSeconds?: int}|string $name
      *
      * @throws InvalidArgumentException
      */
@@ -1398,10 +1433,19 @@ public function setCollection($name): void
                 throw new InvalidArgumentException('A name key is required when passing an array to setCollection()');
             }
 
-            $this->collectionCapped = $name['capped'] ?? false;
-            $this->collectionSize   = $name['size'] ?? 0;
-            $this->collectionMax    = $name['max'] ?? 0;
-            $this->collection       = $name['name'];
+            if (array_key_exists('timeseries', $name)) {
+                $this->collectionTimeseries = [
+                    'timeField' => $name['timeseries']['timeField'],
+                    'metaField' => $name['timeseries']['metaField'] ?? null,
+                    'granularity' => $name['timeseries']['granularity'] ?? null
+                ];
+                $this->collectionExpireAfterSeconds = $name['expireAfterSeconds'] ?? null;
+            } else {
+                $this->collectionCapped = $name['capped'] ?? false;
+                $this->collectionSize = $name['size'] ?? 0;
+                $this->collectionMax = $name['max'] ?? 0;
+                $this->collection = $name['name'];
+            }
         } else {
             $this->collection = $name;
         }
@@ -1475,7 +1519,23 @@ public function setCollectionMax(int $max): void
     {
         $this->collectionMax = $max;
     }
+
+    /**
+     * @return array|null
+     */
+    public function getCollectionTimeseries(): ?array
+    {
+        return $this->collectionTimeseries;
+    }
 
+    /**
+     * @return int|null
+     */
+    public function getCollectionExpireAfterSeconds(): ?int
+    {
+        return $this->collectionExpireAfterSeconds;
+    }
+
     /**
      * Returns TRUE if this Document is mapped to a collection FALSE otherwise.
      */
@@ -2451,6 +2511,10 @@ public function __sleep()
             $serialized[] = 'subClasses';
         }
 
+        if ($this->isTimeSeriesDocument) {
+            $serialized[] = 'isTimeSeriesDocument';
+        }
+
         if ($this->isMappedSuperclass) {
             $serialized[] = 'isMappedSuperclass';
         }