Skip to content

Commit 62f6570

Browse files
committed
Add PHPDoc blocks to AbstractMigration
1 parent 4eef7b0 commit 62f6570

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

lib/Doctrine/Migrations/AbstractMigration.php

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,19 @@ public function isTransactional() : bool
6060
return true;
6161
}
6262

63+
/**
64+
* Description of this migration.
65+
*
66+
* Describe what this migration does in simple terms. This information is displayed when you view the list of migrations.
67+
*/
6368
public function getDescription() : string
6469
{
6570
return '';
6671
}
6772

73+
/**
74+
* Warn with a message if some condition is met.
75+
*/
6876
public function warnIf(bool $condition, string $message = 'Unknown Reason') : void
6977
{
7078
if (! $condition) {
@@ -155,6 +163,11 @@ public function getSql() : array
155163
return $this->plannedSql;
156164
}
157165

166+
/**
167+
* Write some debug information to the console.
168+
*
169+
* Debug information is written with debug().
170+
*/
158171
protected function write(string $message) : void
159172
{
160173
$this->logger->notice($message, ['migration' => $this]);

0 commit comments

Comments
 (0)