Merge pull request #1494 from algolia/feature/MAGE-827

Feature/mage 827 - PHP connector v4

Author: cammonro

.gitignore

@@ -4,3 +4,4 @@ composer.lock
 vendor/
 .php_cs.cache
 .vscode
+.idea

Controller/Adminhtml/Landingpage/Delete.php

@@ -2,6 +2,7 @@
 
 namespace Algolia\AlgoliaSearch\Controller\Adminhtml\Landingpage;
 
+use Algolia\AlgoliaSearch\Model\LandingPage;
 use Magento\Framework\Controller\ResultFactory;
 
 class Delete extends AbstractAction
@@ -15,7 +16,7 @@ public function execute()
         $landingPageId = $this->getRequest()->getParam('id');
         if ($landingPageId) {
             try {
-                /** @var \Algolia\AlgoliaSearch\Model\LandingPage $landingPage */
+                /** @var LandingPage $landingPage */
                 $landingPage = $this->landingPageFactory->create();
                 $landingPage->getResource()->load($landingPage, $landingPageId);
                 $landingPage->getResource()->delete($landingPage);
@@ -35,7 +36,12 @@ public function execute()
         return $resultRedirect->setPath('*/*/');
     }
 
-    private function deleteQueryRules($landingPage)
+    /**
+     * @param LandingPage $landingPage
+     * @return void
+     * @throws \Magento\Framework\Exception\NoSuchEntityException
+     */
+    private function deleteQueryRules(LandingPage $landingPage): void
     {
         $stores = [];
         if ($landingPage->getStoreId() == 0) {

Controller/Adminhtml/Landingpage/Duplicate.php

@@ -2,6 +2,8 @@
 
 namespace Algolia\AlgoliaSearch\Controller\Adminhtml\Landingpage;
 
+use Algolia\AlgoliaSearch\Exceptions\AlgoliaException;
+use Algolia\AlgoliaSearch\Model\LandingPage;
 use Magento\Framework\Controller\ResultFactory;
 use Magento\Framework\Exception\LocalizedException;
 
@@ -20,7 +22,7 @@ public function execute()
             return $resultRedirect->setPath('*/*/');
         }
 
-        /** @var \Algolia\AlgoliaSearch\Model\LandingPage $landingPage */
+        /** @var LandingPage $landingPage */
         $landingPage = $this->landingPageFactory->create();
         $landingPage->getResource()->load($landingPage, $landingPageId);
 
@@ -53,9 +55,13 @@ public function execute()
         return $resultRedirect->setPath('*/*/');
     }
 
-    private function duplicateLandingPage($landingPage)
+    /**
+     * @param LandingPage $landingPage
+     * @return LandingPage
+     */
+    private function duplicateLandingPage(LandingPage $landingPage): LandingPage
     {
-        /** @var \Algolia\AlgoliaSearch\Model\LandingPage $newLandingPage */
+        /** @var LandingPage $newLandingPage */
         $newLandingPage = $this->landingPageFactory->create();
         $newLandingPage->setData($landingPage->getData());
         $newLandingPage->setId(null);
@@ -65,7 +71,13 @@ private function duplicateLandingPage($landingPage)
         return $newLandingPage;
     }
 
-    private function copyQueryRules($landingPageFromId, $landingPageToId)
+    /**
+     * @param int $landingPageFromId
+     * @param int $landingPageToId
+     * @return void
+     * @throws AlgoliaException|\Magento\Framework\Exception\NoSuchEntityException
+     */
+    private function copyQueryRules(int $landingPageFromId, int $landingPageToId): void
     {
         $stores = [];
         if ($landingPageFromId) {

Controller/Adminhtml/Landingpage/Save.php

@@ -154,11 +154,12 @@ public function execute()
     }
 
     /**
-     * @param $landingPageId
-     * @param $data
+     * @param int $landingPageId
+     * @param array<string, mixed> $data
      * @return void
+     * @throws \Magento\Framework\Exception\NoSuchEntityException
      */
-    protected function manageQueryRules($landingPageId, $data)
+    protected function manageQueryRules(int $landingPageId, array $data): void
     {
         $positions = json_decode($data['algolia_merchandising_positions'], true);
         $stores = [];

Controller/Adminhtml/Query/Delete.php

@@ -2,6 +2,7 @@
 
 namespace Algolia\AlgoliaSearch\Controller\Adminhtml\Query;
 
+use Algolia\AlgoliaSearch\Model\Query;
 use Magento\Framework\Controller\ResultFactory;
 
 class Delete extends AbstractAction
@@ -15,7 +16,7 @@ public function execute()
         $queryId = $this->getRequest()->getParam('id');
         if ($queryId) {
             try {
-                /** @var \Algolia\AlgoliaSearch\Model\Query $query */
+                /** @var Query $query */
                 $query = $this->queryFactory->create();
                 $query->getResource()->load($query, $queryId);
                 $query->getResource()->delete($query);
@@ -35,7 +36,12 @@ public function execute()
         return $resultRedirect->setPath('*/*/');
     }
 
-    private function deleteQueryRules($query)
+    /**
+     * @param Query $query
+     * @return void
+     * @throws \Magento\Framework\Exception\NoSuchEntityException
+     */
+    private function deleteQueryRules(Query $query): void
     {
         $stores = [];
         if ($query->getStoreId() == 0) {

Controller/Adminhtml/Query/Save.php

@@ -149,7 +149,13 @@ public function execute()
         return $resultRedirect->setPath('*/*/');
     }
 
-    private function manageQueryRules($queryId, $data)
+    /**
+     * @param int $queryId
+     * @param array<string, mixed> $data
+     * @return void
+     * @throws \Magento\Framework\Exception\NoSuchEntityException
+     */
+    private function manageQueryRules(int $queryId, array $data): void
     {
         $positions = json_decode($data['algolia_merchandising_positions'], true);
         $stores = [];

Helper/AdapterHelper.php

@@ -45,6 +45,7 @@ public function __construct(
      * Get search result from Algolia
      *
      * @return array
+     * @internal This method is currently unstable and should not be used. It may be revisited ar fixed in a future version.
      */
     public function getDocumentsFromAlgolia()
     {