summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGreg Roach <fisharebest@gmail.com>2023-03-23 16:04:15 +0000
committerGreg Roach <fisharebest@gmail.com>2023-03-23 16:04:15 +0000
commite5766395c1a71e715ebaadcf2d63d036d60fb649 (patch)
tree15f39cd885bf60e875b655634e051d23bf3a62ac
parent8b08d6b3e7ab14658bfa7bc8f4702555a07b09aa (diff)
downloadwebtrees-e5766395c1a71e715ebaadcf2d63d036d60fb649.tar.gz
webtrees-e5766395c1a71e715ebaadcf2d63d036d60fb649.tar.bz2
webtrees-e5766395c1a71e715ebaadcf2d63d036d60fb649.zip
PHPdoc
-rw-r--r--app/Age.php4
-rw-r--r--app/Census/AbstractCensusColumn.php14
-rw-r--r--app/Contracts/IdFactoryInterface.php2
-rw-r--r--app/Elements/PedigreeLinkageType.php2
-rw-r--r--app/Elements/RelationIsDescriptor.php2
-rw-r--r--app/Factories/ElementFactory.php2
-rw-r--r--app/Factories/IdFactory.php2
-rw-r--r--app/Http/Middleware/BadBotBlocker.php2
-rw-r--r--app/MediaFile.php2
-rw-r--r--app/Services/GedcomEditService.php2
-rw-r--r--app/Services/GedcomExportService.php32
-rw-r--r--app/Services/RelationshipService.php2
-rw-r--r--phpstan-baseline.php5
13 files changed, 34 insertions, 39 deletions
diff --git a/app/Age.php b/app/Age.php
index 6707fdf146..e0f9ca18b4 100644
--- a/app/Age.php
+++ b/app/Age.php
@@ -41,8 +41,8 @@ class Age
/**
* Age constructor.
*
- * @param Date $x - The first date
- * @param Date $y - The second date
+ * @param Date $x The first date
+ * @param Date $y The second date
*/
public function __construct(Date $x, Date $y)
{
diff --git a/app/Census/AbstractCensusColumn.php b/app/Census/AbstractCensusColumn.php
index 4be7525c99..52600e13f1 100644
--- a/app/Census/AbstractCensusColumn.php
+++ b/app/Census/AbstractCensusColumn.php
@@ -41,9 +41,9 @@ class AbstractCensusColumn
/**
* Create a column for a census
*
- * @param CensusInterface $census - The census to which this column forms part.
- * @param string $abbr - The abbreviated on-screen name "BiC"
- * @param string $title - The full column heading "Born in the county"
+ * @param CensusInterface $census The census to which this column forms part.
+ * @param string $abbr The abbreviated on-screen name "BiC"
+ * @param string $title The full column heading "Born in the county"
*/
public function __construct(CensusInterface $census, string $abbr, string $title)
{
@@ -174,9 +174,9 @@ class AbstractCensusColumn
/**
* Extract the country (last part) of a place name.
*
- * @param string $place - e.g. "London, England"
+ * @param string $place e.g. "London, England"
*
- * @return string - e.g. "England"
+ * @return string e.g. "England"
*/
protected function lastPartOfPlace(string $place): string
{
@@ -188,9 +188,9 @@ class AbstractCensusColumn
/**
* Remove the country of a place name, where it is the same as the census place
*
- * @param string $place - e.g. "London, England"
+ * @param string $place e.g. "London, England"
*
- * @return string - e.g. "London" (for census of England) and "London, England" elsewhere
+ * @return string e.g. "London" (for census of England) and "London, England" elsewhere
*/
protected function notCountry(string $place): string
{
diff --git a/app/Contracts/IdFactoryInterface.php b/app/Contracts/IdFactoryInterface.php
index 28f874e511..fe629c72cf 100644
--- a/app/Contracts/IdFactoryInterface.php
+++ b/app/Contracts/IdFactoryInterface.php
@@ -46,7 +46,7 @@ interface IdFactoryInterface
public function pafUid(): string;
/**
- * @param string $uid - exactly 32 hex characters
+ * @param string $uid exactly 32 hex characters
*
* @return string
*/
diff --git a/app/Elements/PedigreeLinkageType.php b/app/Elements/PedigreeLinkageType.php
index bb5065fe50..36a5b7f0dd 100644
--- a/app/Elements/PedigreeLinkageType.php
+++ b/app/Elements/PedigreeLinkageType.php
@@ -58,7 +58,7 @@ class PedigreeLinkageType extends AbstractElement
/**
* A list of controlled values for this element
*
- * @param string $sex - the text depends on the sex of the individual
+ * @param string $sex the text depends on the sex of the individual
*
* @return array<int|string,string>
*/
diff --git a/app/Elements/RelationIsDescriptor.php b/app/Elements/RelationIsDescriptor.php
index 0d6a6940cb..18931057f8 100644
--- a/app/Elements/RelationIsDescriptor.php
+++ b/app/Elements/RelationIsDescriptor.php
@@ -40,7 +40,7 @@ class RelationIsDescriptor extends AbstractElement
/**
* A list of controlled values for this element
*
- * @param string $sex - the text depends on the sex of the *linked* individual
+ * @param string $sex the text depends on the sex of the *linked* individual
*
* @return array<int|string,string>
*/
diff --git a/app/Factories/ElementFactory.php b/app/Factories/ElementFactory.php
index 13c6297a99..49bd295027 100644
--- a/app/Factories/ElementFactory.php
+++ b/app/Factories/ElementFactory.php
@@ -38,7 +38,7 @@ class ElementFactory implements ElementFactoryInterface
* Finds the correct element for all valid tags.
* Finds a likely element for custom tags.
*
- * @param string $tag - Colon delimited hierarchy, e.g. 'INDI:BIRT:PLAC'
+ * @param string $tag Colon delimited hierarchy, e.g. 'INDI:BIRT:PLAC'
*
* @return ElementInterface
*/
diff --git a/app/Factories/IdFactory.php b/app/Factories/IdFactory.php
index 29223a0145..cb4786a7a2 100644
--- a/app/Factories/IdFactory.php
+++ b/app/Factories/IdFactory.php
@@ -78,7 +78,7 @@ class IdFactory implements IdFactoryInterface
}
/**
- * @param string $uid - exactly 32 hex characters
+ * @param string $uid exactly 32 hex characters
*
* @return string
*/
diff --git a/app/Http/Middleware/BadBotBlocker.php b/app/Http/Middleware/BadBotBlocker.php
index 68bce9d125..38bab5d7e9 100644
--- a/app/Http/Middleware/BadBotBlocker.php
+++ b/app/Http/Middleware/BadBotBlocker.php
@@ -314,7 +314,7 @@ class BadBotBlocker implements MiddlewareInterface
/**
* Perform a whois search for an ASN.
*
- * @param string $asn - The autonomous system number to query
+ * @param string $asn The autonomous system number to query
*
* @return array<RangeInterface>
*/
diff --git a/app/MediaFile.php b/app/MediaFile.php
index b34640a420..12e38b918b 100644
--- a/app/MediaFile.php
+++ b/app/MediaFile.php
@@ -280,7 +280,7 @@ class MediaFile
/**
* Generate a URL to download a media file.
*
- * @param string $disposition How should the image be returned - "attachment" or "inline"
+ * @param string $disposition How should the image be returned: "attachment" or "inline"
*
* @return string
*/
diff --git a/app/Services/GedcomEditService.php b/app/Services/GedcomEditService.php
index f1864a60f2..49aaa4bc3c 100644
--- a/app/Services/GedcomEditService.php
+++ b/app/Services/GedcomEditService.php
@@ -117,7 +117,7 @@ class GedcomEditService
* @param array<string> $levels
* @param array<string> $tags
* @param array<string> $values
- * @param bool $append - Are we appending to a level 0 record, or replacing a level 1 record?
+ * @param bool $append Are we appending to a level 0 record, or replacing a level 1 record?
*
* @return string
*/
diff --git a/app/Services/GedcomExportService.php b/app/Services/GedcomExportService.php
index 02e13d4979..d31743615b 100644
--- a/app/Services/GedcomExportService.php
+++ b/app/Services/GedcomExportService.php
@@ -94,14 +94,14 @@ class GedcomExportService
}
/**
- * @param Tree $tree - Export data from this tree
- * @param bool $sort_by_xref - Write GEDCOM records in XREF order
- * @param string $encoding - Convert from UTF-8 to other encoding
- * @param string $privacy - Filter records by role
- * @param string $line_endings
- * @param string $filename - Name of download file, without an extension
- * @param string $format - One of: gedcom, zip, zipmedia, gedzip
- * @param Collection|null $records
+ * @param Tree $tree Export data from this tree
+ * @param bool $sort_by_xref Write GEDCOM records in XREF order
+ * @param string $encoding Convert from UTF-8 to other encoding
+ * @param string $privacy Filter records by role
+ * @param string $line_endings
+ * @param string $filename Name of download file, without an extension
+ * @param string $format One of: gedcom, zip, zipmedia, gedzip
+ * @param Collection<int,string|object|GedcomRecord>|null $records
*
* @return ResponseInterface
*/
@@ -165,14 +165,14 @@ class GedcomExportService
/**
* Write GEDCOM data to a stream.
*
- * @param Tree $tree - Export data from this tree
- * @param bool $sort_by_xref - Write GEDCOM records in XREF order
- * @param string $encoding - Convert from UTF-8 to other encoding
- * @param int $access_level - Apply privacy filtering
- * @param string $line_endings - CRLF or LF
- * @param Collection<int,string>|null $records - Just export these records
- * @param FilesystemOperator|null $zip_filesystem - Write media files to this filesystem
- * @param string|null $media_path - Location within the zip filesystem
+ * @param Tree $tree Export data from this tree
+ * @param bool $sort_by_xref Write GEDCOM records in XREF order
+ * @param string $encoding Convert from UTF-8 to other encoding
+ * @param int $access_level Apply privacy filtering
+ * @param string $line_endings CRLF or LF
+ * @param Collection<int,string|object|GedcomRecord>|null $records Just export these records
+ * @param FilesystemOperator|null $zip_filesystem Write media files to this filesystem
+ * @param string|null $media_path Location within the zip filesystem
*
* @return resource
*/
diff --git a/app/Services/RelationshipService.php b/app/Services/RelationshipService.php
index 1dc9e9841f..2117dd8db3 100644
--- a/app/Services/RelationshipService.php
+++ b/app/Services/RelationshipService.php
@@ -251,7 +251,7 @@ class RelationshipService
/**
* Convert a relationship path into its component pieces; brother, wife, mother, daughter, etc.
*
- * @param array<Individual|Family> $nodes - Alternating list of Individual and Family objects
+ * @param array<Individual|Family> $nodes Alternating list of Individual and Family objects
*
* @return array<string>
*/
diff --git a/phpstan-baseline.php b/phpstan-baseline.php
index e9ee992a11..e7e4e9bc69 100644
--- a/phpstan-baseline.php
+++ b/phpstan-baseline.php
@@ -2904,11 +2904,6 @@ $ignoreErrors[] = [
'path' => __DIR__ . '/app/Services/GedcomExportService.php',
];
$ignoreErrors[] = [
- 'message' => '#^Method Fisharebest\\\\Webtrees\\\\Services\\\\GedcomExportService\\:\\:downloadResponse\\(\\) has parameter \\$records with generic class Illuminate\\\\Support\\\\Collection but does not specify its types\\: TKey, TValue$#',
- 'count' => 1,
- 'path' => __DIR__ . '/app/Services/GedcomExportService.php',
-];
-$ignoreErrors[] = [
'message' => '#^Parameter \\#1 \\$callback of method Illuminate\\\\Support\\\\Collection\\<\\(int\\|string\\),mixed\\>\\:\\:map\\(\\) expects callable\\(mixed, \\(int\\|string\\)\\)\\: Fisharebest\\\\Webtrees\\\\Family, Closure\\(object\\)\\: Fisharebest\\\\Webtrees\\\\Family given\\.$#',
'count' => 1,
'path' => __DIR__ . '/app/Services/GedcomExportService.php',