-
-
Notifications
You must be signed in to change notification settings - Fork 384
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add PHPDoc blocks to AbstractMigration #1052
base: 3.0.x
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -60,11 +60,19 @@ public function isTransactional() : bool | |||||||||||||||||
return true; | ||||||||||||||||||
} | ||||||||||||||||||
|
||||||||||||||||||
/** | ||||||||||||||||||
* Description of this migration. | ||||||||||||||||||
* | ||||||||||||||||||
* Describe what this migration does in simple terms. This information is displayed when you view the list of migrations. | ||||||||||||||||||
*/ | ||||||||||||||||||
Comment on lines
+63
to
+67
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||
public function getDescription() : string | ||||||||||||||||||
{ | ||||||||||||||||||
return ''; | ||||||||||||||||||
} | ||||||||||||||||||
|
||||||||||||||||||
/** | ||||||||||||||||||
* Warn with a message if some condition is met. | ||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That's made fairly clear just by reading the signature (you don't have to read the code inside the method) There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixed |
||||||||||||||||||
*/ | ||||||||||||||||||
public function warnIf(bool $condition, string $message = 'Unknown Reason') : void | ||||||||||||||||||
{ | ||||||||||||||||||
if (! $condition) { | ||||||||||||||||||
|
@@ -155,6 +163,11 @@ public function getSql() : array | |||||||||||||||||
return $this->plannedSql; | ||||||||||||||||||
} | ||||||||||||||||||
|
||||||||||||||||||
/** | ||||||||||||||||||
* Write some debug information to the console. | ||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. debug information is written with There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixed |
||||||||||||||||||
* | ||||||||||||||||||
* Debug information is written with debug(). | ||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🤔 I mean it should, but it's actually written with |
||||||||||||||||||
*/ | ||||||||||||||||||
protected function write(string $message) : void | ||||||||||||||||||
{ | ||||||||||||||||||
$this->logger->notice($message, ['migration' => $this]); | ||||||||||||||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tautological, either improve or remove
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed