Unify and improve PHPDocs for class properties

kitodo · Sep 27, 2023 · 5ee773f · 5ee773f
1 parent db4ecb1
commit 5ee773f
Show file tree

Hide file tree

Showing 54 changed files with 405 additions and 504 deletions.
diff --git a/Classes/Api/Orcid/Client.php b/Classes/Api/Orcid/Client.php
@@ -29,44 +29,42 @@
 class Client
 {
     /**
-     * constants for API endpoint
+     * @var string constant for API hostname endpoint
      **/
     const HOSTNAME  = 'orcid.org';
+
+    /**
+     * @var string constant for API version endpoint
+     **/
     const VERSION   = '3.0';
 
     /**
-     * This holds the logger
-     *
-     * @var Logger
      * @access protected
+     * @var Logger This holds the logger
      */
     protected $logger;
 
     /**
-     * The ORCID API endpoint
-     *
-     * @var string
+     * @access private
+     * @var string The ORCID API endpoint
      **/
     private $endpoint = 'record';
 
     /**
-     * The ORCID API access level
-     *
-     * @var string
+     * @access private
+     * @var string The ORCID API access level
      **/
     private $level = 'pub';
 
     /**
-     * The ORCID ID to search for
-     *
-     * @var string
+     * @access private
+     * @var string The ORCID ID to search for
      **/
     private $orcid = null;
 
     /**
-     * The request object
-     *
-     * @var RequestFactoryInterface
+     * @access private
+     * @var RequestFactoryInterface The request object
      **/
     private $requestFactory = null;
 

diff --git a/Classes/Api/Orcid/Profile.php b/Classes/Api/Orcid/Profile.php
@@ -29,25 +29,20 @@
 class Profile
 {
     /**
-     * This holds the logger
-     *
-     * @var Logger
      * @access protected
+     * @var Logger This holds the logger
      */
     protected $logger;
 
     /**
-     * This holds the client
-     *
-     * @var Client
-     * @access protected
+     * @access private
+     * @var Client This holds the client
      */
-    protected $client;
+    private $client;
 
     /**
-     * The raw ORCID profile
-     *
-     * @var \SimpleXmlElement|false
+     * @access private
+     * @var \SimpleXmlElement|false The raw ORCID profile
      **/
     private $raw = null;
 

diff --git a/Classes/Api/Viaf/Client.php b/Classes/Api/Viaf/Client.php
@@ -29,31 +29,26 @@
 class Client
 {
     /**
-     * This holds the logger
-     *
-     * @var Logger
      * @access protected
+     * @var Logger This holds the logger
      */
     protected $logger;
 
     /**
-     * The ORCID API endpoint
-     *
-     * @var string
+     * @access private
+     * @var string The VIAF API endpoint
      **/
     private $endpoint = 'viaf.xml';
 
     /**
-     * The VIAF URL for the profile
-     *
-     * @var string
+     * @access private
+     * @var string The VIAF URL for the profile
      **/
     private $viafUrl = null;
 
     /**
-     * The request object
-     *
-     * @var RequestFactoryInterface
+     * @access private
+     * @var RequestFactoryInterface The request object
      **/
     private $requestFactory = null;
 

diff --git a/Classes/Api/Viaf/Profile.php b/Classes/Api/Viaf/Profile.php
@@ -29,25 +29,20 @@
 class Profile
 {
     /**
-     * This holds the logger
-     *
-     * @var Logger
-     * @access protected
+     * @access private
+     * @var Logger This holds the logger
      */
     protected $logger;
 
     /**
-     * This holds the client
-     *
-     * @var Client
-     * @access protected
+     * @access private
+     * @var Client This holds the client
      */
-    protected $client;
+    private $client;
 
     /**
-     * The raw VIAF profile
-     *
-     * @var \SimpleXmlElement|false
+     * @access private
+     * @var \SimpleXmlElement|false The raw VIAF profile or false if not found
      **/
     private $raw = null;
 

diff --git a/Classes/Command/BaseCommand.php b/Classes/Command/BaseCommand.php
@@ -43,38 +43,44 @@
 class BaseCommand extends Command
 {
     /**
+     * @access protected
      * @var CollectionRepository
      */
     protected $collectionRepository;
 
     /**
+     * @access protected
      * @var DocumentRepository
      */
     protected $documentRepository;
 
     /**
+     * @access protected
      * @var LibraryRepository
      */
     protected $libraryRepository;
 
     /**
+     * @access protected
      * @var StructureRepository
      */
     protected $structureRepository;
 
     /**
+     * @access protected
      * @var int
      */
     protected $storagePid;
 
     /**
+     * @access protected
      * @var \Kitodo\Dlf\Domain\Model\Library
      */
     protected $owner;
 
     /**
-     * @var array
      * @access protected
+     * @var array
      */
     protected $extConf;