From 742437ca9ee75bee32fedb752d1963fdfb9982b6 Mon Sep 17 00:00:00 2001
From: Demian Katz <demian.katz@villanova.edu>
Date: Mon, 16 Feb 2015 09:27:07 -0500
Subject: [PATCH] Updated for PHP_CodeSniffer 2.2 compliance.
---
.../VuFind/src/VuFind/Auth/AbstractBase.php | 3 +++
.../Cache/Storage/Adapter/NoCacheAdapter.php | 13 +++++++------
.../src/VuFind/Config/PluginFactory.php | 2 ++
.../src/VuFind/Config/PluginManager.php | 1 +
.../src/VuFind/Content/Covers/Booksite.php | 1 +
.../src/VuFind/Content/Covers/Google.php | 1 +
.../src/VuFind/Content/Covers/OpenLibrary.php | 1 +
.../src/VuFind/Content/Reviews/Booksite.php | 1 +
.../src/VuFind/Content/Reviews/Guardian.php | 1 +
.../src/VuFind/Controller/AbstractBase.php | 1 +
module/VuFind/src/VuFind/Cover/Generator.php | 1 +
.../I18n/Translator/Loader/ExtendedIni.php | 1 +
module/VuFind/src/VuFind/ILS/Connection.php | 5 +++++
.../src/VuFind/ILS/Driver/AbstractBase.php | 1 +
module/VuFind/src/VuFind/ILS/Driver/Aleph.php | 4 ++++
.../VuFind/src/VuFind/ILS/Driver/Amicus.php | 3 +++
.../src/VuFind/ILS/Driver/ClaviusSQL.php | 5 +++++
module/VuFind/src/VuFind/ILS/Driver/DAIA.php | 1 +
module/VuFind/src/VuFind/ILS/Driver/Demo.php | 19 +++++++++++++++++++
.../src/VuFind/ILS/Driver/Evergreen.php | 3 +++
.../VuFind/src/VuFind/ILS/Driver/Horizon.php | 2 ++
.../src/VuFind/ILS/Driver/HorizonXMLAPI.php | 3 +++
.../src/VuFind/ILS/Driver/Innovative.php | 2 ++
module/VuFind/src/VuFind/ILS/Driver/Koha.php | 2 ++
module/VuFind/src/VuFind/ILS/Driver/LBS4.php | 5 +++++
.../src/VuFind/ILS/Driver/NewGenLib.php | 2 ++
module/VuFind/src/VuFind/ILS/Driver/NoILS.php | 4 ++++
module/VuFind/src/VuFind/ILS/Driver/PICA.php | 4 ++++
.../VuFind/src/VuFind/ILS/Driver/Polaris.php | 5 +++++
.../VuFind/src/VuFind/ILS/Driver/Sample.php | 5 +++++
.../VuFind/src/VuFind/ILS/Driver/Sierra.php | 2 ++
.../VuFind/src/VuFind/ILS/Driver/Symphony.php | 3 +++
.../VuFind/src/VuFind/ILS/Driver/Unicorn.php | 5 +++++
.../VuFind/src/VuFind/ILS/Driver/Virtua.php | 4 ++++
.../VuFind/src/VuFind/ILS/Driver/Voyager.php | 3 +++
.../src/VuFind/ILS/Driver/VoyagerRestful.php | 7 +++++++
.../VuFind/src/VuFind/ILS/Driver/XCNCIP2.php | 8 ++++++++
.../VuFind/src/VuFind/Recommend/DPLATerms.php | 1 +
module/VuFind/src/VuFind/RecordDriver/EDS.php | 1 +
.../VuFind/src/VuFind/RecordDriver/Primo.php | 1 +
.../src/VuFind/RecordDriver/SolrDefault.php | 1 +
.../VuFind/src/VuFind/Search/Base/Params.php | 2 ++
.../Search/Solr/DeduplicationListener.php | 1 +
.../ServiceManager/AbstractPluginFactory.php | 2 ++
.../ServiceManager/AbstractPluginManager.php | 1 +
.../src/VuFind/Session/AbstractBase.php | 2 ++
.../VuFind/Statistics/Driver/AbstractBase.php | 2 ++
module/VuFindConsole/Module.php | 1 +
module/VuFindLocalTemplate/Module.php | 2 ++
.../Backend/LibGuides/QueryBuilder.php | 1 +
.../VuFindSearch/Backend/Pazpar2/Backend.php | 1 +
.../Backend/Pazpar2/QueryBuilder.php | 1 +
.../VuFindTheme/InjectTemplateListener.php | 1 +
.../src/VuFindTheme/LessCompiler.php | 1 +
54 files changed, 150 insertions(+), 6 deletions(-)
diff --git a/module/VuFind/src/VuFind/Auth/AbstractBase.php b/module/VuFind/src/VuFind/Auth/AbstractBase.php
index f69bc00e914..81f0a6ceb44 100644
--- a/module/VuFind/src/VuFind/Auth/AbstractBase.php
+++ b/module/VuFind/src/VuFind/Auth/AbstractBase.php
@@ -155,6 +155,7 @@ abstract class AbstractBase implements \VuFind\Db\Table\DbTableAwareInterface,
*
* @throws AuthException
* @return User New user row.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function create($request)
@@ -172,6 +173,7 @@ abstract class AbstractBase implements \VuFind\Db\Table\DbTableAwareInterface,
*
* @throws AuthException
* @return User New user row.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function updatePassword($request)
@@ -189,6 +191,7 @@ abstract class AbstractBase implements \VuFind\Db\Table\DbTableAwareInterface,
* send user after login (some drivers may override this).
*
* @return bool|string
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getSessionInitiator($target)
diff --git a/module/VuFind/src/VuFind/Cache/Storage/Adapter/NoCacheAdapter.php b/module/VuFind/src/VuFind/Cache/Storage/Adapter/NoCacheAdapter.php
index 2b7ce70467c..c0d3b4e6329 100644
--- a/module/VuFind/src/VuFind/Cache/Storage/Adapter/NoCacheAdapter.php
+++ b/module/VuFind/src/VuFind/Cache/Storage/Adapter/NoCacheAdapter.php
@@ -38,6 +38,7 @@ use Zend\Cache\Storage\Adapter\AbstractAdapter;
* @author David Maus <maus@hab.de>
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
* @link http://www.vufind.org Main Page
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
class NoCacheAdapter extends AbstractAdapter
@@ -45,9 +46,9 @@ class NoCacheAdapter extends AbstractAdapter
/**
* Internal method to get an item.
*
- * @param string &$normalizedKey Normalized key
- * @param bool &$success Success indicator
- * @param mixed &$casToken CAS token
+ * @param string $normalizedKey Normalized key
+ * @param bool $success Success indicator
+ * @param mixed $casToken CAS token
*
* @return mixed Data on success, null on failure
*/
@@ -60,8 +61,8 @@ class NoCacheAdapter extends AbstractAdapter
/**
* Internal method to store an item.
*
- * @param string &$normalizedKey Normalized key
- * @param mixed &$value Cache item
+ * @param string $normalizedKey Normalized key
+ * @param mixed $value Cache item
*
* @return bool
*/
@@ -73,7 +74,7 @@ class NoCacheAdapter extends AbstractAdapter
/**
* Internal method to remove an item.
*
- * @param string &$normalizedKey Normalized key
+ * @param string $normalizedKey Normalized key
*
* @return bool
*/
diff --git a/module/VuFind/src/VuFind/Config/PluginFactory.php b/module/VuFind/src/VuFind/Config/PluginFactory.php
index 26ed7bd2f5f..193c8d6e2c8 100644
--- a/module/VuFind/src/VuFind/Config/PluginFactory.php
+++ b/module/VuFind/src/VuFind/Config/PluginFactory.php
@@ -137,6 +137,7 @@ class PluginFactory implements AbstractFactoryInterface
* @param string $requestedName Unfiltered name of service
*
* @return bool
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function canCreateServiceWithName(ServiceLocatorInterface $serviceLocator,
@@ -154,6 +155,7 @@ class PluginFactory implements AbstractFactoryInterface
* @param string $requestedName Unfiltered name of service
*
* @return object
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function createServiceWithName(ServiceLocatorInterface $serviceLocator,
diff --git a/module/VuFind/src/VuFind/Config/PluginManager.php b/module/VuFind/src/VuFind/Config/PluginManager.php
index 76eaa1c7c22..4269831bc7d 100644
--- a/module/VuFind/src/VuFind/Config/PluginManager.php
+++ b/module/VuFind/src/VuFind/Config/PluginManager.php
@@ -49,6 +49,7 @@ class PluginManager extends Base
*
* @throws ServiceManagerRuntimeException if invalid
* @return void
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function validatePlugin($plugin)
diff --git a/module/VuFind/src/VuFind/Content/Covers/Booksite.php b/module/VuFind/src/VuFind/Content/Covers/Booksite.php
index b176b41d8a7..7de2c1e4cee 100644
--- a/module/VuFind/src/VuFind/Content/Covers/Booksite.php
+++ b/module/VuFind/src/VuFind/Content/Covers/Booksite.php
@@ -74,6 +74,7 @@ class Booksite extends \VuFind\Content\AbstractCover
* pointing to an ISBN object and 'issn' pointing to a string)
*
* @return string|bool
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getUrl($key, $size, $ids)
diff --git a/module/VuFind/src/VuFind/Content/Covers/Google.php b/module/VuFind/src/VuFind/Content/Covers/Google.php
index 47c77110eb8..bafc794198a 100644
--- a/module/VuFind/src/VuFind/Content/Covers/Google.php
+++ b/module/VuFind/src/VuFind/Content/Covers/Google.php
@@ -73,6 +73,7 @@ class Google extends \VuFind\Content\AbstractCover
* pointing to an ISBN object and 'issn' pointing to a string)
*
* @return string|bool
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getUrl($key, $size, $ids)
diff --git a/module/VuFind/src/VuFind/Content/Covers/OpenLibrary.php b/module/VuFind/src/VuFind/Content/Covers/OpenLibrary.php
index 6c648447683..a3bfee0f615 100644
--- a/module/VuFind/src/VuFind/Content/Covers/OpenLibrary.php
+++ b/module/VuFind/src/VuFind/Content/Covers/OpenLibrary.php
@@ -55,6 +55,7 @@ class OpenLibrary extends \VuFind\Content\AbstractCover
* pointing to an ISBN object and 'issn' pointing to a string)
*
* @return string|bool
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getUrl($key, $size, $ids)
diff --git a/module/VuFind/src/VuFind/Content/Reviews/Booksite.php b/module/VuFind/src/VuFind/Content/Reviews/Booksite.php
index 49f009b8cc8..ce4baa8eb7e 100644
--- a/module/VuFind/src/VuFind/Content/Reviews/Booksite.php
+++ b/module/VuFind/src/VuFind/Content/Reviews/Booksite.php
@@ -75,6 +75,7 @@ class BookSite extends \VuFind\Content\AbstractBase
* @throws \Exception
* @return array Returns array with review data.
* @author Joe Atzberger
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function loadByIsbn($key, \VuFindCode\ISBN $isbnObj)
diff --git a/module/VuFind/src/VuFind/Content/Reviews/Guardian.php b/module/VuFind/src/VuFind/Content/Reviews/Guardian.php
index 39d918f4f66..3bc112b7861 100644
--- a/module/VuFind/src/VuFind/Content/Reviews/Guardian.php
+++ b/module/VuFind/src/VuFind/Content/Reviews/Guardian.php
@@ -50,6 +50,7 @@ class Guardian extends \VuFind\Content\AbstractBase
* @throws \Exception
* @return array Returns array with review data.
* @author Eoghan Ó Carragáin <eoghan.ocarragain@gmail.com>
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function loadByIsbn($key, \VuFindCode\ISBN $isbnObj)
diff --git a/module/VuFind/src/VuFind/Controller/AbstractBase.php b/module/VuFind/src/VuFind/Controller/AbstractBase.php
index f58b77e71fe..e10df80e08a 100644
--- a/module/VuFind/src/VuFind/Controller/AbstractBase.php
+++ b/module/VuFind/src/VuFind/Controller/AbstractBase.php
@@ -44,6 +44,7 @@ use VuFind\Exception\Forbidden as ForbiddenException,
* @author Chris Hallberg <challber@villanova.edu>
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
* @link http://vufind.org/wiki/vufind2:building_a_controller Wiki
+ *
* @SuppressWarnings(PHPMD.NumberOfChildren)
*/
class AbstractBase extends AbstractActionController
diff --git a/module/VuFind/src/VuFind/Cover/Generator.php b/module/VuFind/src/VuFind/Cover/Generator.php
index 8b326c04cbf..d03b02755e5 100644
--- a/module/VuFind/src/VuFind/Cover/Generator.php
+++ b/module/VuFind/src/VuFind/Cover/Generator.php
@@ -111,6 +111,7 @@ class Generator
* @param string $callnumber Callnumber of the book
*
* @return string contents of image file
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
protected function generateSolid($title, $author, $callnumber)
diff --git a/module/VuFind/src/VuFind/I18n/Translator/Loader/ExtendedIni.php b/module/VuFind/src/VuFind/I18n/Translator/Loader/ExtendedIni.php
index 78ea2fbcdf4..a6639dc8bfd 100644
--- a/module/VuFind/src/VuFind/I18n/Translator/Loader/ExtendedIni.php
+++ b/module/VuFind/src/VuFind/I18n/Translator/Loader/ExtendedIni.php
@@ -99,6 +99,7 @@ class ExtendedIni implements FileLoaderInterface
*
* @return TextDomain
* @throws InvalidArgumentException
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function load($locale, $filename)
diff --git a/module/VuFind/src/VuFind/ILS/Connection.php b/module/VuFind/src/VuFind/ILS/Connection.php
index 1fbdbd2476d..88a294a607d 100644
--- a/module/VuFind/src/VuFind/ILS/Connection.php
+++ b/module/VuFind/src/VuFind/ILS/Connection.php
@@ -292,6 +292,7 @@ class Connection implements TranslatorAwareInterface
* @return mixed On success, an associative array with specific function keys
* and values either for cancelling holds via a form or a URL;
* on failure, false.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
protected function checkMethodcancelHolds($functionConfig, $params)
@@ -326,6 +327,7 @@ class Connection implements TranslatorAwareInterface
*
* @return mixed On success, an associative array with specific function keys
* and values either for renewing items via a form or a URL; on failure, false.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
protected function checkMethodRenewals($functionConfig, $params)
@@ -400,6 +402,7 @@ class Connection implements TranslatorAwareInterface
* @return mixed On success, an associative array with specific function keys
* and values either for cancelling requests via a form or a URL;
* on failure, false.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
protected function checkMethodcancelStorageRetrievalRequests($functionConfig,
@@ -482,6 +485,7 @@ class Connection implements TranslatorAwareInterface
* @return mixed On success, an associative array with specific function keys
* and values either for cancelling requests via a form or a URL;
* on failure, false.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
protected function checkMethodcancelILLRequests($functionConfig, $params)
@@ -527,6 +531,7 @@ class Connection implements TranslatorAwareInterface
* @return mixed On success, an associative array with specific function keys
* and values either for cancelling requests via a form or a URL;
* on failure, false.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
protected function checkMethodchangePassword($functionConfig, $params)
diff --git a/module/VuFind/src/VuFind/ILS/Driver/AbstractBase.php b/module/VuFind/src/VuFind/ILS/Driver/AbstractBase.php
index 3417c0959a1..4d9c6ed7017 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/AbstractBase.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/AbstractBase.php
@@ -35,6 +35,7 @@ namespace VuFind\ILS\Driver;
* @author Andrew S. Nagy <vufind-tech@lists.sourceforge.net>
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
* @link http://vufind.org/wiki/vufind2:building_an_ils_driver Wiki
+ *
* @SuppressWarnings(PHPMD.NumberOfChildren)
*/
abstract class AbstractBase implements DriverInterface
diff --git a/module/VuFind/src/VuFind/ILS/Driver/Aleph.php b/module/VuFind/src/VuFind/ILS/Driver/Aleph.php
index 26f48d6ed4f..cd758064b56 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/Aleph.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/Aleph.php
@@ -1589,6 +1589,7 @@ class Aleph extends AbstractBase implements \Zend\Log\LoggerAwareInterface,
* @param array $params Optional feature-specific parameters (array)
*
* @return array An array with key-value pairs.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getConfig($func, $params = null)
@@ -1693,6 +1694,7 @@ class Aleph extends AbstractBase implements \Zend\Log\LoggerAwareInterface,
*
* @throws ILSException
* @return array An array with the acquisitions data on success.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getPurchaseHistory($id)
@@ -1718,6 +1720,7 @@ class Aleph extends AbstractBase implements \Zend\Log\LoggerAwareInterface,
*
* @throws ILSException
* @return array Associative array with 'count' and 'results' keys
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getNewItems($page, $limit, $daysOld, $fundId = null)
@@ -1780,6 +1783,7 @@ class Aleph extends AbstractBase implements \Zend\Log\LoggerAwareInterface,
*
* @throws ILSException
* @return array An array of associative arrays representing reserve items.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function findReserves($course, $inst, $dept)
diff --git a/module/VuFind/src/VuFind/ILS/Driver/Amicus.php b/module/VuFind/src/VuFind/ILS/Driver/Amicus.php
index bf88b22e419..0dce9f0b6fc 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/Amicus.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/Amicus.php
@@ -757,6 +757,7 @@ class Amicus extends AbstractBase implements TranslatorAwareInterface
* @param array $details Item details from getHoldings return array
*
* @return string URL to ILS's OPAC's place hold screen.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getHoldLink($recordId, $details)
@@ -781,6 +782,7 @@ class Amicus extends AbstractBase implements TranslatorAwareInterface
*
* @throws ILSException
* @return array Associative array with 'count' and 'results' keys
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getNewItems($page, $limit, $daysOld, $fundId = null)
@@ -874,6 +876,7 @@ class Amicus extends AbstractBase implements TranslatorAwareInterface
*
* @throws ILSException
* @return array An array of associative arrays representing reserve items.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function findReserves($course, $inst, $dept)
diff --git a/module/VuFind/src/VuFind/ILS/Driver/ClaviusSQL.php b/module/VuFind/src/VuFind/ILS/Driver/ClaviusSQL.php
index a51cdccbd86..9caed0de168 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/ClaviusSQL.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/ClaviusSQL.php
@@ -390,6 +390,7 @@ class ClaviusSQL extends AbstractBase
* @param array $details Item details from getHoldings return array
*
* @return string URL to ILS's OPAC's place hold screen.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getHoldLink($id, $details)
@@ -467,6 +468,7 @@ class ClaviusSQL extends AbstractBase
*
* @return array An array of associative arrays with locationID and
* locationDisplay keys
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getPickUpLocations($patron = false, $holdDetails = null)
@@ -512,6 +514,7 @@ class ClaviusSQL extends AbstractBase
* <li>title - The title of the item (optional - only used if the record
* cannot be found in VuFind's index).</li>
* </ul>
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getMyHolds($patron)
@@ -574,6 +577,7 @@ class ClaviusSQL extends AbstractBase
*
* @throws ILSException
* @return array An array with the acquisitions data on success.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getPurchaseHistory($id)
@@ -808,6 +812,7 @@ class ClaviusSQL extends AbstractBase
* <li>item_id - this is used to match up renew responses and must match
* the item_id in the renew response</li>
* </ul>
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getMyTransactions($user, $history = false)
diff --git a/module/VuFind/src/VuFind/ILS/Driver/DAIA.php b/module/VuFind/src/VuFind/ILS/Driver/DAIA.php
index 30542d607b9..55005c81a07 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/DAIA.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/DAIA.php
@@ -81,6 +81,7 @@ class DAIA extends AbstractBase implements \Zend\Log\LoggerAwareInterface
* @param array $details Item details from getHoldings return array
*
* @return string URL to ILS's OPAC's place hold screen.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getHoldLink($id, $details)
diff --git a/module/VuFind/src/VuFind/ILS/Driver/Demo.php b/module/VuFind/src/VuFind/ILS/Driver/Demo.php
index 03789f7e895..56331a390fe 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/Demo.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/Demo.php
@@ -620,6 +620,7 @@ class Demo extends AbstractBase
* @param array $patron The patron array from patronLogin
*
* @return mixed Array of the patron's fines on success.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getMyFines($patron)
@@ -671,6 +672,7 @@ class Demo extends AbstractBase
* @param array $patron The patron array from patronLogin
*
* @return mixed Array of the patron's holds on success.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getMyHolds($patron)
@@ -689,6 +691,7 @@ class Demo extends AbstractBase
* @param array $patron The patron array from patronLogin
*
* @return mixed Array of the patron's holds
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getMyStorageRetrievalRequests($patron)
@@ -708,6 +711,7 @@ class Demo extends AbstractBase
* @param array $patron The patron array from patronLogin
*
* @return mixed Array of the patron's ILL requests
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getMyILLRequests($patron)
@@ -728,6 +732,7 @@ class Demo extends AbstractBase
* @param array $patron The patron array from patronLogin
*
* @return mixed Array of the patron's transactions on success.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getMyTransactions($patron)
@@ -827,6 +832,7 @@ class Demo extends AbstractBase
*
* @return array An array of associative arrays with locationID and
* locationDisplay keys
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getPickUpLocations($patron = false, $holdDetails = null)
@@ -855,6 +861,7 @@ class Demo extends AbstractBase
* placeHold, minus the patron data.
*
* @return int
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getHoldDefaultRequiredDate($patron, $holdInfo)
@@ -877,6 +884,7 @@ class Demo extends AbstractBase
* or may be ignored.
*
* @return string A location ID
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getDefaultPickUpLocation($patron = false, $holdDetails = null)
@@ -898,6 +906,7 @@ class Demo extends AbstractBase
* options or may be ignored.
*
* @return false|string The default request group for the patron.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getDefaultRequestGroup($patron = false, $holdDetails = null)
@@ -918,6 +927,7 @@ class Demo extends AbstractBase
*
* @return array False if request groups not in use or an array of
* associative arrays with id and name keys
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getRequestGroups($bibId = null, $patron = null)
@@ -998,6 +1008,7 @@ class Demo extends AbstractBase
* whatever that may mean.
*
* @return array Associative array with 'count' and 'results' keys
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getNewItems($page, $limit, $daysOld, $fundId = null)
@@ -1031,6 +1042,7 @@ class Demo extends AbstractBase
* @param string $dept ID from getDepartments (empty string to match all)
*
* @return mixed An array of associative arrays representing reserve items.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function findReserves($course, $inst, $dept)
@@ -1271,6 +1283,7 @@ class Demo extends AbstractBase
* @param patron $patron An array of patron data
*
* @return bool True if request is valid, false if not
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function checkRequestIsValid($id, $data, $patron)
@@ -1371,6 +1384,7 @@ class Demo extends AbstractBase
* @param patron $patron An array of patron data
*
* @return bool True if request is valid, false if not
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function checkStorageRetrievalRequestIsValid($id, $data, $patron)
@@ -1469,6 +1483,7 @@ class Demo extends AbstractBase
* @param patron $patron An array of patron data
*
* @return bool True if request is valid, false if not
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function checkILLRequestIsValid($id, $data, $patron)
@@ -1587,6 +1602,7 @@ class Demo extends AbstractBase
*
* @return bool|array False if request not allowed, or an array of associative
* arrays with libraries.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getILLPickupLibraries($id, $patron)
@@ -1622,6 +1638,7 @@ class Demo extends AbstractBase
* @param array $patron Patron
*
* @return bool|array False if request not allowed, or an array of locations.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getILLPickupLocations($id, $pickupLib, $patron)
@@ -1728,6 +1745,7 @@ class Demo extends AbstractBase
*
* @return array An array of data on the request including
* whether or not it was successful and a system message (if available)
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function changePassword($details)
@@ -1750,6 +1768,7 @@ class Demo extends AbstractBase
* @param array $params Optional feature-specific parameters (array)
*
* @return array An array with key-value pairs.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getConfig($function, $params = null)
diff --git a/module/VuFind/src/VuFind/ILS/Driver/Evergreen.php b/module/VuFind/src/VuFind/ILS/Driver/Evergreen.php
index ca4e185fe1c..c672f4f7fc4 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/Evergreen.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/Evergreen.php
@@ -278,6 +278,7 @@ HERE;
*
* @throws ILSException
* @return array An array with the acquisitions data on success.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getPurchaseHistory($id)
@@ -633,6 +634,7 @@ HERE;
*
* @throws ILSException
* @return array Associative array with 'count' and 'results' keys
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getNewItems($page, $limit, $daysOld, $fundId = null)
@@ -795,6 +797,7 @@ HERE;
*
* @throws ILSException
* @return array An array of associative arrays representing reserve items.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function findReserves($course, $inst, $dept)
diff --git a/module/VuFind/src/VuFind/ILS/Driver/Horizon.php b/module/VuFind/src/VuFind/ILS/Driver/Horizon.php
index d78d63ede47..bd11517119a 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/Horizon.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/Horizon.php
@@ -270,6 +270,7 @@ class Horizon extends AbstractBase
* @param array $patron Patron Array
*
* @return array Keyed data
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
protected function processHoldingRow($id, $row, $patron)
@@ -991,6 +992,7 @@ class Horizon extends AbstractBase
* does not use acquisitions.
*
* @return array Associative array with 'count' and 'results' keys
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getNewItems($page, $limit, $daysOld, $fundId = null)
diff --git a/module/VuFind/src/VuFind/ILS/Driver/HorizonXMLAPI.php b/module/VuFind/src/VuFind/ILS/Driver/HorizonXMLAPI.php
index 04f55a62f67..19c40b630f7 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/HorizonXMLAPI.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/HorizonXMLAPI.php
@@ -80,6 +80,7 @@ class HorizonXMLAPI extends Horizon implements \VuFindHttp\HttpServiceAwareInter
* @param array $params Optional feature-specific parameters (array)
*
* @return array An array with key-value pairs.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getConfig($function, $params = null)
@@ -175,6 +176,7 @@ class HorizonXMLAPI extends Horizon implements \VuFindHttp\HttpServiceAwareInter
* @throws ILSException
* @return array An array of associative arrays with locationID and
* locationDisplay keys
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getPickUpLocations($patron, $holdDetails = null)
@@ -253,6 +255,7 @@ class HorizonXMLAPI extends Horizon implements \VuFindHttp\HttpServiceAwareInter
* or may be ignored.
*
* @return string The default pickup location for the patron.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getDefaultPickUpLocation($patron = false, $holdDetails = null)
diff --git a/module/VuFind/src/VuFind/ILS/Driver/Innovative.php b/module/VuFind/src/VuFind/ILS/Driver/Innovative.php
index 601128c11ad..a08fa53403c 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/Innovative.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/Innovative.php
@@ -290,6 +290,7 @@ class Innovative extends AbstractBase implements
*
* @throws ILSException
* @return array An array with the acquisitions data on success.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getPurchaseHistory($id)
@@ -309,6 +310,7 @@ class Innovative extends AbstractBase implements
* @param array $details Item details from getHoldings return array
*
* @return string URL to ILS's OPAC's place hold screen.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getHoldLink($id, $details)
diff --git a/module/VuFind/src/VuFind/ILS/Driver/Koha.php b/module/VuFind/src/VuFind/ILS/Driver/Koha.php
index 2ee6d6a9240..6f2d36aa602 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/Koha.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/Koha.php
@@ -216,6 +216,7 @@ class Koha extends AbstractBase
* @param array $details Item details from getHoldings return array
*
* @return string URL to ILS's OPAC's place hold screen.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getHoldLink($id, $details)
@@ -404,6 +405,7 @@ class Koha extends AbstractBase
*
* @throws ILSException
* @return array An array with the acquisitions data on success.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getPurchaseHistory($id)
diff --git a/module/VuFind/src/VuFind/ILS/Driver/LBS4.php b/module/VuFind/src/VuFind/ILS/Driver/LBS4.php
index 74d482517f5..b5fbbc27134 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/LBS4.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/LBS4.php
@@ -111,6 +111,7 @@ class LBS4 extends AbstractBase implements TranslatorAwareInterface
* @param array $params Optional feature-specific parameters (array)
*
* @return array An array with key-value pairs.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getConfig($function, $params = null)
@@ -218,6 +219,7 @@ class LBS4 extends AbstractBase implements TranslatorAwareInterface
* @return array On success, an associative array with the following
* keys: id, availability (boolean), status, location, reserve, callnumber,
* duedate, number, barcode.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getHolding($ppn, array $patron = null)
@@ -347,6 +349,7 @@ class LBS4 extends AbstractBase implements TranslatorAwareInterface
* @param array $callnumber The callnumber of the item
*
* @return string On success, a string to be displayed near the item
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
protected function getNote($loanind, $locid, $callnumber)
@@ -380,6 +383,7 @@ class LBS4 extends AbstractBase implements TranslatorAwareInterface
*
* @return string On success, a url string to be displayed as
* storage link.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
protected function getStorage($locid, $callnumber)
@@ -699,6 +703,7 @@ class LBS4 extends AbstractBase implements TranslatorAwareInterface
* @param string $id The record id to retrieve the info for
*
* @return mixed An array with the acquisitions data on success.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getPurchaseHistory($id)
diff --git a/module/VuFind/src/VuFind/ILS/Driver/NewGenLib.php b/module/VuFind/src/VuFind/ILS/Driver/NewGenLib.php
index 33b08413f88..6e84b92ea61 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/NewGenLib.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/NewGenLib.php
@@ -492,6 +492,7 @@ class NewGenLib extends AbstractBase
*
* @throws ILSException
* @return array Associative array with 'count' and 'results' keys
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getNewItems($page, $limit, $daysOld, $fundId = null)
@@ -533,6 +534,7 @@ class NewGenLib extends AbstractBase
*
* @throws ILSException
* @return array An array with the acquisitions data on success.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getPurchaseHistory($id)
diff --git a/module/VuFind/src/VuFind/ILS/Driver/NoILS.php b/module/VuFind/src/VuFind/ILS/Driver/NoILS.php
index 364c3f8ec1e..d4b96452e66 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/NoILS.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/NoILS.php
@@ -83,6 +83,7 @@ class NoILS extends AbstractBase implements TranslatorAwareInterface
* @param array $params Optional feature-specific parameters (array)
*
* @return array An array with key-value pairs.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getConfig($function, $params = null)
@@ -259,6 +260,7 @@ class NoILS extends AbstractBase implements TranslatorAwareInterface
* @param string $id The record id to retrieve the holdings for
*
* @return bool True if holdings exist, False if they do not
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function hasHoldings($id)
@@ -302,6 +304,7 @@ class NoILS extends AbstractBase implements TranslatorAwareInterface
* whatever that may mean.
*
* @return array Associative array with 'count' and 'results' keys
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getNewItems($page, $limit, $daysOld, $fundId = null)
@@ -347,6 +350,7 @@ class NoILS extends AbstractBase implements TranslatorAwareInterface
* @throws ILSException
* @return mixed Associative array of patron info on successful login,
* null on unsuccessful login.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function patronLogin($username, $password)
diff --git a/module/VuFind/src/VuFind/ILS/Driver/PICA.php b/module/VuFind/src/VuFind/ILS/Driver/PICA.php
index fc58073af5c..90b73b3e110 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/PICA.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/PICA.php
@@ -202,6 +202,7 @@ class PICA extends DAIA
* @throws \VuFind\Exception\Date
* @throws ILSException
* @return array Array of the patron's transactions on success.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getMyTransactions($patron)
@@ -376,6 +377,7 @@ class PICA extends DAIA
* @param string $recordId Record identifier
*
* @return bool True on success
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function renew($recordId)
@@ -411,6 +413,7 @@ class PICA extends DAIA
* @throws \VuFind\Exception\Date
* @throws ILSException
* @return mixed Array of the patron's fines on success.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getMyFines($patron)
@@ -477,6 +480,7 @@ class PICA extends DAIA
* @throws \VuFind\Exception\Date
* @throws ILSException
* @return array Array of the patron's holds on success.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getMyHolds($patron)
diff --git a/module/VuFind/src/VuFind/ILS/Driver/Polaris.php b/module/VuFind/src/VuFind/ILS/Driver/Polaris.php
index 4b1aae0f97f..b3d4a054fae 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/Polaris.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/Polaris.php
@@ -294,6 +294,7 @@ class Polaris extends AbstractBase implements \VuFindHttp\HttpServiceAwareInterf
* @param array $params Optional feature-specific parameters (array)
*
* @return array An array with key-value pairs.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getConfig($function, $params = null)
@@ -388,6 +389,7 @@ class Polaris extends AbstractBase implements \VuFindHttp\HttpServiceAwareInterf
* @throws ILSException
* @return array An array of associative arrays with locationID
* and locationDisplay keys
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getPickUpLocations($patron = false, $holdDetails = null)
@@ -427,6 +429,7 @@ class Polaris extends AbstractBase implements \VuFindHttp\HttpServiceAwareInterf
* or may be ignored.
*
* @return string The default pickup location for the patron.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getDefaultPickUpLocation($patron = false, $holdDetails = null)
@@ -465,6 +468,7 @@ class Polaris extends AbstractBase implements \VuFindHttp\HttpServiceAwareInterf
* whatever that may mean.
*
* @return array Associative array with 'count' and 'results' keys
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getNewItems($page, $limit, $daysOld, $fundId = null)
@@ -482,6 +486,7 @@ class Polaris extends AbstractBase implements \VuFindHttp\HttpServiceAwareInterf
* @param string $dept ID from getDepartments (empty string to match all)
*
* @return mixed An array of associative arrays representing reserve items.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function findReserves($course, $inst, $dept)
diff --git a/module/VuFind/src/VuFind/ILS/Driver/Sample.php b/module/VuFind/src/VuFind/ILS/Driver/Sample.php
index 77d6852b33d..87ebada9018 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/Sample.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/Sample.php
@@ -113,6 +113,7 @@ class Sample extends AbstractBase
* @return mixed On success, an associative array with the following keys:
* id, availability (boolean), status, location, reserve, callnumber, duedate,
* number, barcode.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getHolding($id, array $patron = null)
@@ -129,6 +130,7 @@ class Sample extends AbstractBase
* @param string $id The record id to retrieve the info for
*
* @return mixed An array with the acquisitions data on success.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getPurchaseHistory($id)
@@ -152,6 +154,7 @@ class Sample extends AbstractBase
* whatever that may mean.
*
* @return array Associative array with 'count' and 'results' keys
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getNewItems($page, $limit, $daysOld, $fundId = null)
@@ -169,6 +172,7 @@ class Sample extends AbstractBase
* @param string $dept ID from getDepartments (empty string to match all)
*
* @return mixed An array of associative arrays representing reserve items.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function findReserves($course, $inst, $dept)
@@ -186,6 +190,7 @@ class Sample extends AbstractBase
*
* @return mixed Associative array of patron info on successful login,
* null on unsuccessful login.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function patronLogin($username, $password)
diff --git a/module/VuFind/src/VuFind/ILS/Driver/Sierra.php b/module/VuFind/src/VuFind/ILS/Driver/Sierra.php
index dd7e71c0a14..2ee624ccb66 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/Sierra.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/Sierra.php
@@ -276,6 +276,7 @@ class Sierra extends AbstractBase
*
* @throws ILSException
* @return array An array of associative arrays representing reserve items.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function findReserves($course, $instructor, $department)
@@ -588,6 +589,7 @@ class Sierra extends AbstractBase
*
* @throws ILSException
* @return array An array with the acquisitions data on success.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getPurchaseHistory($id)
diff --git a/module/VuFind/src/VuFind/ILS/Driver/Symphony.php b/module/VuFind/src/VuFind/ILS/Driver/Symphony.php
index dd846936a1f..90ab240ffbb 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/Symphony.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/Symphony.php
@@ -1443,6 +1443,7 @@ class Symphony extends AbstractBase
* @param array $params Optional feature-specific parameters (array)
*
* @return array An array with key-value pairs.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getConfig($function, $params = null)
@@ -1646,6 +1647,7 @@ class Symphony extends AbstractBase
*
* @return array An array of associative arrays with locationID and
* locationDisplay keys
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getPickUpLocations($patron = false, $holdDetails = null)
@@ -1675,6 +1677,7 @@ class Symphony extends AbstractBase
* or may be ignored.
*
* @return string The default pickup location for the patron.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getDefaultPickUpLocation($patron = false, $holdDetails = null)
diff --git a/module/VuFind/src/VuFind/ILS/Driver/Unicorn.php b/module/VuFind/src/VuFind/ILS/Driver/Unicorn.php
index 7cb278b9bea..5243c93c61b 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/Unicorn.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/Unicorn.php
@@ -128,6 +128,7 @@ class Unicorn extends AbstractBase implements \VuFindHttp\HttpServiceAwareInterf
* @param array $params Optional feature-specific parameters (array)
*
* @return array An array with key-value pairs.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getConfig($function, $params = null)
@@ -157,6 +158,7 @@ class Unicorn extends AbstractBase implements \VuFindHttp\HttpServiceAwareInterf
* @throws ILSException
* @return array An array of associative arrays with locationID and
* locationDisplay keys
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getPickUpLocations($patron = false, $holdDetails = null)
@@ -190,6 +192,7 @@ class Unicorn extends AbstractBase implements \VuFindHttp\HttpServiceAwareInterf
* or may be ignored.
*
* @return string The default pickup location for the patron.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getDefaultPickUpLocation($patron = false, $holdDetails = null)
@@ -374,6 +377,7 @@ class Unicorn extends AbstractBase implements \VuFindHttp\HttpServiceAwareInterf
*
* @throws ILSException
* @return array An array with the acquisitions data on success.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getPurchaseHistory($id)
@@ -983,6 +987,7 @@ class Unicorn extends AbstractBase implements \VuFindHttp\HttpServiceAwareInterf
*
* @throws ILSException
* @return array Associative array with 'count' and 'results' keys
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getNewItems($page, $limit, $daysOld, $fundId = null)
diff --git a/module/VuFind/src/VuFind/ILS/Driver/Virtua.php b/module/VuFind/src/VuFind/ILS/Driver/Virtua.php
index 3c04c0b274c..d47b9597762 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/Virtua.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/Virtua.php
@@ -1407,6 +1407,7 @@ class Virtua extends AbstractBase implements \VuFindHttp\HttpServiceAwareInterfa
*
* @throws ILSException
* @return array An array of associative arrays representing reserve items.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function findReserves($course, $inst = false, $dept = false)
@@ -1611,6 +1612,7 @@ class Virtua extends AbstractBase implements \VuFindHttp\HttpServiceAwareInterfa
* @param array $holdDetails An array of item data
*
* @return string Data for use in a form field
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getCancelHoldDetails($holdDetails)
@@ -1628,6 +1630,7 @@ class Virtua extends AbstractBase implements \VuFindHttp\HttpServiceAwareInterfa
*
* @return array An array of data on each request including
* whether or not it was successful and a system message (if available)
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function cancelHolds($cancelDetails)
@@ -1731,6 +1734,7 @@ class Virtua extends AbstractBase implements \VuFindHttp\HttpServiceAwareInterfa
* @param array $checkOutDetails An array of item data
*
* @return string Data for use in a form field
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getRenewDetails($checkOutDetails)
diff --git a/module/VuFind/src/VuFind/ILS/Driver/Voyager.php b/module/VuFind/src/VuFind/ILS/Driver/Voyager.php
index 69ef017add9..939b9d0f250 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/Voyager.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/Voyager.php
@@ -982,6 +982,7 @@ class Voyager extends AbstractBase
* @throws DateException
* @throws ILSException
* @return array Keyed data
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
protected function processHoldingData($data, $id, $patron = false)
@@ -1304,6 +1305,7 @@ class Voyager extends AbstractBase
*
* @throws DateException
* @return array Keyed data for display by template files
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
protected function processMyTransactionsData($sqlRow, $patron = false)
@@ -1921,6 +1923,7 @@ class Voyager extends AbstractBase
* @param array $details Item details from getHoldings return array
*
* @return string URL to ILS's OPAC's place hold screen.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getHoldLink($recordId, $details)
diff --git a/module/VuFind/src/VuFind/ILS/Driver/VoyagerRestful.php b/module/VuFind/src/VuFind/ILS/Driver/VoyagerRestful.php
index 952b2141e83..fc9a215742e 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/VoyagerRestful.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/VoyagerRestful.php
@@ -308,6 +308,7 @@ class VoyagerRestful extends Voyager implements \VuFindHttp\HttpServiceAwareInte
* @param array $params Optional feature-specific parameters (array)
*
* @return array An array with key-value pairs.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getConfig($function, $params = null)
@@ -451,6 +452,7 @@ class VoyagerRestful extends Voyager implements \VuFindHttp\HttpServiceAwareInte
* @param array $holdingsRow The holdings row to analyze.
*
* @return bool Whether an item is holdable
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
protected function isILLRequestAllowed($holdingsRow)
@@ -709,6 +711,7 @@ class VoyagerRestful extends Voyager implements \VuFindHttp\HttpServiceAwareInte
* @throws ILSException
* @return array An array of associative arrays with locationID and
* locationDisplay keys
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getPickUpLocations($patron = false, $holdDetails = null)
@@ -777,6 +780,7 @@ class VoyagerRestful extends Voyager implements \VuFindHttp\HttpServiceAwareInte
*
* @return false|string The default pickup location for the patron or false
* if the user has to choose.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getDefaultPickUpLocation($patron = false, $holdDetails = null)
@@ -798,6 +802,7 @@ class VoyagerRestful extends Voyager implements \VuFindHttp\HttpServiceAwareInte
*
* @return false|string The default request group for the patron or false if
* the user has to choose.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getDefaultRequestGroup($patron = false, $holdDetails = null)
@@ -2776,6 +2781,7 @@ EOT;
*
* @return bool|array False if request not allowed, or an array of
* locations.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getILLPickupLocations($id, $pickupLib, $patron)
@@ -3210,6 +3216,7 @@ EOT;
*
* @return bool True if the method can be called with the given parameters,
* false otherwise.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function supportsMethod($method, $params)
diff --git a/module/VuFind/src/VuFind/ILS/Driver/XCNCIP2.php b/module/VuFind/src/VuFind/ILS/Driver/XCNCIP2.php
index 02d44c2acc5..ef2842f8f56 100644
--- a/module/VuFind/src/VuFind/ILS/Driver/XCNCIP2.php
+++ b/module/VuFind/src/VuFind/ILS/Driver/XCNCIP2.php
@@ -485,6 +485,7 @@ class XCNCIP2 extends AbstractBase implements \VuFindHttp\HttpServiceAwareInterf
* @return array On success, an associative array with the following
* keys: id, availability (boolean), status, location, reserve, callnumber,
* duedate, number, barcode.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getConsortialHoldings($id, array $patron = null,
@@ -582,6 +583,7 @@ class XCNCIP2 extends AbstractBase implements \VuFindHttp\HttpServiceAwareInterf
*
* @throws ILSException
* @return array An array with the acquisitions data on success.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getPurchaseHistory($id)
@@ -890,6 +892,7 @@ class XCNCIP2 extends AbstractBase implements \VuFindHttp\HttpServiceAwareInterf
*
* @throws ILSException
* @return array Associative array with 'count' and 'results' keys
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getNewItems($page, $limit, $daysOld, $fundId = null)
@@ -965,6 +968,7 @@ class XCNCIP2 extends AbstractBase implements \VuFindHttp\HttpServiceAwareInterf
*
* @throws ILSException
* @return array An array of associative arrays representing reserve items.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function findReserves($course, $inst, $dept)
@@ -993,6 +997,7 @@ class XCNCIP2 extends AbstractBase implements \VuFindHttp\HttpServiceAwareInterf
* @param array $params Optional feature-specific parameters (array)
*
* @return array An array with key-value pairs.
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getConfig($function, $params = null)
@@ -1030,6 +1035,7 @@ class XCNCIP2 extends AbstractBase implements \VuFindHttp\HttpServiceAwareInterf
* or may be ignored.
*
* @return string A location ID
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getDefaultPickUpLocation($patron, $holdDetails = null)
@@ -1053,6 +1059,7 @@ class XCNCIP2 extends AbstractBase implements \VuFindHttp\HttpServiceAwareInterf
*
* @return array An array of associative arrays with locationID and
* locationDisplay keys
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getPickUpLocations($patron, $holdDetails = null)
@@ -1139,6 +1146,7 @@ class XCNCIP2 extends AbstractBase implements \VuFindHttp\HttpServiceAwareInterf
* @param patron $patron An array of patron data
*
* @return bool True if request is valid, false if not
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function checkStorageRetrievalRequestIsValid($id, $data, $patron)
diff --git a/module/VuFind/src/VuFind/Recommend/DPLATerms.php b/module/VuFind/src/VuFind/Recommend/DPLATerms.php
index 94d309e6d4c..3cd2002a2fd 100644
--- a/module/VuFind/src/VuFind/Recommend/DPLATerms.php
+++ b/module/VuFind/src/VuFind/Recommend/DPLATerms.php
@@ -131,6 +131,7 @@ class DPLATerms implements RecommendInterface
* request.
*
* @return void
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function init($params, $request)
diff --git a/module/VuFind/src/VuFind/RecordDriver/EDS.php b/module/VuFind/src/VuFind/RecordDriver/EDS.php
index 7b98ac75d64..f6565aaf0bc 100644
--- a/module/VuFind/src/VuFind/RecordDriver/EDS.php
+++ b/module/VuFind/src/VuFind/RecordDriver/EDS.php
@@ -561,6 +561,7 @@ class EDS extends SolrDefault
* @param string $format Export format
*
* @return bool
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function exportDisabled($format)
diff --git a/module/VuFind/src/VuFind/RecordDriver/Primo.php b/module/VuFind/src/VuFind/RecordDriver/Primo.php
index 8e5d9e9baab..8d96ed41207 100644
--- a/module/VuFind/src/VuFind/RecordDriver/Primo.php
+++ b/module/VuFind/src/VuFind/RecordDriver/Primo.php
@@ -298,6 +298,7 @@ class Primo extends SolrDefault
* @param string $format Export format
*
* @return bool
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function exportDisabled($format)
diff --git a/module/VuFind/src/VuFind/RecordDriver/SolrDefault.php b/module/VuFind/src/VuFind/RecordDriver/SolrDefault.php
index fa4a88e37fd..3e131a11c56 100644
--- a/module/VuFind/src/VuFind/RecordDriver/SolrDefault.php
+++ b/module/VuFind/src/VuFind/RecordDriver/SolrDefault.php
@@ -40,6 +40,7 @@ use VuFindCode\ISBN, VuFind\View\Helper\Root\RecordLink;
* @author Demian Katz <demian.katz@villanova.edu>
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
* @link http://vufind.org/wiki/vufind2:record_drivers Wiki
+ *
* @SuppressWarnings(PHPMD.ExcessivePublicCount)
*/
class SolrDefault extends AbstractBase
diff --git a/module/VuFind/src/VuFind/Search/Base/Params.php b/module/VuFind/src/VuFind/Search/Base/Params.php
index 16660a41608..6c6e5449b41 100644
--- a/module/VuFind/src/VuFind/Search/Base/Params.php
+++ b/module/VuFind/src/VuFind/Search/Base/Params.php
@@ -1583,6 +1583,7 @@ class Params implements ServiceLocatorAwareInterface
* will be favored.
*
* @return void
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function activateAllFacets($preferredSection = false)
@@ -1602,6 +1603,7 @@ class Params implements ServiceLocatorAwareInterface
* @param array $ids Record IDs to load
*
* @return void
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function setQueryIDs($ids)
diff --git a/module/VuFind/src/VuFind/Search/Solr/DeduplicationListener.php b/module/VuFind/src/VuFind/Search/Solr/DeduplicationListener.php
index 17c0fa93815..0719788af5b 100644
--- a/module/VuFind/src/VuFind/Search/Solr/DeduplicationListener.php
+++ b/module/VuFind/src/VuFind/Search/Solr/DeduplicationListener.php
@@ -284,6 +284,7 @@ class DeduplicationListener
* @param array $sourcePriority Array of source priorities keyed by source id
*
* @return array Local record data
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
protected function appendDedupRecordFields($localRecordData, $dedupRecordData,
diff --git a/module/VuFind/src/VuFind/ServiceManager/AbstractPluginFactory.php b/module/VuFind/src/VuFind/ServiceManager/AbstractPluginFactory.php
index 26e4f322b4a..50de04035ff 100644
--- a/module/VuFind/src/VuFind/ServiceManager/AbstractPluginFactory.php
+++ b/module/VuFind/src/VuFind/ServiceManager/AbstractPluginFactory.php
@@ -86,6 +86,7 @@ abstract class AbstractPluginFactory implements AbstractFactoryInterface
* @param string $requestedName Unfiltered name of service
*
* @return bool
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function canCreateServiceWithName(ServiceLocatorInterface $serviceLocator,
@@ -103,6 +104,7 @@ abstract class AbstractPluginFactory implements AbstractFactoryInterface
* @param string $requestedName Unfiltered name of service
*
* @return object
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function createServiceWithName(ServiceLocatorInterface $serviceLocator,
diff --git a/module/VuFind/src/VuFind/ServiceManager/AbstractPluginManager.php b/module/VuFind/src/VuFind/ServiceManager/AbstractPluginManager.php
index 3fdda41e3d7..ddd053993c2 100644
--- a/module/VuFind/src/VuFind/ServiceManager/AbstractPluginManager.php
+++ b/module/VuFind/src/VuFind/ServiceManager/AbstractPluginManager.php
@@ -38,6 +38,7 @@ use Zend\ServiceManager\AbstractPluginManager as Base,
* @author Demian Katz <demian.katz@villanova.edu>
* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License
* @link http://vufind.org/wiki/vufind2:developer_manual Wiki
+ *
* @SuppressWarnings(PHPMD.NumberOfChildren)
*/
abstract class AbstractPluginManager extends Base
diff --git a/module/VuFind/src/VuFind/Session/AbstractBase.php b/module/VuFind/src/VuFind/Session/AbstractBase.php
index 9603b4c7796..4ddfe1a2e06 100644
--- a/module/VuFind/src/VuFind/Session/AbstractBase.php
+++ b/module/VuFind/src/VuFind/Session/AbstractBase.php
@@ -82,6 +82,7 @@ abstract class AbstractBase implements SaveHandlerInterface,
* @param string $sess_name Session name
*
* @return void
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function open($sess_path, $sess_name)
@@ -125,6 +126,7 @@ abstract class AbstractBase implements SaveHandlerInterface,
* @param int $sess_maxlifetime Maximum session lifetime.
*
* @return void
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function gc($sess_maxlifetime)
diff --git a/module/VuFind/src/VuFind/Statistics/Driver/AbstractBase.php b/module/VuFind/src/VuFind/Statistics/Driver/AbstractBase.php
index 741460a8268..ab2a80ecd7b 100644
--- a/module/VuFind/src/VuFind/Statistics/Driver/AbstractBase.php
+++ b/module/VuFind/src/VuFind/Statistics/Driver/AbstractBase.php
@@ -84,6 +84,7 @@ abstract class AbstractBase
* @param array $value Extra options for search. Value => match this value
*
* @return array
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getFullList($field, $value = array())
@@ -99,6 +100,7 @@ abstract class AbstractBase
* @param integer $limit How many items to return
*
* @return array
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getBrowserStats($version, $limit)
diff --git a/module/VuFindConsole/Module.php b/module/VuFindConsole/Module.php
index f5178b8345c..1c8db1608c4 100644
--- a/module/VuFindConsole/Module.php
+++ b/module/VuFindConsole/Module.php
@@ -71,6 +71,7 @@ class Module implements \Zend\ModuleManager\Feature\ConsoleUsageProviderInterfac
* @param Console $console Console adapter
*
* @return array
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function getConsoleUsage(Console $console)
diff --git a/module/VuFindLocalTemplate/Module.php b/module/VuFindLocalTemplate/Module.php
index 171fc98cdca..521a8ad247a 100644
--- a/module/VuFindLocalTemplate/Module.php
+++ b/module/VuFindLocalTemplate/Module.php
@@ -72,6 +72,7 @@ class Module
* @param ModuleManager $m Module manager
*
* @return void
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function init(ModuleManager $m)
@@ -84,6 +85,7 @@ class Module
* @param MvcEvent $e Event
*
* @return void
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
public function onBootstrap(MvcEvent $e)
diff --git a/module/VuFindSearch/src/VuFindSearch/Backend/LibGuides/QueryBuilder.php b/module/VuFindSearch/src/VuFindSearch/Backend/LibGuides/QueryBuilder.php
index 3b2b396c033..cbddd890636 100644
--- a/module/VuFindSearch/src/VuFindSearch/Backend/LibGuides/QueryBuilder.php
+++ b/module/VuFindSearch/src/VuFindSearch/Backend/LibGuides/QueryBuilder.php
@@ -96,6 +96,7 @@ class QueryBuilder
* @param QueryGroup $query QueryGroup to convert
*
* @return array
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
protected function queryGroupToArray(QueryGroup $query)
diff --git a/module/VuFindSearch/src/VuFindSearch/Backend/Pazpar2/Backend.php b/module/VuFindSearch/src/VuFindSearch/Backend/Pazpar2/Backend.php
index 781213ce569..3ec251ad187 100644
--- a/module/VuFindSearch/src/VuFindSearch/Backend/Pazpar2/Backend.php
+++ b/module/VuFindSearch/src/VuFindSearch/Backend/Pazpar2/Backend.php
@@ -246,6 +246,7 @@ class Backend extends AbstractBackend
* @param int $offset Search offset
*
* @return RecordCollectionInterface
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
protected function createRecordCollection($records, $total = 0, $offset = 0)
diff --git a/module/VuFindSearch/src/VuFindSearch/Backend/Pazpar2/QueryBuilder.php b/module/VuFindSearch/src/VuFindSearch/Backend/Pazpar2/QueryBuilder.php
index 68424a25a81..1d80f0b22d6 100644
--- a/module/VuFindSearch/src/VuFindSearch/Backend/Pazpar2/QueryBuilder.php
+++ b/module/VuFindSearch/src/VuFindSearch/Backend/Pazpar2/QueryBuilder.php
@@ -100,6 +100,7 @@ class QueryBuilder
* @param QueryGroup $query QueryGroup to convert
*
* @return string
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
protected function queryGroupToString(QueryGroup $query)
diff --git a/module/VuFindTheme/src/VuFindTheme/InjectTemplateListener.php b/module/VuFindTheme/src/VuFindTheme/InjectTemplateListener.php
index b2ccc29ac45..8244ad7dec3 100644
--- a/module/VuFindTheme/src/VuFindTheme/InjectTemplateListener.php
+++ b/module/VuFindTheme/src/VuFindTheme/InjectTemplateListener.php
@@ -59,6 +59,7 @@ class InjectTemplateListener extends \Zend\Mvc\View\Http\InjectTemplateListener
* @param string $controller Controller name
*
* @return string
+ *
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
*/
protected function deriveModuleNamespace($controller)
diff --git a/module/VuFindTheme/src/VuFindTheme/LessCompiler.php b/module/VuFindTheme/src/VuFindTheme/LessCompiler.php
index 72f485fe407..9697eec78ad 100644
--- a/module/VuFindTheme/src/VuFindTheme/LessCompiler.php
+++ b/module/VuFindTheme/src/VuFindTheme/LessCompiler.php
@@ -227,6 +227,7 @@ class LessCompiler
* @param string $less Relative LESS filename
*
* @return string
+ *
* @SuppressWarnings(PHPMD.UnusedLocalVariable)
*/
protected function makeRelative($css, $less)
--
GitLab