From aeb70dc9fe7f900996044d082c3619c81d606ce1 Mon Sep 17 00:00:00 2001 From: Demian Katz <demian.katz@villanova.edu> Date: Thu, 19 Oct 2017 13:42:10 -0400 Subject: [PATCH] Style: add blank lines between methods. --- module/VuFind/src/VuFind/Auth/CAS.php | 1 + module/VuFind/src/VuFind/Auth/Manager.php | 1 + .../Feed/Writer/Extension/OpenSearch/Feed.php | 1 + .../Hierarchy/Driver/ConfigurationBased.php | 1 + .../src/VuFind/ILS/Driver/ClaviusSQL.php | 1 + module/VuFind/src/VuFind/ILS/Driver/PAIA.php | 2 ++ .../VuFind/src/VuFind/ILS/Driver/Polaris.php | 1 + .../src/VuFind/ILS/Driver/VoyagerRestful.php | 1 + .../src/VuFind/RecordDriver/BrowZine.php | 1 + .../VuFind/src/VuFind/RecordDriver/Summon.php | 1 + .../VuFind/src/VuFind/Search/EDS/Options.php | 1 + .../Root/RecordDataFormatter/SpecBuilder.php | 1 + .../ILS/Driver/MultiBackendTest.php | 22 +++++++++++++++++++ .../src/VuFindTest/ILS/Driver/PAIATest.php | 1 + .../Recommend/FavoriteFacetsTest.php | 1 + .../Controller/GenerateController.php | 1 + .../Backend/Solr/LuceneSyntaxHelper.php | 1 + .../Backend/Solr/SearchHandlerTest.php | 1 + 18 files changed, 40 insertions(+) diff --git a/module/VuFind/src/VuFind/Auth/CAS.php b/module/VuFind/src/VuFind/Auth/CAS.php index 9dfaee40480..05193f232ef 100644 --- a/module/VuFind/src/VuFind/Auth/CAS.php +++ b/module/VuFind/src/VuFind/Auth/CAS.php @@ -265,6 +265,7 @@ class CAS extends AbstractBase return $sortedUserAttributes; } + /** * Establishes phpCAS Configuration and Enables the phpCAS Client * diff --git a/module/VuFind/src/VuFind/Auth/Manager.php b/module/VuFind/src/VuFind/Auth/Manager.php index 6cdb99db33a..7da0bd7bbe3 100644 --- a/module/VuFind/src/VuFind/Auth/Manager.php +++ b/module/VuFind/src/VuFind/Auth/Manager.php @@ -615,6 +615,7 @@ class Manager implements \ZfcRbac\Identity\IdentityProviderInterface ); } } + /** * Validate the credentials in the provided request, but do not change the state * of the current logged-in user. Return true for valid credentials, false diff --git a/module/VuFind/src/VuFind/Feed/Writer/Extension/OpenSearch/Feed.php b/module/VuFind/src/VuFind/Feed/Writer/Extension/OpenSearch/Feed.php index 3b996ae3f90..d11634e6aea 100644 --- a/module/VuFind/src/VuFind/Feed/Writer/Extension/OpenSearch/Feed.php +++ b/module/VuFind/src/VuFind/Feed/Writer/Extension/OpenSearch/Feed.php @@ -118,6 +118,7 @@ class Feed extends ParentFeed $this->encoding = $enc; return $this; } + /** * Get feed encoding * diff --git a/module/VuFind/src/VuFind/Hierarchy/Driver/ConfigurationBased.php b/module/VuFind/src/VuFind/Hierarchy/Driver/ConfigurationBased.php index e2415e17e52..e0b5e67ecd7 100644 --- a/module/VuFind/src/VuFind/Hierarchy/Driver/ConfigurationBased.php +++ b/module/VuFind/src/VuFind/Hierarchy/Driver/ConfigurationBased.php @@ -124,6 +124,7 @@ class ConfigurationBased extends AbstractBase return isset($this->config->HierarchyTree) ? $this->config->HierarchyTree->toArray() : []; } + /** * Get Collection Link Type from the config file * diff --git a/module/VuFind/src/VuFind/ILS/Driver/ClaviusSQL.php b/module/VuFind/src/VuFind/ILS/Driver/ClaviusSQL.php index e6b19691152..66dd32e2f39 100644 --- a/module/VuFind/src/VuFind/ILS/Driver/ClaviusSQL.php +++ b/module/VuFind/src/VuFind/ILS/Driver/ClaviusSQL.php @@ -170,6 +170,7 @@ class ClaviusSQL extends AbstractBase } return $this->locations; } + /** * Get list of fine types * diff --git a/module/VuFind/src/VuFind/ILS/Driver/PAIA.php b/module/VuFind/src/VuFind/ILS/Driver/PAIA.php index 47b050f678d..69ae5d34564 100644 --- a/module/VuFind/src/VuFind/ILS/Driver/PAIA.php +++ b/module/VuFind/src/VuFind/ILS/Driver/PAIA.php @@ -476,6 +476,7 @@ class PAIA extends DAIA // Not yet implemented return false; } + /** * Place ILL Request * @@ -1342,6 +1343,7 @@ class PAIA extends DAIA } return $results; } + /** * This PAIA helper function allows custom overrides for mapping of PAIA response * to getMyStorageRetrievalRequests data structure. diff --git a/module/VuFind/src/VuFind/ILS/Driver/Polaris.php b/module/VuFind/src/VuFind/ILS/Driver/Polaris.php index 658f92c9767..b497a05572a 100644 --- a/module/VuFind/src/VuFind/ILS/Driver/Polaris.php +++ b/module/VuFind/src/VuFind/ILS/Driver/Polaris.php @@ -629,6 +629,7 @@ class Polaris extends AbstractBase implements \VuFindHttp\HttpServiceAwareInterf return $fineList; } + /** * Get Patron Profile * diff --git a/module/VuFind/src/VuFind/ILS/Driver/VoyagerRestful.php b/module/VuFind/src/VuFind/ILS/Driver/VoyagerRestful.php index c77c6681365..b8929134c89 100644 --- a/module/VuFind/src/VuFind/ILS/Driver/VoyagerRestful.php +++ b/module/VuFind/src/VuFind/ILS/Driver/VoyagerRestful.php @@ -1254,6 +1254,7 @@ EOT; * * @return array An array of renewal information keyed by item ID */ + /** * Renew My Items * diff --git a/module/VuFind/src/VuFind/RecordDriver/BrowZine.php b/module/VuFind/src/VuFind/RecordDriver/BrowZine.php index de1d6b4483b..01750fd008e 100644 --- a/module/VuFind/src/VuFind/RecordDriver/BrowZine.php +++ b/module/VuFind/src/VuFind/RecordDriver/BrowZine.php @@ -69,6 +69,7 @@ class BrowZine extends SolrDefault ? $this->fields['name'] : parent::getTitle(); } + /** * Returns one of three things: a full URL to a thumbnail preview of the record * if an image is available in an external system; an array of parameters to diff --git a/module/VuFind/src/VuFind/RecordDriver/Summon.php b/module/VuFind/src/VuFind/RecordDriver/Summon.php index 553475b4550..3805cba5e94 100644 --- a/module/VuFind/src/VuFind/RecordDriver/Summon.php +++ b/module/VuFind/src/VuFind/RecordDriver/Summon.php @@ -526,6 +526,7 @@ class Summon extends SolrDefault { return $this->fields['ID'][0]; } + /** * Get the title of the item that contains this record (i.e. MARC 773s of a * journal). diff --git a/module/VuFind/src/VuFind/Search/EDS/Options.php b/module/VuFind/src/VuFind/Search/EDS/Options.php index e2ed9d87841..031c09d6059 100644 --- a/module/VuFind/src/VuFind/Search/EDS/Options.php +++ b/module/VuFind/src/VuFind/Search/EDS/Options.php @@ -221,6 +221,7 @@ class Options extends \VuFind\Search\Base\Options { return $this->defaultExpanders; } + /** * Return the route name of the action used for performing advanced searches. * Returns false if the feature is not supported. diff --git a/module/VuFind/src/VuFind/View/Helper/Root/RecordDataFormatter/SpecBuilder.php b/module/VuFind/src/VuFind/View/Helper/Root/RecordDataFormatter/SpecBuilder.php index dd8a4f91cb2..44f5ae37efa 100644 --- a/module/VuFind/src/VuFind/View/Helper/Root/RecordDataFormatter/SpecBuilder.php +++ b/module/VuFind/src/VuFind/View/Helper/Root/RecordDataFormatter/SpecBuilder.php @@ -66,6 +66,7 @@ class SpecBuilder } } } + /** * Set a generic spec line. * diff --git a/module/VuFind/tests/unit-tests/src/VuFindTest/ILS/Driver/MultiBackendTest.php b/module/VuFind/tests/unit-tests/src/VuFindTest/ILS/Driver/MultiBackendTest.php index 44a8efa80a7..483a25cd1c0 100644 --- a/module/VuFind/tests/unit-tests/src/VuFindTest/ILS/Driver/MultiBackendTest.php +++ b/module/VuFind/tests/unit-tests/src/VuFindTest/ILS/Driver/MultiBackendTest.php @@ -2543,66 +2543,87 @@ trait ILSMockTrait public function cancelHolds($cancelDetails) { } + public function cancelILLRequests($cancelDetails) { } + public function cancelStorageRetrievalRequests($cancelDetails) { } + public function checkRequestIsValid($id, $data, $patron) { } + public function checkILLRequestIsValid($id, $data, $patron) { } + public function checkStorageRetrievalRequestIsValid($id, $data, $patron) { } + public function getCancelHoldDetails($holdDetails) { } + public function getCancelILLRequestDetails($holdDetails) { } + public function getCancelStorageRetrievalRequestDetails($holdDetails) { } + public function getConfig($function, $params = null) { } + public function getDefaultPickUpLocation($patron = false, $holdDetails = null) { } + public function getDefaultRequestGroup($patron = false, $holdDetails = null) { } + public function getMyILLRequests($patron) { } + public function getILLPickUpLibraries($patron = false, $holdDetails = null) { } + public function getILLPickUpLocations($id, $pickupLib, $patron) { } + public function getPickUpLocations($patron = false, $holdDetails = null) { } + public function getRenewDetails($checkoutDetails) { } + public function getRequestGroups($bibId = null, $patron = null, $holdDetails = null) { } + public function placeHold($holdDetails) { } + public function placeILLRequest($holdDetails) { } + public function placeStorageRetrievalRequest($details) { } + public function renewMyItems($renewDetails) { } @@ -2618,6 +2639,7 @@ class VoyagerMock extends \VuFind\ILS\Driver\Voyager class VoyagerNoSupportMock extends \VuFind\ILS\Driver\Voyager { use ILSMockTrait; + public function supportsMethod(...$args) { return false; diff --git a/module/VuFind/tests/unit-tests/src/VuFindTest/ILS/Driver/PAIATest.php b/module/VuFind/tests/unit-tests/src/VuFindTest/ILS/Driver/PAIATest.php index ddd231e2495..b70e0b0709e 100644 --- a/module/VuFind/tests/unit-tests/src/VuFindTest/ILS/Driver/PAIATest.php +++ b/module/VuFind/tests/unit-tests/src/VuFindTest/ILS/Driver/PAIATest.php @@ -459,6 +459,7 @@ class PAIATest extends \VuFindTest\Unit\ILSDriverTestCase $this->assertEquals(false, $result_expired); $this->assertEquals(false, $resultStorage_expired); } + /** * Test * diff --git a/module/VuFind/tests/unit-tests/src/VuFindTest/Recommend/FavoriteFacetsTest.php b/module/VuFind/tests/unit-tests/src/VuFindTest/Recommend/FavoriteFacetsTest.php index 360663daaad..04b62775974 100644 --- a/module/VuFind/tests/unit-tests/src/VuFindTest/Recommend/FavoriteFacetsTest.php +++ b/module/VuFind/tests/unit-tests/src/VuFindTest/Recommend/FavoriteFacetsTest.php @@ -52,6 +52,7 @@ class FavoriteFacetsTest extends \VuFindTest\Unit\TestCase $params->expects($this->exactly(0))->method('addFacet'); // no facets are expected in this case $this->getFavoriteFacets($results, 'disabled'); } + /** * Test facet initialization with enabled tags. * diff --git a/module/VuFindConsole/src/VuFindConsole/Controller/GenerateController.php b/module/VuFindConsole/src/VuFindConsole/Controller/GenerateController.php index effcb7ac864..56a9162a8d8 100644 --- a/module/VuFindConsole/src/VuFindConsole/Controller/GenerateController.php +++ b/module/VuFindConsole/src/VuFindConsole/Controller/GenerateController.php @@ -611,6 +611,7 @@ class GenerateController extends AbstractBase } Console::writeLine("Successfully updated $configPath"); } + /** * Update the configuration of a target module. * diff --git a/module/VuFindSearch/src/VuFindSearch/Backend/Solr/LuceneSyntaxHelper.php b/module/VuFindSearch/src/VuFindSearch/Backend/Solr/LuceneSyntaxHelper.php index c6a5bd050da..fc332536fd1 100644 --- a/module/VuFindSearch/src/VuFindSearch/Backend/Solr/LuceneSyntaxHelper.php +++ b/module/VuFindSearch/src/VuFindSearch/Backend/Solr/LuceneSyntaxHelper.php @@ -520,6 +520,7 @@ class LuceneSyntaxHelper $input = preg_replace('/(\:[:\s]+|[:\s]+:)' . $lookahead . '/', ' ', $input); return trim($input, ':'); } + /** * Prepare input to be used in a SOLR query. * diff --git a/module/VuFindSearch/tests/unit-tests/src/VuFindTest/Backend/Solr/SearchHandlerTest.php b/module/VuFindSearch/tests/unit-tests/src/VuFindTest/Backend/Solr/SearchHandlerTest.php index cecbd0fdef0..d75601bb9f9 100644 --- a/module/VuFindSearch/tests/unit-tests/src/VuFindTest/Backend/Solr/SearchHandlerTest.php +++ b/module/VuFindSearch/tests/unit-tests/src/VuFindTest/Backend/Solr/SearchHandlerTest.php @@ -65,6 +65,7 @@ class SearchHandlerTest extends PHPUnit_Framework_TestCase $hndl = new SearchHandler($spec); $this->assertEquals('(id:("escaped\"quote" OR not OR quoted OR "basic phrase"))', $hndl->createSimpleQueryString('"escaped\"quote" not quoted "basic phrase"')); } + /** * Test toArray() method. * -- GitLab