Skip to content

Commit b351fea

Browse files
committed
Standardize PHPdoc to use bool instead of boolean.
1 parent b4de458 commit b351fea

File tree

13 files changed

+20
-20
lines changed

13 files changed

+20
-20
lines changed

module/VuFind/src/VuFind/Config/YamlReader.php

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,9 @@ public function __construct(
8080
/**
8181
* Return a configuration
8282
*
83-
* @param string $filename Config file name
84-
* @param boolean $useLocalConfig Use local configuration if available
85-
* @param boolean $forceReload Reload even if config has been internally
86-
* cached in the class.
83+
* @param string $filename Config file name
84+
* @param bool $useLocalConfig Use local configuration if available
85+
* @param bool $forceReload Reload even if config has been internally cached in the class.
8786
*
8887
* @return array
8988
*/

module/VuFind/src/VuFind/Feature/MergeRecursiveTrait.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ trait MergeRecursiveTrait
5252
*
5353
* @param mixed $op Variable to test
5454
*
55-
* @return boolean
55+
* @return bool
5656
*/
5757
protected function isStringKeyedArray($op)
5858
{

module/VuFind/src/VuFind/ILS/Driver/Aleph.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -802,9 +802,9 @@ public function getMyTransactionHistory($user, $params = null)
802802
* This is responsible for retrieving all transactions (i.e. checked out items)
803803
* by a specific patron.
804804
*
805-
* @param array $user The patron array from patronLogin
806-
* @param array $params Parameters
807-
* @param boolean $history History
805+
* @param array $user The patron array from patronLogin
806+
* @param array $params Parameters
807+
* @param bool $history History
808808
*
809809
* @throws DateException
810810
* @throws ILSException

module/VuFind/src/VuFind/ILS/Driver/Alma.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1644,8 +1644,8 @@ public function findReserves($courseID, $instructorID, $departmentID)
16441644
/**
16451645
* Parse a date.
16461646
*
1647-
* @param string $date Date to parse
1648-
* @param boolean $withTime Add time to return if available?
1647+
* @param string $date Date to parse
1648+
* @param bool $withTime Add time to return if available?
16491649
*
16501650
* @return string
16511651
*/

module/VuFind/src/VuFind/ILS/Driver/PAIA.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1954,7 +1954,7 @@ protected function paiaGetUserDetails($patron)
19541954
*
19551955
* @param string $scope The scope to test for with the current session scopes.
19561956
*
1957-
* @return boolean
1957+
* @return bool
19581958
*/
19591959
protected function paiaCheckScope($scope)
19601960
{

module/VuFind/src/VuFind/Related/Bookplate.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ protected function getBookplateThumbUrlTemplate()
156156
/**
157157
* Display titles under bookplates.
158158
*
159-
* @return boolean
159+
* @return bool
160160
*/
161161
protected function displayBookplateTitles()
162162
{

module/VuFind/src/VuFind/Search/Base/HierarchicalFacetHelperInterface.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ interface HierarchicalFacetHelperInterface
4444
* Helper method for building hierarchical facets:
4545
* Sort a facet list according to the given sort order
4646
*
47-
* @param array $facetList Facet list returned from Solr
48-
* @param boolean|string $order Sort order:
47+
* @param array $facetList Facet list returned from Solr
48+
* @param bool|string $order Sort order:
4949
* - true|top sort top level alphabetically and the rest by count
5050
* - false|all sort all levels alphabetically
5151
* - count sort all levels by count

module/VuFind/src/VuFind/Search/EDS/AbstractEDSParams.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ public function createBackendFilterParameters(ParamBag $params)
102102
*
103103
* @param string $field Filter field name
104104
*
105-
* @return boolean
105+
* @return bool
106106
*/
107107
protected function filterRequiresFacetOperator($field)
108108
{

module/VuFind/src/VuFind/Search/Solr/HierarchicalFacetHelper.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,8 @@ public function setViewRenderer(RendererInterface $renderer): void
122122
*
123123
* Supports both flattened and hierarchical facet lists.
124124
*
125-
* @param array $facetList Facet list returned from Solr
126-
* @param boolean|string $order Sort order:
125+
* @param array $facetList Facet list returned from Solr
126+
* @param bool|string $order Sort order:
127127
* - true|top sort top level alphabetically and the rest by count
128128
* - false|all sort all levels alphabetically
129129
* - count sort all levels by count

module/VuFind/tests/integration-tests/src/VuFindTest/Files/BadStringsTest.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ class BadStringsTest extends \PHPUnit\Framework\TestCase
5151
* @var array
5252
*/
5353
protected array $badStrings = [
54+
'non-standard boolean annotation (use bool)' => '/(@(param|return) boolean)/',
5455
'outdated license address' => '51 Franklin',
5556
'outdated PHP header comment' => '/\\* (PHP version [^8])\s*\n/',
5657
'outdated wiki link' => 'vufind.org/wiki/vufind2',

0 commit comments

Comments
 (0)