Add doc types on classes under GLpi namepsace

Author: trasher

src/Glpi/Api/API.php

@@ -93,21 +93,35 @@
 abstract class API
 {
     // permit writing to $_SESSION
+    /** @var bool  */
     protected $session_write = false;
+    /** @var string  */
 
     public static $api_url = "";
+    /** @var string  */
     public static $content_type = "application/json";
+    /** @var string  */
     protected $format          = "json";
+    /** @var string  */
     protected $iptxt           = "";
+    /** @var string  */
     protected $ipnum           = "";
+    /** @var array  */
     protected $app_tokens      = [];
+    /** @var int  */
     protected $apiclients_id   = 0;
+    /** @var ?DeprecatedInterface  */
     protected $deprecated_item = null;
+    /** @var string */
     protected $request_uri;
+    /** @var array */
     protected $url_elements;
+    /** @var string */
     protected $verb;
+    /** @var array */
     protected $parameters;
-    protected $debug           = 0;
+    /** @var bool */
+    protected $debug = false;
 
     /**
      * @param integer $nb Unused value

src/Glpi/Api/APIRest.php

@@ -150,7 +150,7 @@ public function call()
         if (isset($this->parameters['debug'])) {
             $this->debug = $this->parameters['debug'];
             if (empty($this->debug)) {
-                $this->debug = 1;
+                $this->debug = true;
             }
         }
 

src/Glpi/Api/HL/Controller/AssetController.php

@@ -1528,7 +1528,7 @@ public function index(Request $request): Response
         return new JSONResponse($asset_paths);
     }
 
-    private static function getGlobalAssetSchema($asset_schemas)
+    private static function getGlobalAssetSchema(array $asset_schemas): array
     {
         $asset_types = self::getAssetTypes();
         $asset_schemas = array_filter($asset_schemas, static fn($key) => !str_starts_with($key, '_') && in_array($key, $asset_types, true), ARRAY_FILTER_USE_KEY);

src/Glpi/Api/HL/GraphQLGenerator.php

@@ -35,9 +35,12 @@
 
 namespace Glpi\Api\HL;
 
+use Closure;
 use Glpi\Api\HL\Doc as Doc;
 use Glpi\Debug\Profiler;
+use GraphQL\Type\Definition\ListOfType;
 use GraphQL\Type\Definition\ObjectType;
+use GraphQL\Type\Definition\ScalarType;
 use GraphQL\Type\Definition\Type;
 use Throwable;
 
@@ -57,6 +60,9 @@ private function normalizeTypeName(string $type_name): string
         return str_replace([' ', '-'], ['', '_'], $type_name);
     }
 
+    /**
+     * @return string
+     */
     public function getSchema()
     {
         Profiler::getInstance()->start('GraphQLGenerator::loadTypes', Profiler::CATEGORY_HLAPI);
@@ -87,7 +93,7 @@ public function getSchema()
         return $schema_str;
     }
 
-    private function writeType($type_name, ObjectType|callable $type): string
+    private function writeType(string $type_name, ObjectType|callable $type): string
     {
         $type_name = $this->normalizeTypeName($type_name);
         $type_str = "type $type_name {\n";
@@ -118,7 +124,7 @@ private function writeType($type_name, ObjectType|callable $type): string
         return $type_str;
     }
 
-    private function loadTypes()
+    private function loadTypes(): void
     {
         $component_schemas = OpenAPIGenerator::getComponentSchemas($this->api_version);
         foreach ($component_schemas as $schema_name => $schema) {
@@ -173,6 +179,13 @@ private function convertRESTSchemaToGraphQLSchema(string $schema_name, array $sc
         ]);
     }
 
+    /**
+     * @param array $property
+     * @param string|null $name
+     * @param string $prefix
+     *
+     * @return Closure|ListOfType|ObjectType|ScalarType|void
+     */
     private function convertRESTPropertyToGraphQLType(array $property, ?string $name = null, string $prefix = '')
     {
         $type = $property['type'] ?? 'string';

src/Glpi/Api/HL/RoutePath.php

@@ -224,6 +224,11 @@ public function getAttributesFromPath(string $path): array
         return $attributes;
     }
 
+    /**
+     * @param string $path
+     *
+     * @return bool
+     */
     public function isValidPath($path): bool
     {
         // Ensure no placeholders are left
@@ -368,13 +373,13 @@ public function matchesAPIVersion(string $api_version): bool
         );
     }
 
-    private function setPath(string $path)
+    private function setPath(string $path): void
     {
         $this->path = $path;
         $this->route->path = $path;
     }
 
-    private function setPriority(int $priority)
+    private function setPriority(int $priority): void
     {
         $this->priority = $priority;
         $this->route->priority = $priority;

src/Glpi/Application/Environment.php

@@ -69,6 +69,9 @@ public static function isSet(): bool
         return defined('GLPI_ENVIRONMENT_TYPE');
     }
 
+    /**
+     * @return array
+     */
     public static function getValues()
     {
         $values = [];

src/Glpi/Application/View/Extension/DocumentExtension.php

@@ -49,7 +49,7 @@ class DocumentExtension extends AbstractExtension
     /**
      * Static cache for user defined files extensions icons.
      */
-    private static $extensionIcon = null;
+    private static ?array $extensionIcon = null;
 
     public function getFilters(): array
     {

src/Glpi/Application/View/Extension/PluginExtension.php

@@ -96,6 +96,14 @@ public function callPluginHookFunction(string $name, $params = null, bool $retur
         }
     }
 
+    /**
+     * @param string $plugin
+     * @param string $name
+     * @param array $params
+     * @param bool $return_result
+     *
+     * @return mixed|void
+     */
     public function callPluginOneHook(string $plugin, string $name, $params = null, bool $return_result = false)
     {
         $result = Plugin::doOneHook($plugin, $name, $params);

src/Glpi/Application/View/Extension/TeamExtension.php

@@ -35,6 +35,7 @@
 
 namespace Glpi\Application\View\Extension;
 
+use CommonDBTM;
 use Glpi\Features\TeamworkInterface;
 use Twig\Extension\AbstractExtension;
 use Twig\TwigFilter;
@@ -51,6 +52,13 @@ public function getFilters(): array
         ];
     }
 
+    /**
+     * @param class-string<CommonDBTM> $itemtype
+     * @param int $role
+     * @param int $nb
+     *
+     * @return string
+     */
     public function getTeamRoleName($itemtype, int $role, int $nb = 1): string
     {
         if (is_a($itemtype, TeamworkInterface::class, true)) {

src/Glpi/Cache/I18nCache.php

@@ -44,23 +44,39 @@
  */
 class I18nCache
 {
-    private $cache;
+    private CacheInterface $cache;
 
     public function __construct(CacheInterface $cache)
     {
         $this->cache = $cache;
     }
 
+    /**
+     * @param string $key
+     *
+     * @return mixed
+     */
     public function getItem($key)
     {
         return $this->cache->get($key);
     }
 
+    /**
+     * @param string $key
+     * @param mixed $value
+     *
+     * @return bool
+     */
     public function setItem($key, $value)
     {
         return $this->cache->set($key, $value);
     }
 
+    /**
+     * @param string $key
+     *
+     * @return bool
+     */
     public function removeItem($key)
     {
         return $this->cache->delete($key);