phpdoc

fisharebest · Jul 23, 2023 · e93a8df · e93a8df
1 parent d14063f
commit e93a8df
Show file tree

Hide file tree

Showing 174 changed files with 1 addition and 349 deletions.
diff --git a/app/Age.php b/app/Age.php
@@ -39,8 +39,6 @@ class Age
     private bool $is_valid;
 
     /**
-     * Age constructor.
-     *
      * @param Date $x The first date
      * @param Date $y The second date
      */

diff --git a/app/Cache.php b/app/Cache.php
@@ -32,8 +32,6 @@ class Cache
     private CacheInterface $cache;
 
     /**
-     * Cache constructor.
-     *
      * @param CacheInterface $cache
      */
     public function __construct(CacheInterface $cache)

diff --git a/app/CommonMark/XrefExtension.php b/app/CommonMark/XrefExtension.php
@@ -31,8 +31,6 @@ class XrefExtension implements ExtensionInterface
     private Tree $tree;
 
     /**
-     * MarkdownXrefParser constructor.
-     *
      * @param Tree $tree Match XREFs in this tree
      */
     public function __construct(Tree $tree)

diff --git a/app/CommonMark/XrefNode.php b/app/CommonMark/XrefNode.php
@@ -30,8 +30,6 @@ class XrefNode extends Node
     private GedcomRecord $record;
 
     /**
-     * XrefNode constructor.
-     *
      * @param GedcomRecord $record
      */
     public function __construct(GedcomRecord $record)

diff --git a/app/CommonMark/XrefParser.php b/app/CommonMark/XrefParser.php
@@ -35,8 +35,6 @@ class XrefParser implements InlineParserInterface
     private Tree $tree;
 
     /**
-     * MarkdownXrefParser constructor.
-     *
      * @param Tree $tree Match XREFs in this tree
      */
     public function __construct(Tree $tree)

diff --git a/app/Elements/AbstractElement.php b/app/Elements/AbstractElement.php
@@ -75,8 +75,6 @@ abstract class AbstractElement implements ElementInterface
     private array $subtags;
 
     /**
-     * AbstractGedcomElement constructor.
-     *
      * @param string             $label
      * @param array<string>|null $subtags
      */

diff --git a/app/Elements/NamePersonal.php b/app/Elements/NamePersonal.php
@@ -86,8 +86,6 @@ class NamePersonal extends AbstractElement
     ];
 
     /**
-     * AbstractGedcomElement constructor.
-     *
      * @param string             $label
      * @param array<string>|null $subtags
      */

