diff --git a/.codeclimate.yml b/.codeclimate.yml index 82bc4d4073..982772090b 100644 --- a/.codeclimate.yml +++ b/.codeclimate.yml @@ -2,6 +2,7 @@ version: 2 plugins: phpcodesniffer: enabled: true + channel: beta config: standard: "Drupal,DrupalPractice" exclude_patterns: diff --git a/dkan.module b/dkan.module index 56c5fa3583..4f1729a97f 100644 --- a/dkan.module +++ b/dkan.module @@ -1,7 +1,7 @@ getAll('dataset') as $dataset) { $metastoreService->publish('dataset', $dataset->identifier); diff --git a/modules/common/src/CacheableResponseTrait.php b/modules/common/src/CacheableResponseTrait.php index 0c6969bf55..cecbf30d24 100644 --- a/modules/common/src/CacheableResponseTrait.php +++ b/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. diff --git a/modules/common/src/Events/Event.php b/modules/common/src/Events/Event.php index ff575c8f34..e3218f92ec 100644 --- a/modules/common/src/Events/Event.php +++ b/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. diff --git a/modules/common/src/Exception/DataNodeLifeCycleEntityValidationException.php b/modules/common/src/Exception/DataNodeLifeCycleEntityValidationException.php index 65a21f7568..e8872f3f47 100644 --- a/modules/common/src/Exception/DataNodeLifeCycleEntityValidationException.php +++ b/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 { diff --git a/modules/common/src/FileFetcher/Factory.php b/modules/common/src/FileFetcher/Factory.php index a027a1be09..31ef1b43e3 100644 --- a/modules/common/src/FileFetcher/Factory.php +++ b/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); } diff --git a/modules/common/src/LoggerTrait.php b/modules/common/src/LoggerTrait.php index cd5a120b3f..88c0d40dca 100644 --- a/modules/common/src/LoggerTrait.php +++ b/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; /** diff --git a/modules/common/src/Resource.php b/modules/common/src/Resource.php index 02e58dd580..6b149e89b9 100644 --- a/modules/common/src/Resource.php +++ b/modules/common/src/Resource.php @@ -67,6 +67,12 @@ class Resource implements \JsonSerializable { * @var int */ private $version; + + /** + * Resource object checksum. + * + * @var string + */ private $checksum; /** diff --git a/modules/common/src/Storage/JobStore.php b/modules/common/src/Storage/JobStore.php index f5418fabd3..27e5d501cc 100644 --- a/modules/common/src/Storage/JobStore.php +++ b/modules/common/src/Storage/JobStore.php @@ -10,6 +10,11 @@ */ class JobStore extends AbstractDatabaseTable { + /** + * Procrastinator job class. + * + * @var string + */ private $jobClass; /** diff --git a/modules/common/src/Storage/JobStoreFactory.php b/modules/common/src/Storage/JobStoreFactory.php index 84e3bec3cc..6162170a8c 100644 --- a/modules/common/src/Storage/JobStoreFactory.php +++ b/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; /** diff --git a/modules/common/src/Storage/Query.php b/modules/common/src/Storage/Query.php index b66a82a6cd..a977be1b33 100644 --- a/modules/common/src/Storage/Query.php +++ b/modules/common/src/Storage/Query.php @@ -8,7 +8,7 @@ use Contracts\LimiterInterface; /** - * Query class. + * DKAN API Query data object. */ class Query implements SorterInterface, diff --git a/modules/common/src/StreamWrapper/DkanStreamWrapper.php b/modules/common/src/StreamWrapper/DkanStreamWrapper.php index 813b843bae..485763cb42 100644 --- a/modules/common/src/StreamWrapper/DkanStreamWrapper.php +++ b/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.'); } /** diff --git a/modules/common/src/UrlHostTokenResolver.php b/modules/common/src/UrlHostTokenResolver.php index a543035a4e..9b5eaf6187 100644 --- a/modules/common/src/UrlHostTokenResolver.php +++ b/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. */ diff --git a/modules/common/src/Util/DrupalFiles.php b/modules/common/src/Util/DrupalFiles.php index d1fcb61372..e73068332f 100644 --- a/modules/common/src/Util/DrupalFiles.php +++ b/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; /** diff --git a/modules/common/src/Util/Timer.php b/modules/common/src/Util/Timer.php index 4f7b973503..1bb3ad2138 100644 --- a/modules/common/src/Util/Timer.php +++ b/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 = []; /** diff --git a/modules/common/tests/src/Traits/CleanUp.php b/modules/common/tests/src/Traits/CleanUp.php index 112f21ad1c..0a9dda8eb0 100644 --- a/modules/common/tests/src/Traits/CleanUp.php +++ b/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) { diff --git a/modules/datastore/src/Commands/PurgeCommands.php b/modules/datastore/src/Commands/PurgeCommands.php index 22c753502f..e4e3805e1d 100644 --- a/modules/datastore/src/Commands/PurgeCommands.php +++ b/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'; diff --git a/modules/datastore/src/Drush.php b/modules/datastore/src/Drush.php index 659b0f618e..354462f3ac 100755 --- a/modules/datastore/src/Drush.php +++ b/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 { diff --git a/modules/datastore/src/Form/ResourceSettingsForm.php b/modules/datastore/src/Form/ResourceSettingsForm.php index 7227b05ad1..753b7e5ce4 100644 --- a/modules/datastore/src/Form/ResourceSettingsForm.php +++ b/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 diff --git a/modules/datastore/src/Service/DatastoreQuery.php b/modules/datastore/src/Service/DatastoreQuery.php index 1d19920681..f94220d8da 100644 --- a/modules/datastore/src/Service/DatastoreQuery.php +++ b/modules/datastore/src/Service/DatastoreQuery.php @@ -5,7 +5,7 @@ use RootedData\RootedJsonData; /** - * DatastoreQuery. + * Datastore query data object. */ class DatastoreQuery extends RootedJsonData { diff --git a/modules/datastore/src/Service/Factory/Import.php b/modules/datastore/src/Service/Factory/Import.php index 233ade6df0..a149518ea7 100644 --- a/modules/datastore/src/Service/Factory/Import.php +++ b/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 = []; /** diff --git a/modules/datastore/src/Service/Info/ImportInfoList.php b/modules/datastore/src/Service/Info/ImportInfoList.php index 0992159964..d17aaef238 100644 --- a/modules/datastore/src/Service/Info/ImportInfoList.php +++ b/modules/datastore/src/Service/Info/ImportInfoList.php @@ -19,6 +19,11 @@ class ImportInfoList implements ContainerInjectionInterface { */ private $jobStoreFactory; + /** + * Datastore import job info. + * + * @var \Drupal\datastore\Service\Info\ImportInfo + */ private $importInfo; /** diff --git a/modules/datastore/src/Service/ResourceLocalizer.php b/modules/datastore/src/Service/ResourceLocalizer.php index 1a7cb56362..3fafaab338 100644 --- a/modules/datastore/src/Service/ResourceLocalizer.php +++ b/modules/datastore/src/Service/ResourceLocalizer.php @@ -25,12 +25,46 @@ class ResourceLocalizer { use LoggerTrait; use EventDispatcherTrait; + /** + * Local file perspective key. + * + * @var string + */ const LOCAL_FILE_PERSPECTIVE = 'local_file'; + + /** + * Local URL perspective key. + * + * @var string + */ const LOCAL_URL_PERSPECTIVE = 'local_url'; + /** + * DKAN resource file mapper service. + * + * @var \Drupal\metastore\ResourceMapper + */ private $fileMapper; + + /** + * DKAN resource file fetcher factory. + * + * @var \Contracts\FactoryInterface + */ private $fileFetcherFactory; + + /** + * Drupal files utility service. + * + * @var \Drupal\common\Util\DrupalFiles + */ private $drupalFiles; + + /** + * Job store factory. + * + * @var \Drupal\common\Storage\JobStoreFactory + */ private $jobStoreFactory; /** diff --git a/modules/datastore/src/Service/ResourcePurger.php b/modules/datastore/src/Service/ResourcePurger.php index a43f97f16d..4c5d06b5c4 100644 --- a/modules/datastore/src/Service/ResourcePurger.php +++ b/modules/datastore/src/Service/ResourcePurger.php @@ -15,7 +15,7 @@ use Symfony\Component\DependencyInjection\ContainerInterface; /** - * ResourcePurger service. + * Resource purger service. */ class ResourcePurger implements ContainerInjectionInterface { use LoggerTrait; diff --git a/modules/datastore/src/SqlEndpoint/Helper/GetStringsFromStateMachineExecution.php b/modules/datastore/src/SqlEndpoint/Helper/GetStringsFromStateMachineExecution.php index 9cff8d53cb..1147c959f9 100644 --- a/modules/datastore/src/SqlEndpoint/Helper/GetStringsFromStateMachineExecution.php +++ b/modules/datastore/src/SqlEndpoint/Helper/GetStringsFromStateMachineExecution.php @@ -3,12 +3,30 @@ namespace Drupal\datastore\SqlEndpoint\Helper; /** - * Class GetStringsFromStateMachineExecution. + * SQL Endpoint state machine processor. */ class GetStringsFromStateMachineExecution { + + /** + * Execution state machine. + * + * @var array + */ private $execution; + + /** + * Built SQL strings. + * + * @var string[] + */ private $strings = []; - private $currentString = ""; + + /** + * Current string being built from state machine. + * + * @var string + */ + private $currentString = ''; /** * Constructor. diff --git a/modules/datastore/src/Storage/DatabaseTableFactory.php b/modules/datastore/src/Storage/DatabaseTableFactory.php index e92a1abbe7..883ac4d867 100644 --- a/modules/datastore/src/Storage/DatabaseTableFactory.php +++ b/modules/datastore/src/Storage/DatabaseTableFactory.php @@ -7,9 +7,15 @@ use Drupal\indexer\IndexManager; /** - * Class DatabaseTableFactory. + * DatabaseTable data object factory. */ class DatabaseTableFactory implements FactoryInterface { + + /** + * Drupal database connection service. + * + * @var \Drupal\Core\Database\Connection + */ private $connection; /** @@ -19,6 +25,11 @@ class DatabaseTableFactory implements FactoryInterface { */ private $indexManager; + /** + * Database table data objects. + * + * @var \Drupal\datastore\Storage\DatabaseTable + */ private $databaseTables = []; /** diff --git a/modules/datastore/src/Storage/TableSummary.php b/modules/datastore/src/Storage/TableSummary.php index 7b9d8367cb..51016fc93d 100644 --- a/modules/datastore/src/Storage/TableSummary.php +++ b/modules/datastore/src/Storage/TableSummary.php @@ -8,8 +8,26 @@ * @todo Use JSON Schema maybe to validate this? */ class TableSummary implements \JsonSerializable { + + /** + * Number of columns. + * + * @var int + */ public $numOfColumns; + + /** + * Summary columns. + * + * @var string[] + */ public $columns; + + /** + * Number of rows. + * + * @var int + */ public $numOfRows; /** diff --git a/modules/dkan_js_frontend/src/Routing/RouteProvider.php b/modules/dkan_js_frontend/src/Routing/RouteProvider.php index 3fd8c22ce9..d893093b08 100644 --- a/modules/dkan_js_frontend/src/Routing/RouteProvider.php +++ b/modules/dkan_js_frontend/src/Routing/RouteProvider.php @@ -7,7 +7,7 @@ use Symfony\Component\Routing\RouteCollection; /** - * Class. + * DKAN JS frontend route provider. */ class RouteProvider { diff --git a/modules/frontend/src/Controller/Page.php b/modules/frontend/src/Controller/Page.php index ba98bae0e1..e6871f806d 100644 --- a/modules/frontend/src/Controller/Page.php +++ b/modules/frontend/src/Controller/Page.php @@ -14,6 +14,11 @@ class Page implements ContainerInjectionInterface { use CacheableResponseTrait; + /** + * Drupal frontend page builder service. + * + * @var \Drupal\frontend\Page + */ private $pageBuilder; /** diff --git a/modules/frontend/src/Page.php b/modules/frontend/src/Page.php index 4977cb87b5..5016bebe26 100644 --- a/modules/frontend/src/Page.php +++ b/modules/frontend/src/Page.php @@ -6,13 +6,23 @@ use Drupal\Core\Config\ConfigFactoryInterface; /** - * Class. + * Frontend page. */ class Page { + /** + * App root directory for react data catalog app. + * + * @var string + */ private $appRoot; + + /** + * Node storage service. + * + * @var string + */ private $nodeStorage; - private $configFactory; /** * Constructor. diff --git a/modules/frontend/src/Routing/RouteProvider.php b/modules/frontend/src/Routing/RouteProvider.php index c77623ba45..1c96dec33e 100644 --- a/modules/frontend/src/Routing/RouteProvider.php +++ b/modules/frontend/src/Routing/RouteProvider.php @@ -8,13 +8,16 @@ use Symfony\Component\Routing\RouteCollection; /** - * Class. + * DKAN Frontend route provider. */ class RouteProvider { + /** + * App root directory for react data catalog app. + * + * @var string + */ private $appRoot; - private $entityQuery; - private $configFactory; /** * Constructor. @@ -52,7 +55,7 @@ public function routes() { /** * Public. */ - public function getNameFromPath($path) { + public function getNameFromPath($path) { $base = $this->appRoot . $this->frontendPath . $this->buildFolder; $sub = str_replace($base, "", $path); return str_replace("/", "__", $sub); @@ -112,7 +115,7 @@ private function addStaticPages(RouteCollection $routes) { $possible_pages = $this->expandDirectories($base); foreach ($possible_pages as $possible_page) { if (file_exists($possible_page . "/index.html")) { - $name = self::getNameFromPath($possible_page); + $name = $this->getNameFromPath($possible_page); $path = str_replace($base, "", $possible_page); $routes->add($name, $this->routeHelper($path, $name)); } diff --git a/modules/harvest/src/Commands/HarvestCommands.php b/modules/harvest/src/Commands/HarvestCommands.php index a3dd3d8e47..41717efa87 100644 --- a/modules/harvest/src/Commands/HarvestCommands.php +++ b/modules/harvest/src/Commands/HarvestCommands.php @@ -85,8 +85,6 @@ function ($id) { * @command dkan:harvest:register * * @usage dkan:harvest:register --identifier=myHarvestId --extract-uri=http://example.com/data.json - * @aliases dkan-harvest:register - * @deprecated dkan-harvest:register is deprecated and will be removed in a future Dkan release. Use dkan:harvest:register instead. */ public function register(string $plan_json = '', array $opts = [ 'identifier' => '', diff --git a/modules/harvest/src/Commands/Helper.php b/modules/harvest/src/Commands/Helper.php index 34187d1423..c39d265b47 100644 --- a/modules/harvest/src/Commands/Helper.php +++ b/modules/harvest/src/Commands/Helper.php @@ -10,7 +10,7 @@ use Symfony\Component\Console\Output\ConsoleOutput; /** - * Trait Helper. + * Commands helper trait. * * @codeCoverageIgnore */ diff --git a/modules/harvest/src/OrphanDatasetsProcessor.php b/modules/harvest/src/OrphanDatasetsProcessor.php index 7afcb6ea82..1695017b64 100644 --- a/modules/harvest/src/OrphanDatasetsProcessor.php +++ b/modules/harvest/src/OrphanDatasetsProcessor.php @@ -3,7 +3,7 @@ namespace Drupal\harvest; /** - * Trait OrphanDatasetsProcessor. + * Handle dataset orphaning. * * @package Drupal\harvest */ diff --git a/modules/harvest/src/Storage/DatabaseTable.php b/modules/harvest/src/Storage/DatabaseTable.php index c40f5880e8..e4916963b9 100644 --- a/modules/harvest/src/Storage/DatabaseTable.php +++ b/modules/harvest/src/Storage/DatabaseTable.php @@ -6,9 +6,15 @@ use Drupal\common\Storage\AbstractDatabaseTable; /** - * DatabaseTable. + * Harvest database table storage. */ class DatabaseTable extends AbstractDatabaseTable { + + /** + * Database table identifier. + * + * @var string + */ private $identifier; /** diff --git a/modules/harvest/src/Storage/DatabaseTableFactory.php b/modules/harvest/src/Storage/DatabaseTableFactory.php index 363997d835..23735027f3 100644 --- a/modules/harvest/src/Storage/DatabaseTableFactory.php +++ b/modules/harvest/src/Storage/DatabaseTableFactory.php @@ -6,10 +6,22 @@ use Drupal\Core\Database\Connection; /** - * DatabaseTableFactory. + * Database table factory. */ class DatabaseTableFactory implements FactoryInterface { + + /** + * Drupal database connection service. + * + * @var \Drupal\Core\Database\Connection + */ private $connection; + + /** + * Database table data objects. + * + * @var \Drupal\harvest\Storage\DatabaseTable + */ private $storage = []; /** diff --git a/modules/harvest/src/Storage/IdGenerator.php b/modules/harvest/src/Storage/IdGenerator.php index 25086a56e3..41e84eed87 100644 --- a/modules/harvest/src/Storage/IdGenerator.php +++ b/modules/harvest/src/Storage/IdGenerator.php @@ -5,7 +5,7 @@ use Contracts\IdGeneratorInterface; /** - * Class IdGenerator. + * Extracts identifiers from metastore data objects. * * @codeCoverageIgnore */ @@ -16,7 +16,7 @@ class IdGenerator implements IdGeneratorInterface { * * @var mixed */ - protected $data; + protected $data; /** * Public. diff --git a/modules/json_form_widget/src/ArrayHelper.php b/modules/json_form_widget/src/ArrayHelper.php index 37c9355738..04835d05d7 100644 --- a/modules/json_form_widget/src/ArrayHelper.php +++ b/modules/json_form_widget/src/ArrayHelper.php @@ -9,7 +9,7 @@ use Symfony\Component\DependencyInjection\ContainerInterface; /** - * Class ArrayHelper. + * Drupal render array helper service. */ class ArrayHelper implements ContainerInjectionInterface { use StringTranslationTrait; diff --git a/modules/json_form_widget/src/FormBuilder.php b/modules/json_form_widget/src/FormBuilder.php index 524f7bb78c..497dd02929 100644 --- a/modules/json_form_widget/src/FormBuilder.php +++ b/modules/json_form_widget/src/FormBuilder.php @@ -8,7 +8,7 @@ use Drupal\Core\Logger\LoggerChannelFactory; /** - * Class FormBuilder. + * Form builder service. */ class FormBuilder implements ContainerInjectionInterface { diff --git a/modules/json_form_widget/src/ObjectHelper.php b/modules/json_form_widget/src/ObjectHelper.php index 3ad5f1aec3..c052b8ae88 100644 --- a/modules/json_form_widget/src/ObjectHelper.php +++ b/modules/json_form_widget/src/ObjectHelper.php @@ -3,7 +3,7 @@ namespace Drupal\json_form_widget; /** - * Class ObjectHelper. + * Object form element helper. */ class ObjectHelper { diff --git a/modules/json_form_widget/src/Plugin/Field/FieldWidget/JsonFormWidget.php b/modules/json_form_widget/src/Plugin/Field/FieldWidget/JsonFormWidget.php index 719f646e2b..646c89e4f4 100644 --- a/modules/json_form_widget/src/Plugin/Field/FieldWidget/JsonFormWidget.php +++ b/modules/json_form_widget/src/Plugin/Field/FieldWidget/JsonFormWidget.php @@ -139,7 +139,7 @@ public function formElement(FieldItemListInterface $items, $delta, array $elemen */ public function extractFormValues(FieldItemListInterface $items, array $form, FormStateInterface $form_state) { $field_name = $form_state->get('json_form_widget_field'); - // TODO: there is duplicated code here. + // @todo there is duplicated code here. $type = $form_state->getformObject()->getEntity()->get('field_data_type')->value; $type = isset($type) ? $type : $this->getSetting('schema'); $this->builder->setSchema($this->getSetting('schema'), $type); diff --git a/modules/json_form_widget/src/SchemaUiHandler.php b/modules/json_form_widget/src/SchemaUiHandler.php index db1d4a83fc..a0d930edb7 100644 --- a/modules/json_form_widget/src/SchemaUiHandler.php +++ b/modules/json_form_widget/src/SchemaUiHandler.php @@ -8,7 +8,7 @@ use Drupal\Core\Logger\LoggerChannelFactory; /** - * Class SchemaUiHandler. + * JSON form widget schema UI handler service. */ class SchemaUiHandler implements ContainerInjectionInterface { diff --git a/modules/json_form_widget/src/StringHelper.php b/modules/json_form_widget/src/StringHelper.php index d997af1d08..42958930c7 100644 --- a/modules/json_form_widget/src/StringHelper.php +++ b/modules/json_form_widget/src/StringHelper.php @@ -10,7 +10,7 @@ use Symfony\Component\DependencyInjection\ContainerInterface; /** - * Class StringHelper. + * JSON form widget string helper service. */ class StringHelper implements ContainerInjectionInterface { use StringTranslationTrait; diff --git a/modules/json_form_widget/src/ValueHandler.php b/modules/json_form_widget/src/ValueHandler.php index e072c727d0..cc3464c93a 100644 --- a/modules/json_form_widget/src/ValueHandler.php +++ b/modules/json_form_widget/src/ValueHandler.php @@ -5,7 +5,7 @@ use Drupal\Core\Datetime\DrupalDateTime; /** - * Class ValueHandler. + * JSON form widget value helper service. */ class ValueHandler { diff --git a/modules/json_form_widget/src/WidgetRouter.php b/modules/json_form_widget/src/WidgetRouter.php index 3b43f512b9..cba3047cea 100644 --- a/modules/json_form_widget/src/WidgetRouter.php +++ b/modules/json_form_widget/src/WidgetRouter.php @@ -9,7 +9,7 @@ use Symfony\Component\DependencyInjection\ContainerInterface; /** - * Class WidgetRouter. + * JSON form widget router service. */ class WidgetRouter implements ContainerInjectionInterface { diff --git a/modules/metastore/modules/metastore_search/src/ComplexData/Dataset.php b/modules/metastore/modules/metastore_search/src/ComplexData/Dataset.php index fb5cd6589c..0015e878e2 100644 --- a/modules/metastore/modules/metastore_search/src/ComplexData/Dataset.php +++ b/modules/metastore/modules/metastore_search/src/ComplexData/Dataset.php @@ -9,9 +9,15 @@ use Drupal\metastore_search\Facade\ComplexDataFacade; /** - * Dataset. + * Dataset facade for metastore search API facet. */ class Dataset extends ComplexDataFacade { + + /** + * Complex data object. + * + * @var object + */ private $data; /** @@ -20,7 +26,7 @@ class Dataset extends ComplexDataFacade { public static function definition() { $definitions = []; - /* @var \Drupal\metastore\SchemaRetriever $schemaRetriever */ + /** @var \Drupal\metastore\SchemaRetriever $schemaRetriever */ $schemaRetriever = \Drupal::service("dkan.metastore.schema_retriever"); $json = $schemaRetriever->retrieve("dataset"); $object = json_decode($json); diff --git a/modules/metastore/modules/metastore_search/src/Facade/ComplexDataFacade.php b/modules/metastore/modules/metastore_search/src/Facade/ComplexDataFacade.php index e8f34a0c48..a88ec1894f 100644 --- a/modules/metastore/modules/metastore_search/src/Facade/ComplexDataFacade.php +++ b/modules/metastore/modules/metastore_search/src/Facade/ComplexDataFacade.php @@ -6,11 +6,11 @@ use Drupal\Core\TypedData\TraversableTypedDataInterface; /** - * ComplexDataFacade. + * Base complex data facade class. * * @codeCoverageIgnore */ -class ComplexDataFacade implements \Iterator, ComplexDataInterface { +abstract class ComplexDataFacade implements \Iterator, ComplexDataInterface { /** * Inherited. diff --git a/modules/metastore/modules/metastore_search/src/FacetsCommonTrait.php b/modules/metastore/modules/metastore_search/src/FacetsCommonTrait.php index c038af42b0..0cb874b3fa 100644 --- a/modules/metastore/modules/metastore_search/src/FacetsCommonTrait.php +++ b/modules/metastore/modules/metastore_search/src/FacetsCommonTrait.php @@ -3,7 +3,7 @@ namespace Drupal\metastore_search; /** - * Trait FacetsCommonTrait. + * Trait for shared search api facet functionality. * * @package Drupal\metastore_search */ diff --git a/modules/metastore/modules/metastore_search/src/FacetsFromContentTrait.php b/modules/metastore/modules/metastore_search/src/FacetsFromContentTrait.php index c92de88faf..70a9e5c588 100644 --- a/modules/metastore/modules/metastore_search/src/FacetsFromContentTrait.php +++ b/modules/metastore/modules/metastore_search/src/FacetsFromContentTrait.php @@ -6,7 +6,7 @@ use RootedData\RootedJsonData; /** - * Trait FacetsFromContentTrait. + * Trait used to generate facets from search API query conditions. * * @package Drupal\metastore_search */ diff --git a/modules/metastore/modules/metastore_search/src/FacetsFromIndexTrait.php b/modules/metastore/modules/metastore_search/src/FacetsFromIndexTrait.php index cc6e0e66c2..3f9081d34d 100644 --- a/modules/metastore/modules/metastore_search/src/FacetsFromIndexTrait.php +++ b/modules/metastore/modules/metastore_search/src/FacetsFromIndexTrait.php @@ -6,7 +6,7 @@ use Drupal\search_api\Query\QueryInterface; /** - * Trait FacetsFromIndexTrait. + * Retrieves search API facets from search api indexes. * * @package Drupal\metastore_search */ diff --git a/modules/metastore/modules/metastore_search/src/Plugin/search_api/datasource/DkanDataset.php b/modules/metastore/modules/metastore_search/src/Plugin/search_api/datasource/DkanDataset.php index 21c5f2fe30..27835a97d8 100644 --- a/modules/metastore/modules/metastore_search/src/Plugin/search_api/datasource/DkanDataset.php +++ b/modules/metastore/modules/metastore_search/src/Plugin/search_api/datasource/DkanDataset.php @@ -64,9 +64,10 @@ public function getItemIds($page = NULL) { * @inheritdoc */ public function loadMultiple(array $ids) { - /* @var \Drupal\metastore\Storage\DataFactory $dataStorageFactory */ + /** @var \Drupal\metastore\Storage\DataFactory $dataStorageFactory */ $dataStorageFactory = \Drupal::service("dkan.metastore.storage"); - /* @var \Drupal\metastore\Storage\Data $dataStorage */ + + /** @var \Drupal\metastore\Storage\Data $dataStorage */ $dataStorage = $dataStorageFactory->getInstance('dataset'); $items = array_map(function ($id) use ($dataStorage) { diff --git a/modules/metastore/modules/metastore_search/src/QueryBuilderTrait.php b/modules/metastore/modules/metastore_search/src/QueryBuilderTrait.php index 3e65b20d50..5198fc7c53 100644 --- a/modules/metastore/modules/metastore_search/src/QueryBuilderTrait.php +++ b/modules/metastore/modules/metastore_search/src/QueryBuilderTrait.php @@ -9,7 +9,7 @@ use Drupal\search_api\Utility\QueryHelperInterface; /** - * Trait QueryBuilderTrait. + * Search API query builder trait. * * @package Drupal\metastore_search */ diff --git a/modules/metastore/src/Exception/AlreadyRegistered.php b/modules/metastore/src/Exception/AlreadyRegistered.php index 3c916bd83e..4fd7dafe66 100644 --- a/modules/metastore/src/Exception/AlreadyRegistered.php +++ b/modules/metastore/src/Exception/AlreadyRegistered.php @@ -3,7 +3,7 @@ namespace Drupal\metastore\Exception; /** - * Class AlreadyRegistered. + * Exception thrown when a resource is already registered. * * @package Drupal\metastore\Exception */ diff --git a/modules/metastore/src/Exception/CannotChangeUuidException.php b/modules/metastore/src/Exception/CannotChangeUuidException.php index 69498d755f..9a096f992e 100644 --- a/modules/metastore/src/Exception/CannotChangeUuidException.php +++ b/modules/metastore/src/Exception/CannotChangeUuidException.php @@ -3,7 +3,7 @@ namespace Drupal\metastore\Exception; /** - * Class CannotChangeUuidException. + * Exception thrown when unable to change UUID for a metastore item. * * @package Drupal\metastore\Exception */ diff --git a/modules/metastore/src/Exception/ExistingObjectException.php b/modules/metastore/src/Exception/ExistingObjectException.php index 6e41bff82e..1d59f0361d 100644 --- a/modules/metastore/src/Exception/ExistingObjectException.php +++ b/modules/metastore/src/Exception/ExistingObjectException.php @@ -3,7 +3,7 @@ namespace Drupal\metastore\Exception; /** - * Class ExistingObjectException. + * Exception thrown when metastore item already exists with a given identifier. * * @package Drupal\metastore\Exception */ diff --git a/modules/metastore/src/Exception/InvalidJsonException.php b/modules/metastore/src/Exception/InvalidJsonException.php index 35365ea608..08bc3e2004 100644 --- a/modules/metastore/src/Exception/InvalidJsonException.php +++ b/modules/metastore/src/Exception/InvalidJsonException.php @@ -3,7 +3,7 @@ namespace Drupal\metastore\Exception; /** - * Class InvalidJsonException. + * Exception thrown when metastore item JSON validation failed. * * @package Drupal\metastore\Exception */ diff --git a/modules/metastore/src/Exception/MissingObjectException.php b/modules/metastore/src/Exception/MissingObjectException.php index 0a15629bc9..47849d8605 100644 --- a/modules/metastore/src/Exception/MissingObjectException.php +++ b/modules/metastore/src/Exception/MissingObjectException.php @@ -3,7 +3,7 @@ namespace Drupal\metastore\Exception; /** - * Class MissingObjectException. + * Exception thrown when a metastore item could not be found for an identifier. * * @package Drupal\metastore\Exception */ diff --git a/modules/metastore/src/Exception/MissingPayloadException.php b/modules/metastore/src/Exception/MissingPayloadException.php index a0b8ed8a4e..d6f72a828c 100644 --- a/modules/metastore/src/Exception/MissingPayloadException.php +++ b/modules/metastore/src/Exception/MissingPayloadException.php @@ -3,7 +3,7 @@ namespace Drupal\metastore\Exception; /** - * Class MissingPayloadException. + * Exception thrown when a payload is missing from an HTTP request. * * @package Drupal\metastore\Exception */ diff --git a/modules/metastore/src/Exception/UnmodifiedObjectException.php b/modules/metastore/src/Exception/UnmodifiedObjectException.php index a386051f2a..724020e4d2 100644 --- a/modules/metastore/src/Exception/UnmodifiedObjectException.php +++ b/modules/metastore/src/Exception/UnmodifiedObjectException.php @@ -3,7 +3,7 @@ namespace Drupal\metastore\Exception; /** - * Class UnmodifiedObjectException. + * Exception thrown when an update request doesn't change a metastore item. * * @package Drupal\metastore\Exception */ diff --git a/modules/metastore/src/Form/DkanDataSettingsForm.php b/modules/metastore/src/Form/DkanDataSettingsForm.php index 897165625d..c221f0b6c6 100644 --- a/modules/metastore/src/Form/DkanDataSettingsForm.php +++ b/modules/metastore/src/Form/DkanDataSettingsForm.php @@ -9,7 +9,7 @@ use Symfony\Component\DependencyInjection\ContainerInterface; /** - * Class DkanDataSettingsForm. + * Metastore data settings form. * * @package Drupal\metastore\Form * @codeCoverageIgnore diff --git a/modules/metastore/src/Plugin/DkanApiDocs/MetastoreApiDocs.php b/modules/metastore/src/Plugin/DkanApiDocs/MetastoreApiDocs.php index f70a617e28..a37addea1b 100644 --- a/modules/metastore/src/Plugin/DkanApiDocs/MetastoreApiDocs.php +++ b/modules/metastore/src/Plugin/DkanApiDocs/MetastoreApiDocs.php @@ -214,7 +214,7 @@ private function schemaParameters($schemaId) { "{$schemaId}Uuid" => [ "name" => "identifier", "in" => "path", - "description" => t("A :schemaId identifier", [":schemaId" => $schemaId]), + "description" => $this->t("A :schemaId identifier", [":schemaId" => $schemaId]), "required" => TRUE, "schema" => ["type" => "string"], "example" => $this->getExampleIdentifier($schemaId) ?: "00000000-0000-0000-0000-000000000000", diff --git a/modules/metastore/src/Plugin/Validation/Constraint/ProperJsonValidator.php b/modules/metastore/src/Plugin/Validation/Constraint/ProperJsonValidator.php index 3b298ee80d..e1abc8c699 100644 --- a/modules/metastore/src/Plugin/Validation/Constraint/ProperJsonValidator.php +++ b/modules/metastore/src/Plugin/Validation/Constraint/ProperJsonValidator.php @@ -4,7 +4,6 @@ use Drupal\Core\DependencyInjection\ContainerInjectionInterface; use Drupal\metastore\ValidMetadataFactory; -use InvalidArgumentException; use OpisErrorPresenter\Implementation\MessageFormatterFactory; use OpisErrorPresenter\Implementation\PresentedValidationErrorFactory; use OpisErrorPresenter\Implementation\ValidationErrorPresenter; diff --git a/modules/metastore/src/Reference/OrphanChecker.php b/modules/metastore/src/Reference/OrphanChecker.php index 600ff50693..e3fb9f3f30 100644 --- a/modules/metastore/src/Reference/OrphanChecker.php +++ b/modules/metastore/src/Reference/OrphanChecker.php @@ -6,7 +6,7 @@ use Drupal\Core\Queue\QueueFactory; /** - * OrphanChecker. + * Checks for orphanned references in deleted datasets. */ class OrphanChecker { use HelperTrait; diff --git a/modules/metastore/src/Reference/Referencer.php b/modules/metastore/src/Reference/Referencer.php index c96ed56bee..7261d4be65 100644 --- a/modules/metastore/src/Reference/Referencer.php +++ b/modules/metastore/src/Reference/Referencer.php @@ -417,7 +417,8 @@ private function checkExistingReference(string $property_id, $data) { if ($node = reset($nodes)) { // If an existing but orphaned data node is found, // change the state back to published. - // @ToDo: if the referencing node is in a draft state, do not publish the referenced node. + // @todo if the referencing node is in a draft state, do not publish the + // referenced node. $node->set('moderation_state', 'published'); $node->save(); return $node->uuid(); diff --git a/modules/metastore/src/SchemaPropertiesHelper.php b/modules/metastore/src/SchemaPropertiesHelper.php index dee7c14c51..e1b19d76a3 100644 --- a/modules/metastore/src/SchemaPropertiesHelper.php +++ b/modules/metastore/src/SchemaPropertiesHelper.php @@ -6,7 +6,7 @@ use Symfony\Component\DependencyInjection\ContainerInterface; /** - * Class SchemaPropertiesHelper. + * Helper for metastore schema properties. * * @package Drupal\metastore */ diff --git a/modules/metastore/src/Storage/ResourceMapperDatabaseTable.php b/modules/metastore/src/Storage/ResourceMapperDatabaseTable.php index 5e030add0d..0c2d058d05 100644 --- a/modules/metastore/src/Storage/ResourceMapperDatabaseTable.php +++ b/modules/metastore/src/Storage/ResourceMapperDatabaseTable.php @@ -13,6 +13,11 @@ class ResourceMapperDatabaseTable extends AbstractDatabaseTable { use LoggerTrait; + /** + * Resource mapper database table schema. + * + * @var array + */ private $schema; /** diff --git a/modules/metastore/tests/src/Functional/OrphanCheckerTest.php b/modules/metastore/tests/src/Functional/OrphanCheckerTest.php index 7ebb8f3f83..e88ce3da07 100644 --- a/modules/metastore/tests/src/Functional/OrphanCheckerTest.php +++ b/modules/metastore/tests/src/Functional/OrphanCheckerTest.php @@ -38,7 +38,7 @@ public function setUp() { } public function test() { - /* @var $service \Drupal\metastore\Service */ + /** @var $service \Drupal\metastore\Service */ $service = \Drupal::service('dkan.metastore.service'); $dataset = $this->validMetadataFactory->get($this->getDataset(123, 'Test #1', ['district_centerpoints_small.csv']), 'dataset'); $service->post('dataset', $dataset); diff --git a/tests/src/Functional/DatasetTest.php b/tests/src/Functional/DatasetTest.php index adf164e3ef..8087c771a4 100644 --- a/tests/src/Functional/DatasetTest.php +++ b/tests/src/Functional/DatasetTest.php @@ -406,7 +406,7 @@ private function runQueues(array $relevantQueues = []) { } private function countTables() { - /* @var $db \Drupal\Core\Database\Connection */ + /** @var $db \Drupal\Core\Database\Connection */ $db = \Drupal::service('database'); $tables = $db->schema()->findTables("datastore_%"); @@ -431,7 +431,7 @@ private function checkFiles() { } private function queryResource(object $resource, string $queryString) { - /* @var $sqlEndpoint \Drupal\datastore\SqlEndpoint\Service */ + /** @var $sqlEndpoint \Drupal\datastore\SqlEndpoint\Service */ $sqlEndpoint = \Drupal::service('dkan.datastore.sql_endpoint.service'); $results = $sqlEndpoint->runQuery($queryString); $this->assertGreaterThan(0, count($results));