www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/drupalmoduleupgrader/src/ReportInterface.php

   1 <?php
   2
   3 namespace Drupal\drupalmoduleupgrader;
   4
   5 /**
   6  * Defines a report generated by the dmu-analyze command. Issues returned by
   7  * analyzers are added to this report, then it's handed off to the theme system.
   8  */
   9 interface ReportInterface {
  10
  11   /**
  12    * Adds an issue to this module.
  13    *
  14    * @param IssueInterface $issue
  15    *  The issue to add.
  16    *
  17    * @return $this
  18    */
  19   public function addIssue(IssueInterface $issue);
  20
  21   /**
  22    * Returns all issues collected so far, optionally filtered by a tag.
  23    *
  24    * @param string|NULL $tag
  25    *  (optional) A tag name. If set, only issues which have this tag will
  26    *  be returned (regardless of the tag's value in each issue -- it's up to
  27    *  the calling code to do any further filtering).
  28    *
  29    * @return IssueInterface[]
  30    */
  31   public function getIssues($tag = NULL);
  32
  33 }