Update to PHP_CodeSniffer version 3.6 via CC beta channel (#3717)

.codeclimate.yml

@@ -2,6 +2,7 @@ version: 2
 plugins:
   phpcodesniffer:
     enabled: true
+    channel: beta
     config:
       standard: "Drupal,DrupalPractice"
 exclude_patterns:

dkan.module

@@ -1,7 +1,7 @@
 <?php
 
 function dkan_update_8001() {
-  /* @var $metastoreService \Drupal\metastore\Service */
+  /** @var $metastoreService \Drupal\metastore\Service */
   $metastoreService = \Drupal::service('dkan.metastore.service');
   foreach ($metastoreService->getAll('dataset') as $dataset) {
     $metastoreService->publish('dataset', $dataset->identifier);

modules/common/src/CacheableResponseTrait.php

@@ -19,7 +19,7 @@ trait CacheableResponseTrait {
   /**
    * Adds cache headers to the response.
    *
-   * TODO: implement more flexible caching and move the code out of the trait.
+   * @todo implement more flexible caching and move the code out of the trait.
    *
    * @param \Symfony\Component\HttpFoundation\Response $response
    *   Symfony response.

modules/common/src/Events/Event.php

@@ -5,14 +5,11 @@
 use Drupal\Component\EventDispatcher\Event as SymfonyEvent;
 
 /**
- * Class Event.
+ * Custom DKAN extension of the Drupal Event class.
  *
  * @package Drupal\common\Events
  */
 class Event extends SymfonyEvent {
-  private $data;
-  private $exception;
-  private $validator;
 
   /**
    * Constructor.

modules/common/src/Exception/DataNodeLifeCycleEntityValidationException.php

@@ -3,7 +3,7 @@
 namespace Drupal\common\Exception;
 
 /**
- * Class DataNodeLifeCycleEntityValidationException.
+ * Class Metastore item object validation exception.
  */
 class DataNodeLifeCycleEntityValidationException extends \Exception {
 

modules/common/src/FileFetcher/Factory.php

@@ -7,11 +7,22 @@
 use FileFetcher\FileFetcher;
 
 /**
- * FileFetcher Factory.
+ * File fetcher Factory.
  */
 class Factory implements FactoryInterface {
 
+  /**
+   * Job store factory service.
+   *
+   * @var \Drupal\common\Storage\JobStoreFactory
+   */
   private $factory;
+
+  /**
+   * Default file fetcher config.
+   *
+   * @var array
+   */
   private $configDefault = [
     'keep_original_filename' => TRUE,
   ];
@@ -37,7 +48,7 @@ public function getInstance(string $identifier, array $config = []) {
    * Private.
    */
   private function getFileFetcherJobStore() {
-    /* @var \Drupal\common\Storage\JobStoreFactory $jobStoreFactory */
+    /** @var \Drupal\common\Storage\JobStoreFactory $jobStoreFactory */
     $jobStoreFactory = $this->factory;
     return $jobStoreFactory->getInstance(FileFetcher::class);
   }

modules/common/src/LoggerTrait.php

@@ -6,7 +6,7 @@
 use Psr\Log\LogLevel;
 
 /**
- * LoggerTrait.
+ * DKAN logger channel trait.
  */
 trait LoggerTrait {
 
@@ -27,6 +27,11 @@ trait LoggerTrait {
    */
   private $loggerService;
 
+  /**
+   * Whether to enable debug messages logged by the debug method.
+   *
+   * @var bool
+   */
   private $debug = FALSE;
 
   /**

modules/common/src/Resource.php

@@ -67,6 +67,12 @@ class Resource implements \JsonSerializable {
    * @var int
    */
   private $version;
+
+  /**
+   * Resource object checksum.
+   *
+   * @var string
+   */
   private $checksum;
 
   /**

modules/common/src/Storage/JobStore.php

@@ -10,6 +10,11 @@
  */
 class JobStore extends AbstractDatabaseTable {
 
+  /**
+   * Procrastinator job class.
+   *
+   * @var string
+   */
   private $jobClass;
 
   /**

modules/common/src/Storage/JobStoreFactory.php

@@ -6,10 +6,22 @@
 use Drupal\Core\Database\Connection;
 
 /**
- * Class JobStoreFactory.
+ * DKAN JobStore Factory.
  */
 class JobStoreFactory implements FactoryInterface {
+
+  /**
+   * JobStore instances keyed by unique identifiers.
+   *
+   * @var \Drupal\common\Storage\JobStore[]
+   */
   private $instances = [];
+
+  /**
+   * Drupal database connection.
+   *
+   * @var \Drupal\Core\Database\Connection
+   */
   private $connection;
 
   /**

modules/common/src/Storage/Query.php

@@ -8,7 +8,7 @@
 use Contracts\LimiterInterface;
 
 /**
- * Query class.
+ * DKAN API Query data object.
  */
 class Query implements
     SorterInterface,

modules/common/src/StreamWrapper/DkanStreamWrapper.php

@@ -5,26 +5,29 @@
 use Drupal\Core\StreamWrapper\LocalReadOnlyStream;
 use Drupal\Core\StreamWrapper\StreamWrapperInterface;
 use Drupal\Core\Url;
+use Drupal\Core\StringTranslation\StringTranslationTrait;
 
 /**
  * DKAN stream wrapper for creating domain-agnostic URLs to DKAN API endpoints.
  */
 class DkanStreamWrapper extends LocalReadOnlyStream implements StreamWrapperInterface {
 
+  use StringTranslationTrait;
+
   const DKAN_API_VERSION = 1;
 
   /**
    * {@inheritdoc}
    */
   public function getName() {
-    return t('DKAN documents');
+    return $this->t('DKAN documents');
   }
 
   /**
    * {@inheritdoc}
    */
   public function getDescription() {
-    return t('Simple way to request DKAN schemas and other documents as URIs.');
+    return $this->t('Simple way to request DKAN schemas and other documents as URIs.');
   }
 
   /**

modules/common/src/UrlHostTokenResolver.php

@@ -3,7 +3,7 @@
 namespace Drupal\common;
 
 /**
- * UrlHostTokenResolver.
+ * Convert between local file paths and public file URLs.
  *
  * @todo Convert to service with Dependency Injection.
  */

modules/common/src/Util/DrupalFiles.php

@@ -8,7 +8,7 @@
 use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
- * Class DrupalFiles.
+ * Provide custom DKAN file storage system functionality.
  *
  * It wraps a few file related Drupal functions, it provides
  * a mechanism to bring remote files locally, and to move local files to a
@@ -18,7 +18,18 @@
  */
 class DrupalFiles implements ContainerInjectionInterface {
 
+  /**
+   * Drupal file system service.
+   *
+   * @var \Drupal\Core\File\FileSystemInterface
+   */
   private $filesystem;
+
+  /**
+   * Drupal stream wrapper manager.
+   *
+   * @var \Drupal\Core\StreamWrapper\StreamWrapperManager
+   */
   private $streamWrapperManager;
 
   /**

modules/common/src/Util/Timer.php

@@ -3,10 +3,22 @@
 namespace Drupal\common\Util;
 
 /**
- * Class Timer.
+ * Timer utility object.
  */
 class Timer {
+
+  /**
+   * Start times in microseconds.
+   *
+   * @var float[]
+   */
   private $starts = [];
+
+  /**
+   * End times in microseconds.
+   *
+   * @var float[]
+   */
   private $ends = [];
 
   /**

modules/common/tests/src/Traits/CleanUp.php

@@ -14,7 +14,7 @@ trait CleanUp {
    *
    */
   private function removeHarvests() {
-    /* @var \Drupal\harvest\Service $service */
+    /** @var \Drupal\harvest\Service $service */
     $service = \Drupal::service('dkan.harvest.service');
     foreach ($service->getAllHarvestIds() as $id) {
       $service->deregisterHarvest($id);
@@ -35,7 +35,7 @@ private function removeAllNodes() {
    *
    */
   private function removeAllMappedFiles() {
-    /* @var \Drupal\metastore\Storage\ResourceMapperDatabaseTable $filemappertable */
+    /** @var \Drupal\metastore\Storage\ResourceMapperDatabaseTable $filemappertable */
     $filemappertable = \Drupal::service('dkan.metastore.resource_mapper_database_table');
     foreach ($filemappertable->retrieveAll() as $id) {
       $filemappertable->remove($id);
@@ -46,10 +46,10 @@ private function removeAllMappedFiles() {
    *
    */
   private function removeAllFileFetchingJobs() {
-    /* @var \Drupal\common\Storage\JobStoreFactory $jobStoreFactory */
+    /** @var \Drupal\common\Storage\JobStoreFactory $jobStoreFactory */
     $jobStoreFactory = \Drupal::service('dkan.common.job_store');
 
-    /* @var \Drupal\common\Storage\JobStore $jobStore */
+    /** @var \Drupal\common\Storage\JobStore $jobStore */
     $jobStore = $jobStoreFactory->getInstance(FileFetcher::class);
     foreach ($jobStore->retrieveAll() as $id) {
       $jobStore->remove($id);
@@ -62,7 +62,7 @@ private function removeAllFileFetchingJobs() {
   private function flushQueues() {
     $dkanQueues = ['orphan_reference_processor', 'datastore_import', 'resource_purger'];
     foreach ($dkanQueues as $queueName) {
-      /* @var \Drupal\Core\Queue\QueueFactory $queueFactory */
+      /** @var \Drupal\Core\Queue\QueueFactory $queueFactory */
       $queueFactory = \Drupal::service('queue');
       $queue = $queueFactory->get($queueName);
       $queue->deleteQueue();
@@ -87,7 +87,7 @@ private function removeFiles() {
    *
    */
   private function removeDatastoreTables() {
-    /* @var \Drupal\Core\Database\Connection $connection */
+    /** @var \Drupal\Core\Database\Connection $connection */
     $connection = \Drupal::service('database');
     $tables = $connection->schema()->findTables("datastore_%");
     foreach ($tables as $table) {

modules/datastore/src/Commands/PurgeCommands.php

@@ -50,7 +50,10 @@ public function __construct(ResourcePurger $resourcePurger) {
    *
    * @command dkan:datastore:purge
    */
-  public function purge(string $csvUuids, array $options = ['deferred' => FALSE, 'prior' => FALSE]) {
+  public function purge(
+    string $csvUuids,
+    array $options = ['deferred' => FALSE, 'prior' => FALSE]
+  ) {
     try {
       $uuids = StringUtils::csvToArray($csvUuids);
       $this->resourcePurger->schedule($uuids, $options['deferred'], $options['prior']);
@@ -79,7 +82,9 @@ public function purge(string $csvUuids, array $options = ['deferred' => FALSE, '
    *
    * @command dkan:datastore:purge-all
    */
-  public function purgeAll(array $options = ['deferred' => FALSE, 'prior' => FALSE]) {
+  public function purgeAll(
+    array $options = ['deferred' => FALSE, 'prior' => FALSE]
+  ) {
     try {
       $this->resourcePurger->scheduleAllUuids($options['deferred'], $options['prior']);
       $messagePrefix = $options['deferred'] ? 'Queued the purging of' : 'Purged';

modules/datastore/src/Drush.php

@@ -60,8 +60,6 @@ public function __construct(
    *
    * @todo pass configurable options for csv delimiter, quite, and escape characters.
    * @command dkan:datastore:import
-   * @aliases dkan-datastore:import
-   * @deprecated dkan-datastore:import is deprecated and will be removed in a future Dkan release. Use dkan:datastore:import instead.
    */
   public function import($uuid, $deferred = FALSE) {
 
@@ -90,8 +88,6 @@ public function import($uuid, $deferred = FALSE) {
    * @options uuid-only Only the list of uuids.
    *
    * @command dkan:datastore:list
-   * @aliases dkan-datastore:list
-   * @deprecated dkan-datastore:list is deprecated and will be removed in a future Dkan release. Use dkan:datastore:list instead.
    */
   public function list($options = [
     'format' => 'table',
@@ -147,8 +143,6 @@ private function createRow($uuid, $item) {
    *   The uuid of a dataset resource.
    *
    * @command dkan:datastore:drop
-   * @aliases dkan-datastore:drop
-   * @deprecated dkan-datastore:drop is deprecated and will be removed in a future Dkan release. Use dkan:datastore:drop instead.
    */
   public function drop($uuid) {
     try {

modules/datastore/src/Form/ResourceSettingsForm.php

@@ -6,7 +6,7 @@
 use Drupal\Core\Form\FormStateInterface;
 
 /**
- * Class ResourceSettingsForm.
+ * DKAN resource settings form.
  *
  * @package Drupal\datastore\Form
  * @codeCoverageIgnore

modules/datastore/src/Service/DatastoreQuery.php

@@ -5,7 +5,7 @@
 use RootedData\RootedJsonData;
 
 /**
- * DatastoreQuery.
+ * Datastore query data object.
  */
 class DatastoreQuery extends RootedJsonData {
 

modules/datastore/src/Service/Factory/Import.php

@@ -12,9 +12,26 @@
  * @codeCoverageIgnore
  */
 class Import implements ImportFactoryInterface {
+
+  /**
+   * Job store factory.
+   *
+   * @var \Drupal\common\Storage\JobStoreFactory
+   */
   private $jobStoreFactory;
+
+  /**
+   * Database table factory.
+   *
+   * @var \Drupal\datastore\Storage\DatabaseTableFactory
+   */
   private $databaseTableFactory;
 
+  /**
+   * Import services.
+   *
+   * @var \Drupal\datastore\Service\Import[]
+   */
   private $services = [];
 
   /**