PHPdoc

14 files changed, 60 insertions, 0 deletions

diff --git a/app/Contracts/FamilyFactoryInterface.php b/app/Contracts/FamilyFactoryInterface.php
index c97d15e767..24f062054d 100644
--- a/app/Contracts/FamilyFactoryInterface.php
+++ b/app/Contracts/FamilyFactoryInterface.php
@@ -28,6 +28,15 @@ use Fisharebest\Webtrees\Tree;
  */
 interface FamilyFactoryInterface
 {
+    /**
+     * Create a family.
+     *
+     * @param string      $xref
+     * @param Tree        $tree
+     * @param string|null $gedcom
+     *
+     * @return Family|null
+     */
     public function make(string $xref, Tree $tree, string $gedcom = null): ?Family;
 
     /**
diff --git a/app/Elements/AgeAtEvent.php b/app/Elements/AgeAtEvent.php
index 46f827b255..a46614be00 100644
--- a/app/Elements/AgeAtEvent.php
+++ b/app/Elements/AgeAtEvent.php
@@ -52,6 +52,13 @@ class AgeAtEvent extends AbstractElement
 
     protected const KEYWORDS = ['CHILD', 'INFANT', 'STILLBORN'];
 
+    /**
+     * Convert a value to a canonical form.
+     *
+     * @param string $value
+     *
+     * @return string
+     */
     public function canonical(string $value): string
     {
         $value = parent::canonical($value);
diff --git a/app/Http/RequestHandlers/AutoCompleteCitation.php b/app/Http/RequestHandlers/AutoCompleteCitation.php
index e6679fb8a2..f29d8369e4 100644
--- a/app/Http/RequestHandlers/AutoCompleteCitation.php
+++ b/app/Http/RequestHandlers/AutoCompleteCitation.php
@@ -36,6 +36,11 @@ use function preg_quote;
  */
 class AutoCompleteCitation extends AbstractAutocompleteHandler
 {
+    /**
+     * @param ServerRequestInterface $request
+     *
+     * @return Collection<int,string>
+     */
     protected function search(ServerRequestInterface $request): Collection
     {
         $tree   = Validator::attributes($request)->tree();
diff --git a/app/Http/RequestHandlers/AutoCompleteFolder.php b/app/Http/RequestHandlers/AutoCompleteFolder.php
index 814b0106ad..dd028a0c1c 100644
--- a/app/Http/RequestHandlers/AutoCompleteFolder.php
+++ b/app/Http/RequestHandlers/AutoCompleteFolder.php
@@ -33,6 +33,9 @@ class AutoCompleteFolder extends AbstractAutocompleteHandler
 {
     private MediaFileService $media_file_service;
 
+    /**
+     * @param SearchService $search_service
+     */
     public function __construct(MediaFileService $media_file_service, SearchService $search_service)
     {
         parent::__construct($search_service);
diff --git a/app/Http/RequestHandlers/ImportGedcomAction.php b/app/Http/RequestHandlers/ImportGedcomAction.php
index 955a76c025..7f6f564d33 100644
--- a/app/Http/RequestHandlers/ImportGedcomAction.php
+++ b/app/Http/RequestHandlers/ImportGedcomAction.php
@@ -47,6 +47,10 @@ class ImportGedcomAction implements RequestHandlerInterface
 
     private TreeService $tree_service;
 
+    /**
+     * @param StreamFactoryInterface $stream_factory
+     * @param TreeService            $tree_service
+     */
     public function __construct(StreamFactoryInterface $stream_factory, TreeService $tree_service)
     {
         $this->tree_service   = $tree_service;
diff --git a/app/Http/RequestHandlers/TreePreferencesPage.php b/app/Http/RequestHandlers/TreePreferencesPage.php
index 91b952fee9..38e3892457 100644
--- a/app/Http/RequestHandlers/TreePreferencesPage.php
+++ b/app/Http/RequestHandlers/TreePreferencesPage.php
@@ -56,6 +56,11 @@ class TreePreferencesPage implements RequestHandlerInterface
 
     private UserService $user_service;
 
+    /**
+     * @param ModuleService $module_service
+     * @param TreeService   $tree_service
+     * @param UserService   $user_service
+     */
     public function __construct(
         ModuleService $module_service,
         TreeService $tree_service,
diff --git a/app/Http/RequestHandlers/TreePrivacyPage.php b/app/Http/RequestHandlers/TreePrivacyPage.php
index 917b10d1d7..e2829cf8a9 100644
--- a/app/Http/RequestHandlers/TreePrivacyPage.php
+++ b/app/Http/RequestHandlers/TreePrivacyPage.php
@@ -47,6 +47,9 @@ class TreePrivacyPage implements RequestHandlerInterface
 
     private TreeService $tree_service;
 
+    /**
+     * @param TreeService $tree_service
+     */
     public function __construct(TreeService $tree_service)
     {
         $this->tree_service = $tree_service;
diff --git a/app/Module/CustomTagsFamilySearch.php b/app/Module/CustomTagsFamilySearch.php
index 4cfcea576b..6d814d4c5c 100644
--- a/app/Module/CustomTagsFamilySearch.php
+++ b/app/Module/CustomTagsFamilySearch.php
@@ -51,6 +51,9 @@ class CustomTagsFamilySearch extends AbstractModule implements ModuleConfigInter
         ];
     }
 
+    /**
+     * @return array<string,array<int,array<int,string>>>
+     */
     public function customSubTags(): array
     {
         return [
diff --git a/app/Module/LanguageEnglishUnitedStates.php b/app/Module/LanguageEnglishUnitedStates.php
index 9da0db8264..c41612bdbf 100644
--- a/app/Module/LanguageEnglishUnitedStates.php
+++ b/app/Module/LanguageEnglishUnitedStates.php
@@ -107,6 +107,9 @@ class LanguageEnglishUnitedStates extends AbstractModule implements ModuleLangua
         1  => ' ascending',
     ];
 
+    /**
+     * @return LocaleInterface
+     */
     public function locale(): LocaleInterface
     {
         return new LocaleEnUs();
diff --git a/app/Module/ModuleCustomTagsTrait.php b/app/Module/ModuleCustomTagsTrait.php
index 6e116bab9e..1ae645569d 100644
--- a/app/Module/ModuleCustomTagsTrait.php
+++ b/app/Module/ModuleCustomTagsTrait.php
@@ -33,6 +33,9 @@ trait ModuleCustomTagsTrait
 {
     use ViewResponseTrait;
 
+    /**
+     * Early initialisation.  Called before most of the middleware.
+     */
     public function boot(): void
     {
         $element_factory = Registry::elementFactory();
diff --git a/app/Module/RedirectLegacyUrlsModule.php b/app/Module/RedirectLegacyUrlsModule.php
index c67ccc0f88..43106f4a20 100644
--- a/app/Module/RedirectLegacyUrlsModule.php
+++ b/app/Module/RedirectLegacyUrlsModule.php
@@ -114,6 +114,11 @@ class RedirectLegacyUrlsModule extends AbstractModule
         return I18N::translate('Redirect old URLs from webtrees version 1.');
     }
 
+    /**
+     * How should this module be identified in the control panel, etc.?
+     *
+     * @return string
+     */
     public function title(): string
     {
         /* I18N: Name of a module - historic/obsolete URLs. */
diff --git a/app/Module/ResearchTaskModule.php b/app/Module/ResearchTaskModule.php
index d940573986..67ad102f35 100644
--- a/app/Module/ResearchTaskModule.php
+++ b/app/Module/ResearchTaskModule.php
@@ -52,6 +52,9 @@ class ResearchTaskModule extends AbstractModule implements ModuleBlockInterface
     private const LIMIT_LOW  = 10;
     private const LIMIT_HIGH = 20;
 
+    /**
+     * Early initialisation.  Called before most of the middleware.
+     */
     public function boot(): void
     {
         Registry::elementFactory()->register([
diff --git a/app/Services/LinkedRecordService.php b/app/Services/LinkedRecordService.php
index cd6361e97b..ca479b1f62 100644
--- a/app/Services/LinkedRecordService.php
+++ b/app/Services/LinkedRecordService.php
@@ -112,6 +112,7 @@ class LinkedRecordService
      * Find individuals linked to a record.
      *
      * @param GedcomRecord $record
+     * @param string|null  $link_type
      *
      * @return Collection<int,Individual>
      */
diff --git a/app/Services/UpgradeService.php b/app/Services/UpgradeService.php
index d229b59055..8f4c539689 100644
--- a/app/Services/UpgradeService.php
+++ b/app/Services/UpgradeService.php
@@ -280,6 +280,9 @@ class UpgradeService
         return $url;
     }
 
+    /**
+     * @return void
+     */
     public function startMaintenanceMode(): void
     {
         $message = I18N::translate('This website is being upgraded. Try again in a few minutes.');
@@ -287,6 +290,9 @@ class UpgradeService
         file_put_contents(Webtrees::OFFLINE_FILE, $message);
     }
 
+    /**
+     * @return void
+     */
     public function endMaintenanceMode(): void
     {
         if (file_exists(Webtrees::OFFLINE_FILE)) {