Adding Table::getComment and Table::setComment methods

Author: moufmouf

lib/Doctrine/DBAL/Schema/Table.php

@@ -838,4 +838,17 @@ private function normalizeIdentifier($identifier)
 
         return $this->trimQuotes(strtolower($identifier));
     }
+
+    public function setComment(?string $comment) : self
+    {
+        // For keeping backward compatibility with MySQL in previous releases, table comments are stored as options.
+        $this->addOption('comment', $comment);
+
+        return $this;
+    }
+
+    public function getComment() : ?string
+    {
+        return $this->_options['comment'] ?? null;
+    }
 }

tests/Doctrine/Tests/DBAL/Functional/Schema/SchemaManagerFunctionalTestCase.php

@@ -1580,10 +1580,10 @@ public function testCommentInTable() : void
     {
         $table = new Table('table_with_comment');
         $table->addColumn('id', 'integer');
-        $table->addOption('comment', 'Foo with control characters \'\\');
+        $table->setComment('Foo with control characters \'\\');
         $this->schemaManager->dropAndCreateTable($table);
 
         $table = $this->schemaManager->listTableDetails('table_with_comment');
-        self::assertSame('Foo with control characters \'\\', $table->getOption('comment'));
+        self::assertSame('Foo with control characters \'\\', $table->getComment());
     }
 }

tests/Doctrine/Tests/DBAL/Schema/TableTest.php

@@ -882,4 +882,13 @@ public function getNormalizesAssetNames()
             ['"FOO"'],
         ];
     }
+
+    public function testTableComment()
+    {
+        $table = new Table('bar');
+        self::assertNull($table->getComment());
+
+        $table->setComment('foo');
+        self::assertEquals('foo', $table->getComment());
+    }
 }