Rename AJAX handler.

demiankatz · Dec 18, 2024 · 9926c7d · 9926c7d
1 parent 7293036
commit 9926c7d
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 29 deletions.
diff --git a/...Find/src/VuFind/AjaxHandler/DoiLookup.php → ...ind/AjaxHandler/IdentifierLinksLookup.php b/...Find/src/VuFind/AjaxHandler/DoiLookup.php → ...ind/AjaxHandler/IdentifierLinksLookup.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * AJAX handler to look up DOI data.
+ * AJAX handler to look up identifier-based link data.
  *
  * PHP version 8
  *
@@ -36,15 +36,15 @@
 use function count;
 
 /**
- * AJAX handler to look up DOI data.
+ * AJAX handler to look up identifier-based link data.
  *
  * @category VuFind
  * @package  AJAX
  * @author   Demian Katz <[email protected]>
  * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
  * @link     https://vufind.org/wiki/development Wiki
  */
-class DoiLookup extends AbstractBase
+class IdentifierLinksLookup extends AbstractBase
 {
     /**
      * DOI Linker Plugin Manager

diff --git a/...c/VuFind/AjaxHandler/DoiLookupFactory.php → ...xHandler/IdentifierLinksLookupFactory.php b/...c/VuFind/AjaxHandler/DoiLookupFactory.php → ...xHandler/IdentifierLinksLookupFactory.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Factory for DoiLookup AJAX handler.
+ * Factory for IdentifierLinksLookup AJAX handler.
  *
  * PHP version 8
  *
@@ -35,15 +35,15 @@
 use Psr\Container\ContainerInterface;
 
 /**
- * Factory for DoiLookup AJAX handler.
+ * Factory for IdentifierLinksLookup AJAX handler.
  *
  * @category VuFind
  * @package  AJAX
  * @author   Demian Katz <[email protected]>
  * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
  * @link     https://vufind.org/wiki/development Wiki
  */
-class DoiLookupFactory implements \Laminas\ServiceManager\Factory\FactoryInterface
+class IdentifierLinksLookupFactory implements \Laminas\ServiceManager\Factory\FactoryInterface
 {
     /**
      * Create an object

diff --git a/module/VuFind/src/VuFind/AjaxHandler/PluginManager.php b/module/VuFind/src/VuFind/AjaxHandler/PluginManager.php
@@ -49,7 +49,7 @@ class PluginManager extends \VuFind\ServiceManager\AbstractPluginManager
         'checkRequestIsValid' => CheckRequestIsValid::class,
         'commentRecord' => CommentRecord::class,
         'deleteRecordComment' => DeleteRecordComment::class,
-        'doiLookup' => DoiLookup::class,
+        'identifierLinksLookup' => IdentifierLinksLookup::class,
         'getACSuggestions' => GetACSuggestions::class,
         'getIlsStatus' => GetIlsStatus::class,
         'getItemStatuses' => GetItemStatuses::class,
@@ -90,7 +90,7 @@ class PluginManager extends \VuFind\ServiceManager\AbstractPluginManager
         CheckRequestIsValid::class => AbstractIlsAndUserActionFactory::class,
         CommentRecord::class => CommentRecordFactory::class,
         DeleteRecordComment::class => DeleteRecordCommentFactory::class,
-        DoiLookup::class => DoiLookupFactory::class,
+        IdentifierLinksLookup::class => IdentifierLinksLookupFactory::class,
         GetACSuggestions::class => GetACSuggestionsFactory::class,
         GetIlsStatus::class => GetIlsStatusFactory::class,
         GetItemStatuses::class => GetItemStatusesFactory::class,

diff --git a/.../VuFindTest/AjaxHandler/DoiLookupTest.php → ...AjaxHandler/IdentifierLinksLookupTest.php b/.../VuFindTest/AjaxHandler/DoiLookupTest.php → ...AjaxHandler/IdentifierLinksLookupTest.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * DoiLookup test class.
+ * IdentifierLinksLookup test class.
  *
  * PHP version 8
  *
@@ -30,21 +30,21 @@
 namespace VuFindTest\AjaxHandler;
 
 use Laminas\View\Renderer\PhpRenderer;
-use VuFind\AjaxHandler\DoiLookup;
-use VuFind\AjaxHandler\DoiLookupFactory;
+use VuFind\AjaxHandler\IdentifierLinksLookup;
+use VuFind\AjaxHandler\IdentifierLinksLookupFactory;
 use VuFind\DoiLinker\DoiLinkerInterface;
 use VuFind\DoiLinker\PluginManager;
 
 /**
- * DoiLookup test class.
+ * IdentifierLinksLookup test class.
  *
  * @category VuFind
  * @package  Tests
  * @author   Demian Katz <[email protected]>
  * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
  * @link     https://vufind.org Main Page
  */
-class DoiLookupTest extends \VuFindTest\Unit\AjaxHandlerTestCase
+class IdentifierLinksLookupTest extends \VuFindTest\Unit\AjaxHandlerTestCase
 {
     use \VuFindTest\Feature\ConfigPluginManagerTrait;
 
@@ -83,19 +83,17 @@ protected function getMockPlugin(
             ->createMock(DoiLinkerInterface::class, ['getLinks']);
         $mockPlugin->expects($this->$times())->method('getLinks')
             ->with($this->equalTo($expected))
-            ->will(
-                $this->returnValue(
-                    [
-                        $doi => [
-                            [
-                                'link' => 'http://' . $value,
-                                'label' => $value,
-                                'icon' => 'remote-icon',
-                                'localIcon' => 'local-icon',
-                            ],
+            ->willReturn(
+                [
+                    $doi => [
+                        [
+                            'link' => 'http://' . $value,
+                            'label' => $value,
+                            'icon' => 'remote-icon',
+                            'localIcon' => 'local-icon',
                         ],
-                    ]
-                )
+                    ],
+                ]
             );
         return $mockPlugin;
     }
@@ -149,8 +147,8 @@ function ($plugin) use ($plugins) {
 
         $this->container->set('ViewRenderer', $mockRenderer);
 
-        $factory = new DoiLookupFactory();
-        $handler = $factory($this->container, DoiLookup::class);
+        $factory = new IdentifierLinksLookupFactory();
+        $handler = $factory($this->container, IdentifierLinksLookup::class);
         $params = $this->getParamsHelper(['doi' => $requested]);
         return $handler->handleRequest($params);
     }

diff --git a/themes/bootstrap3/js/identifierLinks.js b/themes/bootstrap3/js/identifierLinks.js
@@ -21,7 +21,7 @@ VuFind.register('identifierLinks', function identifierLinks() {
     if (Object.keys(postBody).length === 0) {
       return;
     }
-    queryParams.set("method", "doiLookup");
+    queryParams.set("method", "identifierLinksLookup");
     var url = VuFind.path + '/AJAX/JSON?' + queryParams.toString();
     fetch(url, { method: "POST", body: JSON.stringify(postBody) })
       .then(function embedIdentifierLinksDone(rawResponse) {

diff --git a/themes/bootstrap5/js/identifierLinks.js b/themes/bootstrap5/js/identifierLinks.js
@@ -21,7 +21,7 @@ VuFind.register('identifierLinks', function identifierLinks() {
     if (Object.keys(postBody).length === 0) {
       return;
     }
-    queryParams.set("method", "doiLookup");
+    queryParams.set("method", "identifierLinksLookup");
     var url = VuFind.path + '/AJAX/JSON?' + queryParams.toString();
     fetch(url, { method: "POST", body: JSON.stringify(postBody) })
       .then(function embedIdentifierLinksDone(rawResponse) {