diff --git a/module/VuFind/src/VuFind/Config/Upgrade.php b/module/VuFind/src/VuFind/Config/Upgrade.php index 0f40db360334e96e60bbd4c4dca98c9a39af7b09..801bd23a98d4650ab525137942ed0399328b3b04 100644 --- a/module/VuFind/src/VuFind/Config/Upgrade.php +++ b/module/VuFind/src/VuFind/Config/Upgrade.php @@ -1154,7 +1154,7 @@ class Upgrade * Read the specified file and return an associative array of this format * containing all comments extracted from the file: * - * array => + * [ * 'sections' => array * 'section_name_1' => array * 'before' => string ("Comments found at the beginning of this section") @@ -1168,6 +1168,7 @@ class Upgrade * ... * 'section_name_n' => array (same keys as section_name_1) * 'after' => string ("Comments found at the very end of the file") + * ] * * @param string $filename Name of ini file to read. * diff --git a/module/VuFind/src/VuFind/Config/Writer.php b/module/VuFind/src/VuFind/Config/Writer.php index e900345178775e8f881821eeca85f8f4a6e31757..cc54657ee27f8b114193e35c3da6530d778b3a4e 100644 --- a/module/VuFind/src/VuFind/Config/Writer.php +++ b/module/VuFind/src/VuFind/Config/Writer.php @@ -175,7 +175,7 @@ class Writer } /** - * support method for buildContent -- format a value + * Support method for buildContent -- format a value * * @param mixed $e Value to format * @@ -195,7 +195,7 @@ class Writer } /** - * support method for buildContent -- format a line + * Support method for buildContent -- format a line * * @param string $key Configuration key * @param mixed $value Configuration value @@ -215,7 +215,7 @@ class Writer } /** - * support method for buildContent -- format an array into lines + * Support method for buildContent -- format an array into lines * * @param string $key Configuration key * @param array $value Configuration value @@ -241,7 +241,7 @@ class Writer } /** - * write an ini file, adapted from + * Write an ini file, adapted from * http://php.net/manual/function.parse-ini-file.php * * @param array $assoc_arr Array to output diff --git a/module/VuFind/src/VuFind/Controller/AbstractBase.php b/module/VuFind/src/VuFind/Controller/AbstractBase.php index e10df80e08a030d5764e5926f40e2dfa6d7bc88f..c3f8637486f8ec853381584e8b9e608ef97f50e2 100644 --- a/module/VuFind/src/VuFind/Controller/AbstractBase.php +++ b/module/VuFind/src/VuFind/Controller/AbstractBase.php @@ -61,7 +61,7 @@ class AbstractBase extends AbstractActionController protected $accessPermission = false; /** - * preDispatch -- block access when appropriate. + * Use preDispatch event to block access when appropriate. * * @param MvcEvent $e Event object * diff --git a/module/VuFind/src/VuFind/Controller/AjaxController.php b/module/VuFind/src/VuFind/Controller/AjaxController.php index 2da971d4b5a0ebdb36ecb16f926cbebeced0ee45..26ea3da4a82bf32f177400cfce0bc5866a336c6b 100644 --- a/module/VuFind/src/VuFind/Controller/AjaxController.php +++ b/module/VuFind/src/VuFind/Controller/AjaxController.php @@ -683,8 +683,8 @@ class AjaxController extends AbstractBase * * @param array $fields Solr fields to retrieve data from * - * @author Chris Hallberg <crhallberg@gmail.com> - * @author Lutz Biedinger <lutz.biedinger@gmail.com> + * @author Chris Hallberg <crhallberg@gmail.com> + * @author Lutz Biedinger <lutz.biedinger@gmail.com> * * @return \Zend\Http\Response */ @@ -718,8 +718,8 @@ class AjaxController extends AbstractBase /** * Get entry information on entries tied to a specific map location * - * @author Chris Hallberg <crhallberg@gmail.com> - * @author Lutz Biedinger <lutz.biedinger@gmail.com> + * @author Chris Hallberg <crhallberg@gmail.com> + * @author Lutz Biedinger <lutz.biedinger@gmail.com> * * @return mixed */ @@ -748,8 +748,8 @@ class AjaxController extends AbstractBase * * @param array $fields Solr fields to retrieve data from * - * @author Chris Hallberg <crhallberg@gmail.com> - * @author Till Kinstler <kinstler@gbv.de> + * @author Chris Hallberg <crhallberg@gmail.com> + * @author Till Kinstler <kinstler@gbv.de> * * @return \Zend\Http\Response */ diff --git a/module/VuFind/src/VuFind/Controller/CollectionsController.php b/module/VuFind/src/VuFind/Controller/CollectionsController.php index 92dcd28b991919ea425c7a0ff00c33a73add15eb..db55532d1aedd47ff0032b0d2cac35854bbc184b 100644 --- a/module/VuFind/src/VuFind/Controller/CollectionsController.php +++ b/module/VuFind/src/VuFind/Controller/CollectionsController.php @@ -231,8 +231,8 @@ class CollectionsController extends AbstractBase * Function to sort the results and find the position of the from * value in the result set; if the value doesn't exist, it's inserted. * - * @param array &$result Array to sort - * @param string $from Position to find + * @param array $result Array to sort + * @param string $from Position to find * * @return int */ @@ -266,7 +266,7 @@ class CollectionsController extends AbstractBase /** * Function to normalize the names so they sort properly * - * @param array &$result Array to sort (passed by reference to use less + * @param array $result Array to sort (passed by reference to use less * memory) * * @return array $resultOut diff --git a/module/VuFind/src/VuFind/Controller/InstallController.php b/module/VuFind/src/VuFind/Controller/InstallController.php index c4538ed5bd5fc2ba2642274c08934b55d27e6455..aa944b6fdfcb61371286fca814c3e03d32d23307 100644 --- a/module/VuFind/src/VuFind/Controller/InstallController.php +++ b/module/VuFind/src/VuFind/Controller/InstallController.php @@ -43,7 +43,7 @@ use VuFind\Config\Locator as ConfigLocator, class InstallController extends AbstractBase { /** - * preDispatch -- block access when appropriate. + * Use preDispatch event to block access when appropriate. * * @param MvcEvent $e Event object * diff --git a/module/VuFind/src/VuFind/Controller/SearchController.php b/module/VuFind/src/VuFind/Controller/SearchController.php index 75ce048e748102822fe915077f2691702e22a08d..6ee303bea30f7454cec2e1f1630d5a1b024cf646 100644 --- a/module/VuFind/src/VuFind/Controller/SearchController.php +++ b/module/VuFind/src/VuFind/Controller/SearchController.php @@ -593,8 +593,7 @@ class SearchController extends AbstractSearch } /** - * Provide OpenSearch suggestions as specified here: - * + * Provide OpenSearch suggestions as specified at * http://www.opensearch.org/Specifications/OpenSearch/Extensions/Suggestions/1.0 * * @return \Zend\Http\Response diff --git a/module/VuFind/src/VuFind/Controller/SummonController.php b/module/VuFind/src/VuFind/Controller/SummonController.php index 09d78260070ad74c1d7ebee66a626404bd09a631..3fcabde1211bf60ab235f5e2463f7842b40e1272 100644 --- a/module/VuFind/src/VuFind/Controller/SummonController.php +++ b/module/VuFind/src/VuFind/Controller/SummonController.php @@ -61,7 +61,7 @@ class SummonController extends AbstractSearch } /** - * preDispatch -- add Summon message. + * Use preDispatch event to add Summon message. * * @return void */ diff --git a/module/VuFind/src/VuFind/Controller/SummonrecordController.php b/module/VuFind/src/VuFind/Controller/SummonrecordController.php index db92514cf18035315ab9a387f814ca7156842e0f..af2fb220f9e32b5a0b635dd0fe7b349fb8f8ce66 100644 --- a/module/VuFind/src/VuFind/Controller/SummonrecordController.php +++ b/module/VuFind/src/VuFind/Controller/SummonrecordController.php @@ -65,7 +65,7 @@ class SummonrecordController extends AbstractRecord } /** - * preDispatch -- add Summon message. + * Use preDispatch event to add Summon message. * * @return void */ diff --git a/module/VuFind/src/VuFind/Controller/UpgradeController.php b/module/VuFind/src/VuFind/Controller/UpgradeController.php index ee4020050a08a360fc35a196a5d7686f221bb656..20663f0d153d6e170cf3d6a0a8cae6477447589e 100644 --- a/module/VuFind/src/VuFind/Controller/UpgradeController.php +++ b/module/VuFind/src/VuFind/Controller/UpgradeController.php @@ -89,7 +89,7 @@ class UpgradeController extends AbstractBase } /** - * preDispatch -- block access when appropriate. + * Use preDispatch event to block access when appropriate. * * @param MvcEvent $e Event object * diff --git a/module/VuFind/src/VuFind/Date/Converter.php b/module/VuFind/src/VuFind/Date/Converter.php index be449d3de4d99e38e380c7513994f15d21935d89..f3d1a47ffdc4d92ac230d7e88cace381bfa7dfd4 100644 --- a/module/VuFind/src/VuFind/Date/Converter.php +++ b/module/VuFind/src/VuFind/Date/Converter.php @@ -164,8 +164,7 @@ class Converter } /** - * public method for conversion of a date string to admin defined - * date string. + * Convert a date string to admin-defined format. * * @param string $createFormat The format of the date string to be changed * @param string $dateString The date string diff --git a/module/VuFind/src/VuFind/Db/Table/ChangeTracker.php b/module/VuFind/src/VuFind/Db/Table/ChangeTracker.php index 01374afe791149e81b6f874a255f47929a1c0a64..1c11e6b871fcb30327d442f236143f1329ae69a2 100644 --- a/module/VuFind/src/VuFind/Db/Table/ChangeTracker.php +++ b/module/VuFind/src/VuFind/Db/Table/ChangeTracker.php @@ -39,7 +39,7 @@ namespace VuFind\Db\Table; class ChangeTracker extends Gateway { /** - * date/time format for database + * Date/time format for database * * @var string */ diff --git a/module/VuFind/src/VuFind/Hierarchy/TreeDataSource/Solr.php b/module/VuFind/src/VuFind/Hierarchy/TreeDataSource/Solr.php index 913b4fcfa2b3fbb13fd01d3341fc828178b5cc9f..d7da9a0e96237bb21f4abbc03d9d086303285a96 100644 --- a/module/VuFind/src/VuFind/Hierarchy/TreeDataSource/Solr.php +++ b/module/VuFind/src/VuFind/Hierarchy/TreeDataSource/Solr.php @@ -141,7 +141,7 @@ class Solr extends AbstractBase * * @param string $parentID The starting point for the current recursion * (equivlent to Solr field hierarchy_parent_id) - * @param string &$count The total count of items in the tree + * @param string $count The total count of items in the tree * before this recursion * * @return string @@ -257,7 +257,7 @@ class Solr extends AbstractBase * * @param string $parentID The starting point for the current recursion * (equivlent to Solr field hierarchy_parent_id) - * @param string &$count The total count of items in the tree + * @param string $count The total count of items in the tree * before this recursion * * @return string diff --git a/module/VuFind/src/VuFind/Hierarchy/TreeRenderer/JSTree.php b/module/VuFind/src/VuFind/Hierarchy/TreeRenderer/JSTree.php index 88df6892d886abeddf1c1f8f2e76bf808aab2bb2..5c2e0ebc8f71f860ae60f2e3aa74dcceda7e6474 100644 --- a/module/VuFind/src/VuFind/Hierarchy/TreeRenderer/JSTree.php +++ b/module/VuFind/src/VuFind/Hierarchy/TreeRenderer/JSTree.php @@ -255,8 +255,6 @@ class JSTree extends AbstractBase } /** - * transformCollectionXML - * * Transforms Collection XML to Desired Format * * @param string $context The Context in which the tree is being displayed diff --git a/module/VuFind/src/VuFind/I18n/Translator/Loader/ExtendedIni.php b/module/VuFind/src/VuFind/I18n/Translator/Loader/ExtendedIni.php index a6639dc8bfd502c1dee24a90dc06e43124f26ea6..de79ebc422923c5473203ec56276a20d96ba314e 100644 --- a/module/VuFind/src/VuFind/I18n/Translator/Loader/ExtendedIni.php +++ b/module/VuFind/src/VuFind/I18n/Translator/Loader/ExtendedIni.php @@ -92,7 +92,7 @@ class ExtendedIni implements FileLoaderInterface } /** - * load(): defined by LoaderInterface. + * Load method defined by FileLoaderInterface. * * @param string $locale Locale to read from language file * @param string $filename Language file to read (not used) diff --git a/module/VuFind/src/VuFind/ILS/Driver/ClaviusSQL.php b/module/VuFind/src/VuFind/ILS/Driver/ClaviusSQL.php index 9caed0de16829f0c089052f6ada5721a6ab4c61e..5217066524396c134cffe4c05e330bc9cf5c1834 100644 --- a/module/VuFind/src/VuFind/ILS/Driver/ClaviusSQL.php +++ b/module/VuFind/src/VuFind/ILS/Driver/ClaviusSQL.php @@ -31,8 +31,6 @@ use PDO, PDOException, VuFind\Exception\ILS as ILSException; /** * VuFind Driver for Clavius SQL (version: 0.1 dev) * - * last updated: 09/06/2012 - * * @category VuFind2 * @package ILS_Drivers * @author Josef Moravec <josef.moravec@knihovna-uo.cz> @@ -151,7 +149,6 @@ class ClaviusSQL extends AbstractBase * * @return array An associative array with key = department ID, * value = department name. - * */ public function getDepartments() { @@ -181,7 +178,6 @@ class ClaviusSQL extends AbstractBase * * @return array An associative array with key = fine code, * value = fine description - * */ public function getFineTypes() { @@ -213,7 +209,6 @@ class ClaviusSQL extends AbstractBase * @throws ILSException * * @return array An associative array with key = fund ID, value = fund name. - * */ public function getFunds() { diff --git a/module/VuFind/src/VuFind/ILS/Driver/Innovative.php b/module/VuFind/src/VuFind/ILS/Driver/Innovative.php index a08fa53403c2397d3f19974194402d00e4f4309d..015266057d42931035a290f147d8d6590c727ded 100644 --- a/module/VuFind/src/VuFind/ILS/Driver/Innovative.php +++ b/module/VuFind/src/VuFind/ILS/Driver/Innovative.php @@ -85,7 +85,7 @@ class Innovative extends AbstractBase implements } /** - * prepID + * Prepare ID * * This function returns the correct record id format as defined * in the Innovative.ini file. diff --git a/module/VuFind/src/VuFind/ILS/Driver/VoyagerRestful.php b/module/VuFind/src/VuFind/ILS/Driver/VoyagerRestful.php index fc9a215742e312444df18aadb4bff310166b9a26..c2dec8998868301fb527e8bbfcdf4246dc94375d 100644 --- a/module/VuFind/src/VuFind/ILS/Driver/VoyagerRestful.php +++ b/module/VuFind/src/VuFind/ILS/Driver/VoyagerRestful.php @@ -588,7 +588,7 @@ class VoyagerRestful extends Voyager implements \VuFindHttp\HttpServiceAwareInte } /** - * checkRequestIsValid + * Check if request is valid * * This is responsible for determining if an item is requestable * @@ -622,7 +622,7 @@ class VoyagerRestful extends Voyager implements \VuFindHttp\HttpServiceAwareInte } /** - * checkStorageRetrievalRequestIsValid + * Check if storage retrieval request is valid * * This is responsible for determining if an item is requestable * @@ -2694,7 +2694,7 @@ EOT; } /** - * checkILLRequestIsValid + * Check if ILL Request is valid * * This is responsible for determining if an item is requestable * diff --git a/module/VuFind/src/VuFind/QRCode/Loader.php b/module/VuFind/src/VuFind/QRCode/Loader.php index 9d755cf1f639c3f3d594a789e785a0f97e0e9519..594ec5edf8ac0528a280e4999b1ff25933d3c435 100644 --- a/module/VuFind/src/VuFind/QRCode/Loader.php +++ b/module/VuFind/src/VuFind/QRCode/Loader.php @@ -44,7 +44,7 @@ use \PHPQRCode; class Loader extends \VuFind\ImageLoader { /** - * property to hold VuFind configuration settings + * VuFind configuration settings * * @var \Zend\Config\Config */ diff --git a/module/VuFind/src/VuFind/RecordDriver/EDS.php b/module/VuFind/src/VuFind/RecordDriver/EDS.php index f6565aaf0bc180930c782fad55028d9b0a72d3eb..54354b1448787a63d517ac0dddcd205f21b968a2 100644 --- a/module/VuFind/src/VuFind/RecordDriver/EDS.php +++ b/module/VuFind/src/VuFind/RecordDriver/EDS.php @@ -109,7 +109,7 @@ class EDS extends SolrDefault } /** - * obtain an array or authors indicated on the record + * Obtain an array or authors indicated on the record * * @return array */ diff --git a/module/VuFind/src/VuFind/RecordDriver/SolrMarc.php b/module/VuFind/src/VuFind/RecordDriver/SolrMarc.php index 3eece0eeeb6ba433d7b40ea93da8be647b04948a..c67f0ba91a31d5d028ba505ba47be57a30f31340 100644 --- a/module/VuFind/src/VuFind/RecordDriver/SolrMarc.php +++ b/module/VuFind/src/VuFind/RecordDriver/SolrMarc.php @@ -655,7 +655,7 @@ class SolrMarc extends SolrDefault /** * Get hierarchical place names (MARC field 752) * - * returns an array of formatted hierarchical place names, consisting of all + * Returns an array of formatted hierarchical place names, consisting of all * alpha-subfields, concatenated for display * * @return array diff --git a/module/VuFind/src/VuFind/Resolver/Driver/Ezb.php b/module/VuFind/src/VuFind/Resolver/Driver/Ezb.php index d05441ffe46e1d1c3caa002d06423e88c0d088df..e2551c4bc3e185cbbfa6d55d1fe6805fba6352d6 100644 --- a/module/VuFind/src/VuFind/Resolver/Driver/Ezb.php +++ b/module/VuFind/src/VuFind/Resolver/Driver/Ezb.php @@ -197,7 +197,7 @@ class Ezb implements DriverInterface * * @param string $state The state attribute value to extract * @param string $coverage The coverage string to associate with the state - * @param array &$records The array of results to update + * @param array $records The array of results to update * @param DOMXpath $xpath The XPath object containing parsed XML * * @return void @@ -239,7 +239,7 @@ class Ezb implements DriverInterface * * @param string $state The state attribute value to extract * @param string $coverage The coverage string to associate with the state - * @param array &$records The array of results to update + * @param array $records The array of results to update * @param DOMXpath $xpath The XPath object containing parsed XML * * @return void diff --git a/module/VuFind/src/VuFind/Search/EDS/Params.php b/module/VuFind/src/VuFind/Search/EDS/Params.php index 3212663f31b5113e186a055debaa451c9bcadeff..7c07d74a442281b886435c473a32c9a2133bfffa 100644 --- a/module/VuFind/src/VuFind/Search/EDS/Params.php +++ b/module/VuFind/src/VuFind/Search/EDS/Params.php @@ -55,10 +55,9 @@ class Params extends \VuFind\Search\Base\Params protected $extraFilterList = array(); /** - * property to determine if the request using this parameters objects is for - * setup only. + * Is the request using this parameters objects for setup only? * - * @var boolean + * @var bool */ public $isSetupOnly = false; diff --git a/module/VuFind/src/VuFind/Search/Solr/HierarchicalFacetHelper.php b/module/VuFind/src/VuFind/Search/Solr/HierarchicalFacetHelper.php index 11b49df3583c07489c19c45d7381493468d38288..df167da44732fac9682511fe2d8f1abe5bfe3ce7 100644 --- a/module/VuFind/src/VuFind/Search/Solr/HierarchicalFacetHelper.php +++ b/module/VuFind/src/VuFind/Search/Solr/HierarchicalFacetHelper.php @@ -42,8 +42,8 @@ class HierarchicalFacetHelper * Helper method for building hierarchical facets: * Sort a facet list according to the given sort order * - * @param array &$facetList Facet list returned from Solr - * @param bool $topLevel Whether to sort only top level + * @param array $facetList Facet list returned from Solr + * @param bool $topLevel Whether to sort only top level * * @return void */ @@ -89,7 +89,6 @@ class HierarchicalFacetHelper * @see http://blog.tekerson.com/2009/03/03/ * converting-a-flat-array-with-parent-ids-to-a-nested-tree/ * Based on this example - * */ public function buildFacetArray($facet, $facetList, $urlHelper = false) { diff --git a/module/VuFind/src/VuFind/View/Helper/Root/JqueryValidation.php b/module/VuFind/src/VuFind/View/Helper/Root/JqueryValidation.php index 4981ae2aae6e3ec9671143dc2c36548b2bb8016a..c293baadaf247f5fed6b873ad8e4997eb31764e4 100644 --- a/module/VuFind/src/VuFind/View/Helper/Root/JqueryValidation.php +++ b/module/VuFind/src/VuFind/View/Helper/Root/JqueryValidation.php @@ -1,6 +1,6 @@ <?php /** - * jqueryValidation view helper + * View helper for jQuery validation * * PHP version 5 * diff --git a/module/VuFind/src/VuFind/View/Helper/Root/Record.php b/module/VuFind/src/VuFind/View/Helper/Root/Record.php index dc9ab80b325cbc1d0ddd480084e89cf20a94ebc9..4c1dd2bb5357473b864d8f2b59ed954d9b3beb3f 100644 --- a/module/VuFind/src/VuFind/View/Helper/Root/Record.php +++ b/module/VuFind/src/VuFind/View/Helper/Root/Record.php @@ -270,7 +270,7 @@ class Record extends AbstractHelper } /** - * collects ISBN, LCCN, and OCLC numbers to use in calling preview APIs + * Collects ISBN, LCCN, and OCLC numbers to use in calling preview APIs * * @return array */