Fixed several warnings (#286)

* Fixed several warnings * Upgraded version
doofinder · Jul 6, 2023 · 4ceaac1 · 4ceaac1
1 parent f36169a
commit 4ceaac1
Show file tree

Hide file tree

Showing 67 changed files with 681 additions and 786 deletions.
diff --git a/Api/ChangedItemRepositoryInterface.php b/Api/ChangedItemRepositoryInterface.php
@@ -32,12 +32,16 @@ public function save(ChangedItemInterface $entity): ChangedItemInterface;
     public function get($value, ?string $field): ChangedItemInterface;
 
     /**
+     * Gets entity's list by search criteria
+     * 
      * @param SearchCriteriaInterface $searchCriteria
      * @return ChangedItemSearchResultsInterface
      */
     public function getList(SearchCriteriaInterface $searchCriteria): ChangedItemSearchResultsInterface;
 
     /**
+     * Determines whether this item exists or not
+     * 
      * @param ChangedItemInterface $changedItem
      * @return bool
      */

diff --git a/Api/Data/ChangedItemInterface.php b/Api/Data/ChangedItemInterface.php
@@ -11,28 +11,28 @@ interface ChangedItemInterface
      *
      * @var string CHANGED_ITEM_ID
      */
-    const CHANGED_ITEM_ID = 'entity_id';
+    public const CHANGED_ITEM_ID = 'entity_id';
 
     /**
      * Changed item trace row's identity field name.
      *
      * @var string CHANGED_ITEM_ID
      */
-    const ITEM_ID = 'item_id';
+    public const ITEM_ID = 'item_id';
 
     /**
      * Store view the change was issued on.
      *
      * @var string STORE_ID
      */
-    const STORE_ID = 'store_id';
+    public const STORE_ID = 'store_id';
 
     /**
-     * Item type.
+     * The type of item that represents inside the table.
      *
      * @var string ITEM_TYPE
      */
-    const ITEM_TYPE = 'item_type';
+    public const ITEM_TYPE = 'item_type';
 
     /**
      * Operation performed on Changed item field name.
@@ -41,28 +41,28 @@ interface ChangedItemInterface
      *
      * @var string OPERATION_TYPE
      */
-    const OPERATION_TYPE = 'operation_type';
+    public const OPERATION_TYPE = 'operation_type';
 
     /**
      * Tells that the item was updated in regular way.
      *
      * @var string OPERATION_TYPE_UPDATE
      */
-    const OPERATION_TYPE_UPDATE = 'update';
+    public const OPERATION_TYPE_UPDATE = 'update';
 
     /**
      * Tells that the item was deleted completely.
      *
      * @var string OPERATION_TYPE_DELETE
      */
-    const OPERATION_TYPE_DELETE = 'delete';
+    public const OPERATION_TYPE_DELETE = 'delete';
 
     /**
      * Tells that the item was created.
      *
      * @var string OPERATION_TYPE_CRATE
      */
-    const OPERATION_TYPE_CREATE = 'create';
+    public const OPERATION_TYPE_CREATE = 'create';
 
     /**
      * Get item id

diff --git a/Api/Data/ChangedItemSearchResultsInterface.php b/Api/Data/ChangedItemSearchResultsInterface.php
@@ -9,11 +9,15 @@
 interface ChangedItemSearchResultsInterface extends SearchResultsInterface
 {
     /**
+     * Obtains the resulting items from a search
+     * 
      * @return ChangedItemInterface[]
      */
     public function getItems();
 
     /**
+     * Sets the items inside the attribute
+     * 
      * @param ChangedItemInterface[] $items
      * @return void
      */

diff --git a/Api/Data/FetcherInterface.php b/Api/Data/FetcherInterface.php
@@ -7,19 +7,25 @@
 interface FetcherInterface
 {
     /**
+     * Processes the item's fetched result
+     * 
      * @param array $documents
      * @param integer $storeId
      * @return void
      */
     public function process(array $documents, int $storeId);
 
     /**
+     * Obtains the fetched result
+     * 
      * @param integer $productId
      * @return array
      */
     public function get(int $productId): array;
 
     /**
+     * Clears the fetched result
+     * 
      * @return void
      */
     public function clear();

diff --git a/Api/Data/Generator/MapInterface.php b/Api/Data/Generator/MapInterface.php
diff --git a/Api/Data/MapInterface.php b/Api/Data/MapInterface.php
diff --git a/Api/ModuleDataInterface.php b/Api/ModuleDataInterface.php
@@ -9,6 +9,7 @@ interface ModuleDataInterface
 {
     /**
      * Obtains the data from the Doofinder module. This data contains module's version, M2's version and the store structure.
+     * 
      * @return string
      */
     public function get();

diff --git a/ApiClient/Client.php b/ApiClient/Client.php
@@ -24,10 +24,10 @@
 class Client
 {
     /** Management API type */
-    const MANAGEMENT_API = 'api';
+    public const MANAGEMENT_API = 'api';
 
     /** Search API type */
-    const SEARCH_API = 'search';
+    public const SEARCH_API = 'search';
 
     /** @var StoreConfig */
     private $storeConfig;
@@ -70,8 +70,9 @@ public function __construct(
     }
 
     /**
+     * Request with GET verb
+     * 
      * @param string $path
-     *
      * @return string
      * @throws BadRequest
      * @throws IndexingInProgress
@@ -103,9 +104,10 @@ public function get(string $path): string
     }
 
     /**
+     * Request with POST verb
+     * 
      * @param string $path
      * @param array $body
-     *
      * @return string
      * @throws BadRequest
      * @throws IndexingInProgress
@@ -138,9 +140,10 @@ public function post(string $path, array $body): string
     }
 
     /**
+     * Request with PATCH verb
+     * 
      * @param string $path
      * @param array $body
-     *
      * @return string
      * @throws BadRequest
      * @throws IndexingInProgress
@@ -173,9 +176,10 @@ public function patch(string $path, array $body): string
     }
 
     /**
+     * Request with DELETE verb
+     * 
      * @param string $path
      * @param array $body
-     *
      * @return string
      * @throws BadRequest
      * @throws IndexingInProgress
@@ -194,7 +198,7 @@ public function delete(string $path, array $body): string
                 [
                     RequestOptions::VERIFY  => false,
                     RequestOptions::HEADERS => $this->getHeaders(),
-                    RequestOptions::JSON    => $this->flatten_array($body),
+                    RequestOptions::JSON    => $this->flattenArray($body),
                     RequestOptions::EXPECT  => '',
                 ]
             );
@@ -208,6 +212,8 @@ public function delete(string $path, array $body): string
     }
 
     /**
+     * Gets results handling errors
+     * 
      * @return string
      * @throws BadRequest
      * @throws IndexingInProgress
@@ -231,6 +237,8 @@ private function getResult(): string
     }
 
     /**
+     * Gets necessary headers for the requests
+     * 
      * @return string[]
      */
     private function getHeaders(): array
@@ -241,6 +249,8 @@ private function getHeaders(): array
     }
 
     /**
+     * Sets API token region in order to match the corresponding one
+     * 
      * @param string|null $apiKey
      * @throws InvalidApiKey
      */
@@ -278,10 +288,11 @@ private function parseErrorResponse(string $message): string
      * @param array $ids
      * @return array
      */
-    private function flatten_array(array $ids) {
-        $flattened_ids = array();
-        array_walk_recursive($ids, function($a) use (&$flattened_ids) {
-             $flattened_ids[] = $a; 
+    private function flattenArray(array $ids): array
+    {
+        $flattened_ids = [];
+        array_walk_recursive($ids, function($id) use (&$flattened_ids) {
+             $flattened_ids[] = $id;
         });
         return $flattened_ids;
     }

diff --git a/ApiClient/ManagementClient.php b/ApiClient/ManagementClient.php
@@ -15,12 +15,19 @@
 
 class ManagementClient
 {
-    const ENDPOINT_SEARCH_ENGINES = '/api/v2/search_engines';
-    const ENDPOINT_UPDATE_ON_SAVE = '/plugins/magento2';
+    private const ENDPOINT_SEARCH_ENGINES = '/api/v2/search_engines';
+    private const ENDPOINT_UPDATE_ON_SAVE = '/plugins/magento2';
 
     /** @var Client */
     private $client;
 
+    /**
+     * ManagementClient constructor.
+     *
+     * @param ClientFactory $clientFactory
+     * @param string $apiKey
+     * @param string $apiType
+     */
     public function __construct(
         ClientFactory $clientFactory,
         string $apiKey = null,
@@ -31,6 +38,7 @@ public function __construct(
 
     /**
      * Request all user's search engines throttled
+     * 
      * @see https://docs.doofinder.com/api/management/v2/#operation/search_engine_list
      *
      * @return array
@@ -51,6 +59,12 @@ public function listSearchEngines(): array
         return json_decode($response, true);
     }
 
+    /**
+     * Creates the store structure in Doofinder
+     * 
+     * @param array $storeData
+     * @return array
+     */
     public function createStore(array $storeData): array 
     {
         $response = $this->client->post('/plugins/create-store', $storeData);
@@ -60,6 +74,7 @@ public function createStore(array $storeData): array
 
     /**
      * Creates a new search engine with the provided data
+     * 
      * @see https://docs.doofinder.com/api/management/v2/#operation/search_engine_create
      *
      * @param array $searchEngine
@@ -83,6 +98,7 @@ public function createSearchEngine(array $searchEngine): array
 
     /**
      * Schedules a task for processing all search engine's data sources.
+     * 
      * @see https://docs.doofinder.com/api/management/v2/#operation/process
      *
      * @param string $hashId
@@ -108,7 +124,9 @@ public function processSearchEngine(string $hashId, string $callbackUrl = null):
 
     /**
      * Request a search engine details
+     * 
      * @see https://docs.doofinder.com/api/management/v2/#operation/search_engine_show
+     * 
      * @param string $hashId
      * @return array
      * @throws BadRequest
@@ -130,6 +148,7 @@ public function getSearchEngine(string $hashid): array
 
     /**
      * Creates a list of items from the index in a single bulk operation.
+     * 
      * @see https://docs.doofinder.com/api/management/v2/#operation/items_bulk_update
      *
      * @param array $items
@@ -155,6 +174,7 @@ public function createItemsInBulk(array $items, string $hashId, string $indice)
 
     /**
      * Updates a list of items from the index in a single bulk operation.
+     * 
      * @see https://docs.doofinder.com/api/management/v2/#operation/items_bulk_update
      *
      * @param array $items
@@ -179,6 +199,7 @@ public function updateItemsInBulk(array $items, string $hashId, string $indice)
 
     /**
      * Deletes a list of items from the index in a single bulk operation.
+     * 
      * @see https://docs.doofinder.com/api/management/v2/#operation/items_bulk_delete
      *
      * @param array $items

diff --git a/Block/Adminhtml/Form/Field/CustomAttributes.php b/Block/Adminhtml/Form/Field/CustomAttributes.php
@@ -69,5 +69,4 @@ public function getArrayRows()
         }
         return $result;
     }
-
 }