diff --git a/module/VuFind/src/VuFind/Autocomplete/PluginManager.php b/module/VuFind/src/VuFind/Autocomplete/PluginManager.php index d462a42a15300b93072ec4c539703c41d02b476a..c6d7bc5f035a90e45b3ad46ffbe76c1b0fd86389 100644 --- a/module/VuFind/src/VuFind/Autocomplete/PluginManager.php +++ b/module/VuFind/src/VuFind/Autocomplete/PluginManager.php @@ -50,8 +50,6 @@ class PluginManager extends \VuFind\ServiceManager\AbstractPluginManager } /** - * getSuggestions - * * This returns an array of suggestions based on current request parameters. * This logic is present in the factory class so that it can be easily shared * by multiple AJAX handlers. diff --git a/module/VuFind/src/VuFind/Connection/Oracle.php b/module/VuFind/src/VuFind/Connection/Oracle.php index 79455695230c465cadc792715109f450cea2c222..3aa91d6d7e731a36cfff1134cce4c11fd007eb6c 100644 --- a/module/VuFind/src/VuFind/Connection/Oracle.php +++ b/module/VuFind/src/VuFind/Connection/Oracle.php @@ -221,7 +221,7 @@ class Oracle * @param resource $parsed Result returned by prepare() method. * @param string $place_holder The colon-prefixed bind variable placeholder * used in the statement. - * @param string &$data The PHP variable to be associatd with + * @param string $data The PHP variable to be associatd with * $place_holder * @param string $data_type The type of $data (string, integer, float, * long, date, row_id, clob, or blob) diff --git a/module/VuFind/src/VuFind/Connection/Wikipedia.php b/module/VuFind/src/VuFind/Connection/Wikipedia.php index 8f1b12296316b93b798151fd0c7fe1911bc1a9b9..75326b7e1f21533003b5dad2fe7fea3bffbab1c8 100644 --- a/module/VuFind/src/VuFind/Connection/Wikipedia.php +++ b/module/VuFind/src/VuFind/Connection/Wikipedia.php @@ -86,8 +86,6 @@ class Wikipedia implements TranslatorAwareInterface } /** - * get - * * This method is responsible for connecting to Wikipedia via the REST API * and pulling the content for the relevant author. * diff --git a/module/VuFind/src/VuFind/Cover/Loader.php b/module/VuFind/src/VuFind/Cover/Loader.php index b717974fe9696a2da030da2437c0104c8968949c..6a94e81a303b2e89ff3bf5c932c4ff35a03ce47d 100644 --- a/module/VuFind/src/VuFind/Cover/Loader.php +++ b/module/VuFind/src/VuFind/Cover/Loader.php @@ -42,21 +42,21 @@ use VuFindCode\ISBN, VuFind\Content\Covers\PluginManager as ApiManager; class Loader extends \VuFind\ImageLoader { /** - * filename constructed from ISBN + * Filename constructed from ISBN * * @var string */ protected $localFile = ''; /** - * valid image sizes to request + * Valid image sizes to request * * @var array */ protected $validSizes = array('small', 'medium', 'large'); /** - * property to hold VuFind configuration settings + * VuFind configuration settings * * @var \Zend\Config\Config */ @@ -77,7 +77,7 @@ class Loader extends \VuFind\ImageLoader protected $client; /** - * directory to store downloaded images + * Directory to store downloaded images * * @var string */ diff --git a/module/VuFind/src/VuFind/Recommend/AbstractFacets.php b/module/VuFind/src/VuFind/Recommend/AbstractFacets.php index 4171d68f60b2c782f7a2710eebf6300f3eec037d..110fb8a61784e4ed9b30c8cd5f8baca816760b98 100644 --- a/module/VuFind/src/VuFind/Recommend/AbstractFacets.php +++ b/module/VuFind/src/VuFind/Recommend/AbstractFacets.php @@ -80,8 +80,6 @@ abstract class AbstractFacets implements RecommendInterface } /** - * process - * * Called after the Search Results object has performed its main search. This * may be used to extract necessary information from the Search Results object * or to perform completely unrelated processing. diff --git a/module/VuFind/src/VuFind/Recommend/AuthorFacets.php b/module/VuFind/src/VuFind/Recommend/AuthorFacets.php index aa995d06e451bb161cc7c4de5447575b813d3329..5fc5b5a5ee61aa6d2a394d8a0cdfc22d32934161 100644 --- a/module/VuFind/src/VuFind/Recommend/AuthorFacets.php +++ b/module/VuFind/src/VuFind/Recommend/AuthorFacets.php @@ -144,7 +144,7 @@ class AuthorFacets implements RecommendInterface /** * Process similar authors from an author search * - * @return array Facets data arrays + * @return array Facets data arrays */ public function getSimilarAuthors() { diff --git a/module/VuFind/src/VuFind/Recommend/AuthorityRecommend.php b/module/VuFind/src/VuFind/Recommend/AuthorityRecommend.php index a02a2be5af1380c89b6b14000391980217a9a0ff..5931d1e2efbfcd6dac85936dd99cd0ea4a512739 100644 --- a/module/VuFind/src/VuFind/Recommend/AuthorityRecommend.php +++ b/module/VuFind/src/VuFind/Recommend/AuthorityRecommend.php @@ -21,10 +21,8 @@ * * @category VuFind2 * @package Recommendations - * @author Lutz Biedinger (National Library of Ireland) - * <vufind-tech@lists.sourceforge.net> - * @author Ronan McHugh (National Library of Ireland) - * <vufind-tech@lists.sourceforge.net> + * @author Lutz Biedinger <vufind-tech@lists.sourceforge.net> + * @author Ronan McHugh <vufind-tech@lists.sourceforge.net> * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License * @link http://www.vufind.org Main Page */ @@ -39,12 +37,13 @@ use VuFindSearch\Backend\Exception\RequestErrorException, * i.e. searches for a pseudonym will provide the user with a link * to the official name (according to the Authority index) * + * Originally developed at the National Library of Ireland by Lutz + * Biedinger and Ronan McHugh. + * * @category VuFind2 * @package Recommendations - * @author Lutz Biedinger (National Library of Ireland) - * <vufind-tech@lists.sourceforge.net> - * @author Ronan McHugh (National Library of Ireland) - * <vufind-tech@lists.sourceforge.net> + * @author Lutz Biedinger <vufind-tech@lists.sourceforge.net> + * @author Ronan McHugh <vufind-tech@lists.sourceforge.net> * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License * @link http://www.vufind.org Main Page */ @@ -237,8 +236,6 @@ class AuthorityRecommend implements RecommendInterface } /** - * inArrayR - * * Helper function to do recursive searches of multi-dimensional arrays. * * @param string $needle Search term diff --git a/module/VuFind/src/VuFind/Recommend/EuropeanaResults.php b/module/VuFind/src/VuFind/Recommend/EuropeanaResults.php index c7ede955978a45f2268e5a4e45e79e462494f6bd..c148c5ae4fc52ab7f1cf951f4fa5bea9bd35d082 100644 --- a/module/VuFind/src/VuFind/Recommend/EuropeanaResults.php +++ b/module/VuFind/src/VuFind/Recommend/EuropeanaResults.php @@ -154,9 +154,7 @@ class EuropeanaResults implements RecommendInterface, } /** - * getURL - * - * This method builds the url which will be send to retrieve the RSS results + * Build the url which will be send to retrieve the RSS results * * @param string $targetUrl Base URL * @param string $requestParam Parameter name to add diff --git a/module/VuFind/src/VuFind/Recommend/PubDateVisAjax.php b/module/VuFind/src/VuFind/Recommend/PubDateVisAjax.php index b03d59f290ed4a12fa22872295f110cb34a5abb3..a92b127e3c250351b15b8108ead5cef5233b524a 100644 --- a/module/VuFind/src/VuFind/Recommend/PubDateVisAjax.php +++ b/module/VuFind/src/VuFind/Recommend/PubDateVisAjax.php @@ -1,6 +1,6 @@ <?php /** - * publishDateVis + * PubDateVisAjax Recommendations Module * * PHP version 5 * @@ -123,9 +123,7 @@ class PubDateVisAjax implements RecommendInterface } /** - * getVisFacets - * - * Basic get + * Get visual facet details. * * @return array */ @@ -141,9 +139,7 @@ class PubDateVisAjax implements RecommendInterface } /** - * getZooming - * - * Basic get + * Get zoom setting * * @return array */ @@ -156,9 +152,7 @@ class PubDateVisAjax implements RecommendInterface } /** - * getFacetFields - * - * Basic get + * Get facet fields * * @return array */ @@ -168,7 +162,7 @@ class PubDateVisAjax implements RecommendInterface } /** - * getSearchParams + * Get search parameters * * @return string of params */ diff --git a/module/VuFind/src/VuFind/Recommend/RandomRecommend.php b/module/VuFind/src/VuFind/Recommend/RandomRecommend.php index abb88615fcf79430d4707b44baf2c821e965bd85..1ae33f76a506d0a79665b5f47d89ecdbd8275594 100644 --- a/module/VuFind/src/VuFind/Recommend/RandomRecommend.php +++ b/module/VuFind/src/VuFind/Recommend/RandomRecommend.php @@ -21,8 +21,7 @@ * * @category VuFind2 * @package Recommendations - * @author Luke O'Sullivan (Swansea University) - * <vufind-tech@lists.sourceforge.net> + * @author Luke O'Sullivan <vufind-tech@lists.sourceforge.net> * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License * @link http://www.vufind.org Main Page */ @@ -36,10 +35,11 @@ use VuFindSearch\Query\Query, * * This class provides random recommendations based on the Solr random field * + * Originally developed by Luke O'Sullivan at Swansea University. + * * @category VuFind2 * @package Recommendations - * @author Luke O'Sullivan (Swansea University) - * <vufind-tech@lists.sourceforge.net> + * @author Luke O'Sullivan <vufind-tech@lists.sourceforge.net> * @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License * @link http://www.vufind.org Main Page */ diff --git a/module/VuFind/src/VuFind/Recommend/RecommendInterface.php b/module/VuFind/src/VuFind/Recommend/RecommendInterface.php index caba1105a52598ef8d953f46ecc8fe02a3cf21e6..de10db1202bcb82f6db33d1e4ac9f575267cd75b 100644 --- a/module/VuFind/src/VuFind/Recommend/RecommendInterface.php +++ b/module/VuFind/src/VuFind/Recommend/RecommendInterface.php @@ -49,8 +49,6 @@ namespace VuFind\Recommend; interface RecommendInterface { /** - * setConfig - * * Store the configuration of the recommendation module. * * @param string $settings Settings from searches.ini. @@ -74,8 +72,6 @@ interface RecommendInterface public function init($params, $request); /** - * process - * * Called after the Search Results object has performed its main search. This * may be used to extract necessary information from the Search Results object * or to perform completely unrelated processing. diff --git a/module/VuFind/src/VuFind/Recommend/ResultGoogleMapAjax.php b/module/VuFind/src/VuFind/Recommend/ResultGoogleMapAjax.php index fe258b055509337702af303c877cf0209f323777..5b08883c1f8ce740dc2cd8a02787128742462593 100644 --- a/module/VuFind/src/VuFind/Recommend/ResultGoogleMapAjax.php +++ b/module/VuFind/src/VuFind/Recommend/ResultGoogleMapAjax.php @@ -94,7 +94,7 @@ class ResultGoogleMapAjax implements RecommendInterface } /** - * getSearchParams + * Get search parameters * * @return string of params */ diff --git a/module/VuFind/src/VuFind/Recommend/SideFacets.php b/module/VuFind/src/VuFind/Recommend/SideFacets.php index 797233d6b070a2e9d8c13f732e9a819b1efb99fa..dfa0ed4f021d1414a189fc99bf7d60cbdba88cea 100644 --- a/module/VuFind/src/VuFind/Recommend/SideFacets.php +++ b/module/VuFind/src/VuFind/Recommend/SideFacets.php @@ -223,8 +223,6 @@ class SideFacets extends AbstractFacets } /** - * getFacetSet - * * Get facet information from the search results. * * @return array @@ -255,8 +253,6 @@ class SideFacets extends AbstractFacets } /** - * getDateFacets - * * Return year-based date facet information in a format processed for use in the * view. * @@ -268,8 +264,6 @@ class SideFacets extends AbstractFacets } /** - * getFullDateFacets - * * Return year/month/day-based date facet information in a format processed for * use in the view. * @@ -281,8 +275,6 @@ class SideFacets extends AbstractFacets } /** - * getGenericRangeFacets - * * Return generic range facet information in a format processed for use in the * view. * @@ -294,8 +286,6 @@ class SideFacets extends AbstractFacets } /** - * getNumericRangeFacets - * * Return numeric range facet information in a format processed for use in the * view. * @@ -377,8 +367,6 @@ class SideFacets extends AbstractFacets } /** - * getRangeFacets - * * Return range facet information in a format processed for use in the view. * * @param string $property Name of property containing active range facets diff --git a/module/VuFind/src/VuFind/Recommend/SwitchType.php b/module/VuFind/src/VuFind/Recommend/SwitchType.php index b0c1e05667a35c80ddce6d806d997572198dcbbb..e71fdb7696af53ede90d4fabb559183aa565d214 100644 --- a/module/VuFind/src/VuFind/Recommend/SwitchType.php +++ b/module/VuFind/src/VuFind/Recommend/SwitchType.php @@ -43,28 +43,28 @@ namespace VuFind\Recommend; class SwitchType implements RecommendInterface { /** - * search handler to try + * Search handler to try * * @var string */ protected $newHandler; /** - * on-screen description of handler + * On-screen description of handler * * @var string */ protected $newHandlerName; /** - * is this module active? + * Is this module active? * * @var bool */ protected $active; /** - * results object + * Results object * * @var \VuFind\Search\Base\Results */ diff --git a/module/VuFind/src/VuFind/Recommend/VisualFacets.php b/module/VuFind/src/VuFind/Recommend/VisualFacets.php index 00e19054076b291c8104dad0ea3928e7e4303eab..edb2cbf9dd0e39f897629fc5f9d3c33c3dbf8699 100644 --- a/module/VuFind/src/VuFind/Recommend/VisualFacets.php +++ b/module/VuFind/src/VuFind/Recommend/VisualFacets.php @@ -75,6 +75,11 @@ class VisualFacets extends AbstractFacets } /** + * Called at the end of the Search Params objects' initFromRequest() method. + * This method is responsible for setting search parameters needed by the + * recommendation module and for reading any existing search parameters that may + * be needed. + * * @param \VuFind\Search\Base\Params $params Search parameter object * @param \Zend\StdLib\Parameters $request Parameter object representing user * request. diff --git a/module/VuFind/src/VuFind/RecordTab/Map.php b/module/VuFind/src/VuFind/RecordTab/Map.php index 6161004bd39bae38c992aa0861deb384e37645d5..823b4d0b5b15d843b97a7dc274356a17b036de75 100644 --- a/module/VuFind/src/VuFind/RecordTab/Map.php +++ b/module/VuFind/src/VuFind/RecordTab/Map.php @@ -77,8 +77,7 @@ class Map extends AbstractBase } /** - * getGoogleMapMarker - gets the JSON needed to display the record on a Google - * map. + * Get the JSON needed to display the record on a Google map. * * @return string */ diff --git a/module/VuFind/src/VuFind/RecordTab/SimilarItemsCarousel.php b/module/VuFind/src/VuFind/RecordTab/SimilarItemsCarousel.php index ccdf03f6ad038386f4c923dfc0abc7dc052ad8bd..fa121641047e6f53e263c631cfdb81bb82bc2050 100644 --- a/module/VuFind/src/VuFind/RecordTab/SimilarItemsCarousel.php +++ b/module/VuFind/src/VuFind/RecordTab/SimilarItemsCarousel.php @@ -73,8 +73,6 @@ class SimilarItemsCarousel extends AbstractBase } /** - * getResults - * * Get an array of Record Driver objects representing items similar to the one * passed to the constructor. * diff --git a/module/VuFind/src/VuFind/Role/PermissionProvider/IpRange.php b/module/VuFind/src/VuFind/Role/PermissionProvider/IpRange.php index 864439e340277a587307a381a823deb3e4c3c3c3..382ecbd6cecff76d9e8d52c0b4f061ac0e431795 100644 --- a/module/VuFind/src/VuFind/Role/PermissionProvider/IpRange.php +++ b/module/VuFind/src/VuFind/Role/PermissionProvider/IpRange.php @@ -86,6 +86,7 @@ class IpRange implements PermissionProviderInterface * @param array $rangeIP single ip or range of addresses * * @return bool + * * @todo Implement IPv6 check */ protected function checkIP($remoteIP, $rangeIP)