Issue #6: fix a bunch of Scrutinizer issues.

Author: fgm

src/Controller/CheckListController.php

@@ -36,6 +36,7 @@ public function __construct(QaCheckManager $qam) {
    */
   public static function create(ContainerInterface $container) {
     $qam = $container->get(Data::MANAGER);
+    assert($qam instanceof QaCheckManager);
     return new static($qam);
   }
 
@@ -81,20 +82,4 @@ public function report() {
     return $checks;
   }
 
-  /**
-   * Placeholder controller for "view".
-   *
-   * @param string $qaVariable
-   *   The variable to view.
-   *
-   * @return array
-   *   A render array.
-   */
-  public function view($qaVariable) {
-    return [
-      '#type' => 'markup',
-      '#markup' => $this->t('Implement method: view'),
-    ];
-  }
-
 }

src/Controller/DependenciesReportController.php

@@ -12,29 +12,13 @@ class DependenciesReportController extends ControllerBase {
   /**
    * Action.
    *
-   * @return string
-   *   Return Hello string.
-   */
-  public function report() {
-    return [
-      '#type' => 'markup',
-      '#markup' => $this->t('Implement method: report'),
-    ];
-  }
-
-  /**
-   * Placeholder controller for "dependencies".
-   *
-   * @param string $qaVariable
-   *   The variable name.
-   *
    * @return array
    *   A render array.
    */
-  public function view($qaVariable) {
+  public function report() {
     return [
       '#type' => 'markup',
-      '#markup' => $this->t('Implement method: view'),
+      '#markup' => $this->t('Implement method: report'),
     ];
   }
 

src/Controller/ProjectsReportController.php

@@ -42,7 +42,9 @@ public function __construct(
 
   public static function create(ContainerInterface $container) {
     $updateManager = $container->get('update.manager');
+    assert($updateManager instanceof UpdateManagerInterface);
     $kve = $container->get('keyvalue.expirable');
+    assert($kve instanceof KeyValueExpirableFactoryInterface);
     return new static($updateManager, $kve);
   }
 
@@ -111,15 +113,15 @@ private final function qa_report_project(Variable $variable = NULL) {
     $bc[] = l($this->t('Variables'), 'admin/reports/qa/variable');
     drupal_set_breadcrumb($bc);
 
-    drupal_set_title($this->t('Variable: %name', ['%name' => $variable->name]),
-      PASS_THROUGH);
+    drupal_set_title($this->t('Variable: %name', ['%name' => $variable->name]), ['passthrough' => TRUE]);
     return $variable->dump();
   }
 
   /**
    * Page callback for projects list.
    *
-   * @return string
+   * @return array
+   *   A render array.
    *
    * @FIXME This still uses the D7 info structure.
    *
@@ -187,9 +189,11 @@ private final function qa_report_projects() {
         $rows[] = $row;
       }
     }
-    return theme('table', [
-      'header' => $header,
-      'rows' => $rows,
-    ]);
+    return [
+      '#theme' => 'table',
+      '#header' => $header,
+      '#rows' => $rows,
+    ];
   }
+
 }

src/Controller/ResultsReportController.php

@@ -14,29 +14,13 @@ class ResultsReportController extends ControllerBase {
   /**
    * Action.
    *
-   * @return string
-   *   Return Hello string.
-   */
-  public function report() {
-    return [
-      '#type' => 'markup',
-      '#markup' => $this->t('Implement method: report'),
-    ];
-  }
-
-  /**
-   * Placeholder controller for "results".
-   *
-   * @param string $qaVariable
-   *   The variable name.
-   *
    * @return array
    *   A render array.
    */
-  public function view($qaVariable) {
+  public function report() {
     return [
       '#type' => 'markup',
-      '#markup' => $this->t('Implement method: view'),
+      '#markup' => $this->t('Implement method: report'),
     ];
   }
 

src/Controller/VariablesReportController.php

@@ -14,8 +14,8 @@ class VariablesReportController extends ControllerBase {
   /**
    * Action.
    *
-   * @return string
-   *   Return Hello string.
+   * @return array
+   *   A render array.
    */
   public function report() {
     return [

src/Plugin/Qa/Control/BaseControl.php

@@ -3,6 +3,7 @@
 namespace Drupal\qa\Plugin\Qa\Control;
 
 use Drupal\Component\Utility\Crypt;
+use Drupal\Core\PrivateKey;
 use Drupal\qa\Exportable;
 use Drupal\qa\Pass;
 use Drupal\qa\Plugin\QaCheckInterface;
@@ -49,19 +50,32 @@ abstract class BaseControl extends Exportable implements QaCheckInterface {
    */
   protected static $packages = [];
 
+  /**
+   * The private_key service.
+   *
+   * @var \Drupal\Core\PrivateKey
+   */
+  protected $pk;
+
   /**
    * BaseControl constructor.
+   *
+   * @param \Drupal\Core\PrivateKey $pk
+   *   The private_ket service.
    */
-  public function __construct() {
+  public function __construct(PrivateKey $pk) {
     parent::__construct();
     $this->package_name = $this->namespace;
+    $this->pk = $pk;
   }
 
   /**
    * {@inheritdoc}
    */
   public static function create(ContainerInterface $container) {
-    return new static();
+    $pk = $container->get('private_key');
+    assert($pk instanceof PrivateKey);
+    return new static($pk);
   }
 
   /**
@@ -141,7 +155,7 @@ public static function getControls($package_name = NULL) {
    */
   public function run(): Pass {
     global $base_url;
-    $site_key = Crypt::hmacBase64($base_url, \Drupal::service('private_key')->get());
+    $site_key = Crypt::hmacBase64($base_url, $this->pk->get());
     $key = uniqid($site_key);
     $pass = new Pass($this);
     $this->passes[$key] = $pass;

src/Plugin/Qa/Control/I18n/Variables.php

@@ -37,7 +37,7 @@ public function init() {
   /**
    * Identify variables translations for languages not currently on site
    */
-  function checkExtra() {
+  public function checkExtra() {
     $languages = array_keys(language_list());
     $ph = db_placeholders($languages, 'char');
     $sq = <<<sql
@@ -69,7 +69,7 @@ function checkExtra() {
   /**
    * Identify variables for which at least one translation is missing
    */
-  function checkMissing() {
+  public function checkMissing() {
     $languages = array_keys(language_list());
     $ph = db_placeholders($languages, 'char');
     $sq = <<<sql
@@ -102,12 +102,12 @@ function checkMissing() {
     return $ret;
   }
 
-  static function getDependencies(): array {
+  public static function getDependencies(): array {
     $ret = ['i18n']; // introduces {i18n_variable}
     return $ret;
   }
 
-  function run(): Pass {
+  public function run(): Pass {
     $pass = parent::run();
     $pass->record($this->checkExtra());
     $pass->life->modify();

src/Plugin/Qa/Control/Taxonomy/Freetagging.php

@@ -2,6 +2,7 @@
 
 namespace Drupal\qa\Taxonomy;
 
+use Drupal\Core\PrivateKey;
 use Drupal\qa\Pass;
 use Drupal\qa\Plugin\Qa\Control\BaseControl;
 
@@ -13,8 +14,8 @@ class Freetagging extends BaseControl {
   /**
    * {@inheritdoc]
    */
-  public function __construct() {
-    parent::__construct();
+  public function __construct(PrivateKey $pk) {
+    parent::__construct($pk);
     $this->package_name = __NAMESPACE__;
   }
 
@@ -40,7 +41,7 @@ public function init() {
    *
    * @return array
    */
-  function checkTags($vocabulary) {
+  public function checkTags($vocabulary) {
     $sq = <<<sql
 SELECT td.tid
 FROM {taxonomy_term_data} td
@@ -69,7 +70,7 @@ function checkTags($vocabulary) {
     return $ret;
   }
 
-  function run(): Pass {
+  public function run(): Pass {
     $pass = parent::run();
     $vocabularies = taxonomy_get_vocabularies();
     foreach ($vocabularies as $vocabulary) {

src/Plugin/Qa/Control/Views/Overrides.php

@@ -15,7 +15,7 @@ public function init() {
     $this->description = t('Have any views been overridden or only created in the DB ? This is a performance and change management issue.');
   }
 
-  function checkViewType($view) {
+  public function checkViewType($view) {
     $status = $view->type == t('Default') ? 1 : 0;
     if (!$status) {
       $name = empty($view->human_name) ? $view->name : $view->human_name;
@@ -37,7 +37,7 @@ function checkViewType($view) {
     return $ret;
   }
 
-  function run(): Pass {
+  public function run(): Pass {
     $pass = parent::run();
     $views = views_get_all_views(TRUE);
     foreach ($views as $view) {

src/Plugin/Qa/Control/Views/Php.php

@@ -116,7 +116,7 @@ protected function getPhpFormats($reset = FALSE) {
     return $php;
   }
 
-  function run(): Pass {
+  public function run(): Pass {
     $pass = parent::run();
     $views = views_get_all_views(TRUE);
     foreach ($views as $view) {