diff --git a/app/Exceptions/FileUploadException.php b/app/Exceptions/FileUploadException.php
@@ -40,8 +40,6 @@
 class FileUploadException extends RuntimeException
 {
     /**
-     * GedcomErrorException constructor.
-     *
      * @param UploadedFileInterface|null $uploaded_file
      */
     public function __construct(?UploadedFileInterface $uploaded_file)

diff --git a/app/Exceptions/GedcomErrorException.php b/app/Exceptions/GedcomErrorException.php
@@ -30,8 +30,6 @@
 class GedcomErrorException extends Exception
 {
     /**
-     * GedcomErrorException constructor.
-     *
      * @param string $gedcom
      */
     public function __construct(string $gedcom)

diff --git a/app/Exceptions/InvalidGedcomEncodingException.php b/app/Exceptions/InvalidGedcomEncodingException.php
@@ -30,8 +30,6 @@
 class InvalidGedcomEncodingException extends Exception
 {
     /**
-     * InvalidGedcomEncodingException constructor.
-     *
      * @param string $charset
      */
     public function __construct(string $charset)

diff --git a/app/Factories/CacheFactory.php b/app/Factories/CacheFactory.php
@@ -43,9 +43,7 @@ class CacheFactory implements CacheFactoryInterface
 
     private FilesystemAdapter $filesystem_adapter;
 
-    /**
-     * CacheFactory constructor.
-     */
+    /**/
     public function __construct()
     {
         $this->array_adapter      = new ArrayAdapter(0, false);

diff --git a/app/GuestUser.php b/app/GuestUser.php
@@ -33,8 +33,6 @@ class GuestUser implements UserInterface
     private string $real_name;
 
     /**
-     * GuestUser constructor.
-     *
      * @param string $email
      * @param string $real_name
      */

diff --git a/app/Http/Middleware/BootModules.php b/app/Http/Middleware/BootModules.php
@@ -36,8 +36,6 @@ class BootModules implements MiddlewareInterface
     private ModuleThemeInterface $theme;
 
     /**
-     * BootModules constructor.
-     *
      * @param ModuleService        $module_service
      * @param ModuleThemeInterface $theme
      */

diff --git a/app/Http/Middleware/CompressResponse.php b/app/Http/Middleware/CompressResponse.php
@@ -53,8 +53,6 @@ class CompressResponse implements MiddlewareInterface
     protected StreamFactoryInterface $stream_factory;
 
     /**
-     * CompressResponse constructor.
-     *
      * @param StreamFactoryInterface $stream_factory
      */
     public function __construct(StreamFactoryInterface $stream_factory)

diff --git a/app/Http/Middleware/DoHousekeeping.php b/app/Http/Middleware/DoHousekeeping.php
@@ -53,8 +53,6 @@ class DoHousekeeping implements MiddlewareInterface
     private HousekeepingService $housekeeping_service;
 
     /**
-     * Housekeeping constructor.
-     *
      * @param HousekeepingService $housekeeping_service
      */
     public function __construct(HousekeepingService $housekeeping_service)

diff --git a/app/Http/Middleware/HandleExceptions.php b/app/Http/Middleware/HandleExceptions.php
@@ -59,8 +59,6 @@ class HandleExceptions implements MiddlewareInterface, StatusCodeInterface
     private TreeService $tree_service;
 
     /**
-     * HandleExceptions constructor.
-     *
      * @param TreeService $tree_service
      */
     public function __construct(TreeService $tree_service)

diff --git a/app/Http/Middleware/Router.php b/app/Http/Middleware/Router.php
@@ -52,8 +52,6 @@ class Router implements MiddlewareInterface
     private TreeService $tree_service;
 
     /**
-     * Router constructor.
-     *
      * @param ModuleService   $module_service
      * @param RouterContainer $router_container
      * @param TreeService     $tree_service

diff --git a/app/Http/Middleware/UseLanguage.php b/app/Http/Middleware/UseLanguage.php
@@ -43,8 +43,6 @@ class UseLanguage implements MiddlewareInterface
     private ModuleService $module_service;
 
     /**
-     * UseTheme constructor.
-     *
      * @param ModuleService $module_service
      */
     public function __construct(ModuleService $module_service)

diff --git a/app/Http/Middleware/UseTheme.php b/app/Http/Middleware/UseTheme.php
@@ -39,8 +39,6 @@ class UseTheme implements MiddlewareInterface
     private ModuleService $module_service;
 
     /**
-     * UseTheme constructor.
-     *
      * @param ModuleService $module_service
      */
     public function __construct(ModuleService $module_service)

diff --git a/app/Http/RequestHandlers/AccountDelete.php b/app/Http/RequestHandlers/AccountDelete.php
@@ -40,8 +40,6 @@ class AccountDelete implements RequestHandlerInterface
     private UserService $user_service;
 
     /**
-     * AccountController constructor.
-     *
      * @param UserService $user_service
      */
     public function __construct(UserService $user_service)

diff --git a/app/Http/RequestHandlers/AccountEdit.php b/app/Http/RequestHandlers/AccountEdit.php
@@ -48,8 +48,6 @@ class AccountEdit implements RequestHandlerInterface
     private ModuleService $module_service;
 
     /**
-     * AccountEdit constructor.
-     *
      * @param MessageService $message_service
      * @param ModuleService  $module_service
      */

diff --git a/app/Http/RequestHandlers/AccountUpdate.php b/app/Http/RequestHandlers/AccountUpdate.php
@@ -43,8 +43,6 @@ class AccountUpdate implements RequestHandlerInterface
     private UserService $user_service;
 
     /**
-     * AccountController constructor.
-     *
      * @param UserService $user_service
      */
     public function __construct(UserService $user_service)

diff --git a/app/Http/RequestHandlers/AddChildToFamilyAction.php b/app/Http/RequestHandlers/AddChildToFamilyAction.php
@@ -38,8 +38,6 @@ class AddChildToFamilyAction implements RequestHandlerInterface
     private GedcomEditService $gedcom_edit_service;
 
     /**
-     * AddChildToFamilyAction constructor.
-     *
      * @param GedcomEditService $gedcom_edit_service
      */
     public function __construct(GedcomEditService $gedcom_edit_service)

diff --git a/app/Http/RequestHandlers/AddChildToFamilyPage.php b/app/Http/RequestHandlers/AddChildToFamilyPage.php
@@ -41,8 +41,6 @@ class AddChildToFamilyPage implements RequestHandlerInterface
     private GedcomEditService $gedcom_edit_service;
 
     /**
-     * LinkSpouseToIndividualPage constructor.
-     *
      * @param GedcomEditService $gedcom_edit_service
      */
     public function __construct(GedcomEditService $gedcom_edit_service)

diff --git a/app/Http/RequestHandlers/AddChildToIndividualAction.php b/app/Http/RequestHandlers/AddChildToIndividualAction.php
@@ -38,8 +38,6 @@ class AddChildToIndividualAction implements RequestHandlerInterface
     private GedcomEditService $gedcom_edit_service;
 
     /**
-     * AddChildToFamilyAction constructor.
-     *
      * @param GedcomEditService $gedcom_edit_service
      */
     public function __construct(GedcomEditService $gedcom_edit_service)

diff --git a/app/Http/RequestHandlers/AddChildToIndividualPage.php b/app/Http/RequestHandlers/AddChildToIndividualPage.php
@@ -41,8 +41,6 @@ class AddChildToIndividualPage implements RequestHandlerInterface
     private GedcomEditService $gedcom_edit_service;
 
     /**
-     * LinkSpouseToIndividualPage constructor.
-     *
      * @param GedcomEditService $gedcom_edit_service
      */
     public function __construct(GedcomEditService $gedcom_edit_service)

diff --git a/app/Http/RequestHandlers/AddMediaFileAction.php b/app/Http/RequestHandlers/AddMediaFileAction.php
@@ -42,8 +42,6 @@ class AddMediaFileAction implements RequestHandlerInterface
     private PendingChangesService $pending_changes_service;
 
     /**
-     * AddMediaFileAction constructor.
-     *
      * @param MediaFileService      $media_file_service
      * @param PendingChangesService $pending_changes_service
      */

diff --git a/app/Http/RequestHandlers/AddMediaFileModal.php b/app/Http/RequestHandlers/AddMediaFileModal.php
@@ -41,8 +41,6 @@ class AddMediaFileModal implements RequestHandlerInterface
     private MediaFileService $media_file_service;
 
     /**
-     * AddMediaFileModal constructor.
-     *
      * @param MediaFileService $media_file_service
      */
     public function __construct(MediaFileService $media_file_service)

diff --git a/app/Http/RequestHandlers/AddNewFact.php b/app/Http/RequestHandlers/AddNewFact.php
@@ -43,8 +43,6 @@ class AddNewFact implements RequestHandlerInterface
     private GedcomEditService $gedcom_edit_service;
 
     /**
-     * AddNewFact constructor.
-     *
      * @param GedcomEditService $gedcom_edit_service
      */
     public function __construct(GedcomEditService $gedcom_edit_service)

diff --git a/app/Http/RequestHandlers/AddParentToIndividualAction.php b/app/Http/RequestHandlers/AddParentToIndividualAction.php
@@ -38,8 +38,6 @@ class AddParentToIndividualAction implements RequestHandlerInterface
     private GedcomEditService $gedcom_edit_service;
 
     /**
-     * AddChildToFamilyAction constructor.
-     *
      * @param GedcomEditService $gedcom_edit_service
      */
     public function __construct(GedcomEditService $gedcom_edit_service)

diff --git a/app/Http/RequestHandlers/AddParentToIndividualPage.php b/app/Http/RequestHandlers/AddParentToIndividualPage.php
@@ -41,8 +41,6 @@ class AddParentToIndividualPage implements RequestHandlerInterface
     private GedcomEditService $gedcom_edit_service;
 
     /**
-     * LinkSpouseToIndividualPage constructor.
-     *
      * @param GedcomEditService $gedcom_edit_service
      */
     public function __construct(GedcomEditService $gedcom_edit_service)

diff --git a/app/Http/RequestHandlers/AddSpouseToFamilyAction.php b/app/Http/RequestHandlers/AddSpouseToFamilyAction.php
@@ -39,8 +39,6 @@ class AddSpouseToFamilyAction implements RequestHandlerInterface
     private GedcomEditService $gedcom_edit_service;
 
     /**
-     * AddChildToFamilyAction constructor.
-     *
      * @param GedcomEditService $gedcom_edit_service
      */
     public function __construct(GedcomEditService $gedcom_edit_service)

diff --git a/app/Http/RequestHandlers/AddSpouseToFamilyPage.php b/app/Http/RequestHandlers/AddSpouseToFamilyPage.php
@@ -42,8 +42,6 @@ class AddSpouseToFamilyPage implements RequestHandlerInterface
     private GedcomEditService $gedcom_edit_service;
 
     /**
-     * LinkSpouseToIndividualPage constructor.
-     *
      * @param GedcomEditService $gedcom_edit_service
      */
     public function __construct(GedcomEditService $gedcom_edit_service)

diff --git a/app/Http/RequestHandlers/AddSpouseToIndividualAction.php b/app/Http/RequestHandlers/AddSpouseToIndividualAction.php
@@ -39,8 +39,6 @@ class AddSpouseToIndividualAction implements RequestHandlerInterface
     private GedcomEditService $gedcom_edit_service;
 
     /**
-     * AddChildToFamilyAction constructor.
-     *
      * @param GedcomEditService $gedcom_edit_service
      */
     public function __construct(GedcomEditService $gedcom_edit_service)

diff --git a/app/Http/RequestHandlers/AddSpouseToIndividualPage.php b/app/Http/RequestHandlers/AddSpouseToIndividualPage.php
@@ -49,8 +49,6 @@ class AddSpouseToIndividualPage implements RequestHandlerInterface
     private GedcomEditService $gedcom_edit_service;
 
     /**
-     * LinkSpouseToIndividualPage constructor.
-     *
      * @param GedcomEditService $gedcom_edit_service
      */
     public function __construct(GedcomEditService $gedcom_edit_service)

diff --git a/app/Http/RequestHandlers/AddUnlinkedAction.php b/app/Http/RequestHandlers/AddUnlinkedAction.php
@@ -36,8 +36,6 @@ class AddUnlinkedAction implements RequestHandlerInterface
     private GedcomEditService $gedcom_edit_service;
 
     /**
-     * AddChildToFamilyAction constructor.
-     *
      * @param GedcomEditService $gedcom_edit_service
      */
     public function __construct(GedcomEditService $gedcom_edit_service)

diff --git a/app/Http/RequestHandlers/AddUnlinkedPage.php b/app/Http/RequestHandlers/AddUnlinkedPage.php
@@ -40,8 +40,6 @@ class AddUnlinkedPage implements RequestHandlerInterface
     private GedcomEditService $gedcom_edit_service;
 
     /**
-     * LinkSpouseToIndividualPage constructor.
-     *
      * @param GedcomEditService $gedcom_edit_service
      */
     public function __construct(GedcomEditService $gedcom_edit_service)

diff --git a/app/Http/RequestHandlers/BroadcastAction.php b/app/Http/RequestHandlers/BroadcastAction.php
@@ -42,8 +42,6 @@ class BroadcastAction implements RequestHandlerInterface
     private MessageService $message_service;
 
     /**
-     * MessagePage constructor.
-     *
      * @param MessageService $message_service
      */
     public function __construct(MessageService $message_service)

diff --git a/app/Http/RequestHandlers/BroadcastPage.php b/app/Http/RequestHandlers/BroadcastPage.php
@@ -36,8 +36,6 @@ class BroadcastPage implements RequestHandlerInterface
     private MessageService $message_service;
 
     /**
-     * MessagePage constructor.
-     *
      * @param MessageService $message_service
      */
     public function __construct(MessageService $message_service)

diff --git a/app/Http/RequestHandlers/CalendarEvents.php b/app/Http/RequestHandlers/CalendarEvents.php
@@ -57,8 +57,6 @@ class CalendarEvents implements RequestHandlerInterface
     private CalendarService $calendar_service;
 
     /**
-     * CalendarPage constructor.
-     *
      * @param CalendarService $calendar_service
      */
     public function __construct(CalendarService $calendar_service)

diff --git a/app/Http/RequestHandlers/CalendarPage.php b/app/Http/RequestHandlers/CalendarPage.php
@@ -38,8 +38,6 @@ class CalendarPage implements RequestHandlerInterface
     private CalendarService $calendar_service;
 
     /**
-     * CalendarPage constructor.
-     *
      * @param CalendarService $calendar_service
      */
     public function __construct(CalendarService $calendar_service)

diff --git a/app/Http/RequestHandlers/CleanDataFolder.php b/app/Http/RequestHandlers/CleanDataFolder.php
@@ -43,8 +43,6 @@ class CleanDataFolder implements RequestHandlerInterface
     private TreeService $tree_service;
 
     /**
-     * CleanDataFolder constructor.
-     *
      * @param TreeService $tree_service
      */
     public function __construct(TreeService $tree_service)

diff --git a/app/Http/RequestHandlers/ContactAction.php b/app/Http/RequestHandlers/ContactAction.php
@@ -60,8 +60,6 @@ class ContactAction implements RequestHandlerInterface
     private UserService $user_service;
 
     /**
-     * MessagePage constructor.
-     *
      * @param CaptchaService   $captcha_service
      * @param EmailService     $email_service
      * @param MessageService   $message_service

diff --git a/app/Http/RequestHandlers/ContactPage.php b/app/Http/RequestHandlers/ContactPage.php
@@ -47,8 +47,6 @@ class ContactPage implements RequestHandlerInterface
     private UserService $user_service;
 
     /**
-     * MessagePage constructor.
-     *
      * @param CaptchaService $captcha_service
      * @param MessageService $message_service
      * @param UserService    $user_service