You are here

interface ReportInterface in Drupal 7 to 8/9 Module Upgrader 8

Defines a report generated by the dmu-analyze command. Issues returned by analyzers are added to this report, then it's handed off to the theme system.

Hierarchy

Expanded class hierarchy of ReportInterface

All classes that implement ReportInterface

File

src/ReportInterface.php, line 9

Namespace

Drupal\drupalmoduleupgrader
View source
interface ReportInterface {

  /**
   * Adds an issue to this module.
   *
   * @param IssueInterface $issue
   *   The issue to add.
   *
   * @return $this
   */
  public function addIssue(IssueInterface $issue);

  /**
   * Returns all issues collected so far, optionally filtered by a tag.
   *
   * @param string|null $tag
   *   (optional) A tag name. If set, only issues which have this tag will
   *   be returned (regardless of the tag's value in each issue -- it's up to
   *   the calling code to do any further filtering).
   *
   * @return IssueInterface[]
   */
  public function getIssues($tag = NULL);

}

Members

Namesort descending Modifiers Type Description Overrides
ReportInterface::addIssue public function Adds an issue to this module. 1
ReportInterface::getIssues public function Returns all issues collected so far, optionally filtered by a tag. 1