Returns the description which has been previously parsed
| public getDescription ( ) : string | ||
| return | string | The description which has been parsed |
/**
* Returns the description of a migration.
*
* If available it is fetched from the getDescription() method, if that returns an empty value
* the class docblock is used instead.
*
* @param Version $version
* @param DocCommentParser $parser
* @return string
*/
protected function getMigrationDescription(Version $version, DocCommentParser $parser)
{
if ($version->getMigration()->getDescription()) {
return $version->getMigration()->getDescription();
} else {
$reflectedClass = new \ReflectionClass($version->getMigration());
$parser->parseDocComment($reflectedClass->getDocComment());
return str_replace([chr(10), chr(13)], ' ', $parser->getDescription());
}
}
/**
* @test
*/
public function descriptionWithOneLineIsParsedCorrectly()
{
$parser = new DocCommentParser();
$parser->parseDocComment('/**' . chr(10) . ' * Testcase for DocCommentParser' . chr(10) . ' */');
$this->assertEquals('Testcase for DocCommentParser', $parser->getDescription());
}