PHP: docstring and lint Repository

Author: rldhont

lizmap/modules/lizmap/lib/Project/Repository.php

@@ -18,7 +18,9 @@
 class Repository
 {
     /**
-     * services properties.
+     * Repository properties.
+     *
+     * @var string[]
      */
     private static $properties = array(
         'label',
@@ -28,7 +30,11 @@ class Repository
     );
 
     /**
-     * services properties options.
+     * Repository properties options.
+     *
+     * @var array<string, array<string, bool|string>>
+     *
+     * @phpstan-var array<string, array{fieldType: string, required: bool}>
      */
     private static $propertiesOptions = array(
         'label' => array(
@@ -51,26 +57,38 @@ class Repository
 
     /**
      * Lizmap repository key.
+     *
+     * @var string
      */
     private $key = '';
 
     /**
      * Lizmap repository configuration data.
+     *
+     * @var array
      */
     private $data = array();
 
     /**
-     * @var Project[] list of projects. keys are projects names
+     * @var array<string, Project> list of projects instances. keys are projects names
      */
     protected $projectInstances = array();
 
     /**
      * The configuration files folder path.
+     *
+     * @var string
      */
     private $varPath = '';
 
+    /**
+     * @var \lizmapServices
+     */
     protected $services;
 
+    /**
+     * @var AppContextInterface
+     */
     protected $appContext;
 
     /**
@@ -103,7 +121,7 @@ public function __construct($key, $data, $varPath, $services, $appContext)
     /**
      * @return string the technical name of the repository
      */
-    public function getKey()
+    public function getKey(): string
     {
         return $this->key;
     }
@@ -113,7 +131,7 @@ public function getKey()
      *
      * @return string the repository label
      */
-    public function getLabel()
+    public function getLabel(): string
     {
         return $this->getData('label');
     }
@@ -123,7 +141,7 @@ public function getLabel()
      *
      * @return bool true if it is allowed
      */
-    public function allowUserDefinedThemes()
+    public function allowUserDefinedThemes(): bool
     {
         $value = $this->getData('allowUserDefinedThemes');
         if (empty($value)) {
@@ -147,7 +165,7 @@ public function allowUserDefinedThemes()
      *
      * @return string the value of the ACAO header. If empty, the header should not be set.
      */
-    public function getACAOHeaderValue($referer)
+    public function getACAOHeaderValue($referer): string
     {
         $origins = $this->getData('accessControlAllowOrigin');
         if (!$origins || $referer == '') {
@@ -173,6 +191,9 @@ public function getACAOHeaderValue($referer)
         return '';
     }
 
+    /**
+     * @var null|string the cleaned path of the repository, with a trailing slash
+     */
     protected $cleanedPath;
 
     /**
@@ -210,27 +231,48 @@ public function getPath()
         return $this->cleanedPath;
     }
 
-    public function getOriginalPath()
+    /**
+     * Get the original path.
+     */
+    public function getOriginalPath(): string
     {
         return $this->data['path'];
     }
 
+    /**
+     * Check if the repository has a valid path.
+     */
     public function hasValidPath(): bool
     {
         return $this->getPath() !== false;
     }
 
-    public static function getProperties()
+    /**
+     * Get the list of properties of a repository.
+     *
+     * @return string[]
+     */
+    public static function getProperties(): array
     {
         return self::$properties;
     }
 
-    public static function getRepoProperties()
+    /**
+     * Get theR repository properties options.
+     *
+     * @return array<string, array{fieldType: string, required: bool}>
+     */
+    public static function getRepoProperties(): array
     {
         return self::$propertiesOptions;
     }
 
-    public static function getPropertiesOptions()
+    /**
+     * Get theR repository properties options.
+     *
+     * @return array<string, array{fieldType: string, required: bool}>
+     */
+    public static function getPropertiesOptions(): array
     {
         return self::$propertiesOptions;
     }
@@ -259,7 +301,7 @@ public function getData($key)
      *
      * @return bool true if there is at least one valid data in $data
      */
-    public function update($data, $ini)
+    public function update($data, $ini): bool
     {
         // Set section
         $section = 'repository:'.$this->key;
@@ -291,6 +333,8 @@ public function update($data, $ini)
      * @param bool   $keepReference if we need to keep reference in the repository property projectInstances
      *
      * @return null|Project null if it does not exist
+     *
+     * @throws UnknownLizmapProjectException if the project does not exist
      */
     public function getProject($key, $keepReference = true)
     {
@@ -320,7 +364,7 @@ public function getProject($key, $keepReference = true)
      *
      * @return Project[]
      */
-    public function getProjects()
+    public function getProjects(): array
     {
         $projects = array();
         $dir = $this->getPath();
@@ -370,7 +414,7 @@ public function getProjects()
      *
      * @return ProjectMetadata[]
      */
-    public function getProjectsMetadata($checkAcl = true)
+    public function getProjectsMetadata($checkAcl = true): array
     {
         $data = array();
         $dir = $this->getPath();
@@ -422,7 +466,7 @@ public function getProjectsMetadata($checkAcl = true)
      *
      * @return ProjectMainData[]
      */
-    public function getProjectsMainData()
+    public function getProjectsMainData(): array
     {
         $data = array();
         $dir = $this->getPath();

tests/units/classes/Project/ProjectTest.php

@@ -93,7 +93,7 @@ public function testGetRelativeQgisPath($relative, $root, $file, $expectedPath):
             null
         );
         $proj = new ProjectForTests();
-        $proj->setRepo(new Project\Repository(null, array('path' => ''), null, null, null));
+        $proj->setRepo(new Project\Repository('key', array('path' => ''), null, null, null));
         $proj->setServices($services);
         $proj->setFile($file, 0, 0);
         $path = $proj->getRelativeQgisPath();
@@ -213,7 +213,7 @@ public function testHasEditionLayers($editionLayers, $acl, $unset, $expectedRet)
             $eLayers->{$key} = clone $obj;
         }
         $config = new Project\ProjectConfig((object) array('editionLayers' => $eLayers));
-        $rep = new Project\Repository(null, array(), null, null, null);
+        $rep = new Project\Repository('key', array(), null, null, null);
         $context = new ContextForTests();
         $context->setResult($acl);
         $proj = new ProjectForTests($context);