Visual Console Refactor: minor fixes

Former-commit-id: 2cacb9769708ccf4dce00d39300dfd510c0d1108

pandora_console/include/rest-api/models/VisualConsole/items/Group.php

@@ -5,33 +5,21 @@ declare(strict_types=1);
 namespace Models\VisualConsole\Items;
 use Models\VisualConsole\Item;
 
+/**
+ * Model of a group item of the Visual Console.
+ */
 final class Group extends Item
 {
 
 
     /**
-     * Validate the input data.
+     * Returns a valid representation of the model.
      *
-     * @param mixed $data
+     * @param array $data Input data.
      *
-     * @return void
+     * @return array Data structure representing the model.
      *
-     * @override
+     * @overrides Item::decode.
-     */
-    protected function validateData(array $data): void
-    {
-        parent::validateData($data);
-    }
-
-
-    /**
-     * Returns a valid data structure.
-     *
-     * @param mixed $data
-     *
-     * @return array
-     *
-     * @override
      */
     protected function decode(array $data): array
     {
@@ -44,41 +32,54 @@ final class Group extends Item
 
 
     /**
-     * extractBackgroundUrl
+     * Extract a image src value.
      *
-     * @param mixed $data
+     * @param array $data Unknown input data structure.
      *
-     * @return void
+     * @return mixed String representing the image url (not empty) or null.
+     *
+     * @throws \InvalidArgumentException When a valid image src can't be found.
      */
     private function extractImageSrc(array $data)
     {
-        $imageSrc = Model::notEmptyStringOr(
+        $imageSrc = static::notEmptyStringOr(
-            Model::issetInArray($data, ['imageSrc', 'image']),
+            static::issetInArray($data, ['imageSrc', 'image']),
             null
         );
-        if ($imageSrc === null) {
+
+        if ($imageSrc === null || \strlen($imageSrc) === 0) {
             throw new \InvalidArgumentException(
-                'the imageSrc property is required and should be string'
+                'the image src property is required and should be a non empty string'
             );
-        } else {
-            return $imageSrc;
         }
+
+        return $imageSrc;
     }
 
 
+    /**
+     * Extract a group Id value.
+     *
+     * @param array $data Unknown input data structure.
+     *
+     * @return integer Valid identifier of a group.
+     *
+     * @throws \InvalidArgumentException When a valid group Id can't be found.
+     */
     private function extractGroupId(array $data): int
     {
-        $groupId = Model::parseIntOr(
+        $groupId = static::parseIntOr(
-            Model::issetInArray($data, ['groupId', 'id_group']),
+            static::issetInArray($data, ['groupId', 'id_group']),
-            -1
+            null
         );
-        if ($groupId < 0) {
+
+        if ($groupId === null || $groupId < 0) {
             throw new \InvalidArgumentException(
                 'the group Id property is required and should be integer'
             );
-        } else {
-            return $groupId;
         }
+
+        return $groupId;
     }
 
 

pandora_console/include/rest-api/models/VisualConsole/items/Icon.php

@@ -5,33 +5,21 @@ declare(strict_types=1);
 namespace Models\VisualConsole\Items;
 use Models\VisualConsole\Item;
 
+/**
+ * Model of a group item of the Visual Console.
+ */
 final class Icon extends Item
 {
 
 
     /**
-     * Validate the input data.
+     * Returns a valid representation of the model.
      *
-     * @param mixed $data
+     * @param array $data Input data.
      *
-     * @return void
+     * @return array Data structure representing the model.
      *
-     * @override
+     * @overrides Item::decode.
-     */
-    protected function validateData(array $data): void
-    {
-        parent::validateData($data);
-    }
-
-
-    /**
-     * Returns a valid data structure.
-     *
-     * @param mixed $data
-     *
-     * @return array
-     *
-     * @override
      */
     protected function decode(array $data): array
     {
@@ -43,25 +31,28 @@ final class Icon extends Item
 
 
     /**
-     * extractBackgroundUrl
+     * Extract a image src value.
      *
-     * @param mixed $data
+     * @param array $data Unknown input data structure.
      *
-     * @return void
+     * @return mixed String representing the image url (not empty) or null.
+     *
+     * @throws \InvalidArgumentException When a valid image src can't be found.
      */
     private function extractImageSrc(array $data)
     {
-        $imageSrc = Model::notEmptyStringOr(
+        $imageSrc = static::notEmptyStringOr(
-            Model::issetInArray($data, ['imageSrc', 'image']),
+            static::issetInArray($data, ['imageSrc', 'image']),
             null
         );
-        if ($imageSrc === null) {
+
+        if ($imageSrc === null || \strlen($imageSrc) === 0) {
             throw new \InvalidArgumentException(
-                'the imageSrc property is required and should be string'
+                'the image src property is required and should be a non empty string'
             );
-        } else {
-            return $imageSrc;
         }
+
+        return $imageSrc;
     }