Global types changes on common classes that will impact many subclasses (#21854)

Author: trasher

src/CommonDBChild.php

@@ -53,14 +53,22 @@ abstract class CommonDBChild extends CommonDBConnexity
     /** @var string $items_id */
     public static $items_id; // Field name
     // * rights
+    /** @var CommonDBConnexity::DONT_CHECK_ITEM_RIGHTS|CommonDBConnexity::HAVE_VIEW_RIGHT_ON_ITEM|CommonDBConnexity::HAVE_SAME_RIGHT_ON_ITEM */
     public static $checkParentRights  = self::HAVE_SAME_RIGHT_ON_ITEM;
+    /** @var bool */
     public static $mustBeAttached     = true;
     // * log
+    /** @var bool */
     public static $logs_for_parent    = true;
+    /** @var Log::HISTORY_* */
     public static $log_history_add    = Log::HISTORY_ADD_SUBITEM;
+    /** @var Log::HISTORY_* */
     public static $log_history_update = Log::HISTORY_UPDATE_SUBITEM;
+    /** @var Log::HISTORY_* */
     public static $log_history_delete = Log::HISTORY_DELETE_SUBITEM;
+    /** @var Log::HISTORY_* */
     public static $log_history_lock   = Log::HISTORY_LOCK_SUBITEM;
+    /** @var Log::HISTORY_* */
     public static $log_history_unlock = Log::HISTORY_UNLOCK_SUBITEM;
 
 

src/CommonDBConnexity.php

@@ -77,8 +77,14 @@ abstract class CommonDBConnexity extends CommonDBTM
     public const HAVE_VIEW_RIGHT_ON_ITEM = 2; // canXXXChild = true if parent::canView == true
     public const HAVE_SAME_RIGHT_ON_ITEM = 3; // canXXXChild = true if parent::canXXX == true
 
+    /** @var bool */
     public static $canDeleteOnItemClean          = true;
-    /// Disable auto forwarding information about entities ?
+
+    /**
+     * Disable auto forwarding information about entities?
+     *
+     * @var bool
+     */
     public static $disableAutoEntityForwarding   = false;
 
 

src/CommonDBRelation.php

@@ -51,16 +51,25 @@ abstract class CommonDBRelation extends CommonDBConnexity
     /** @var ?string $items_id_1 */
     public static $items_id_1; // Field name
     // * entity inheritance
+    /** @var bool */
     public static $take_entity_1          = true;
     // * rights
+    /** @var CommonDBConnexity::DONT_CHECK_ITEM_RIGHTS|CommonDBConnexity::HAVE_VIEW_RIGHT_ON_ITEM|CommonDBConnexity::HAVE_SAME_RIGHT_ON_ITEM */
     public static $checkItem_1_Rights     = self::HAVE_SAME_RIGHT_ON_ITEM;
+    /** @var bool */
     public static $mustBeAttached_1       = true;
     // * log
+    /** @var bool */
     public static $logs_for_item_1        = true;
+    /** @var Log::HISTORY_* */
     public static $log_history_1_add      = Log::HISTORY_ADD_RELATION;
+    /** @var Log::HISTORY_* */
     public static $log_history_1_update   = Log::HISTORY_UPDATE_RELATION;
+    /** @var Log::HISTORY_* */
     public static $log_history_1_delete   = Log::HISTORY_DEL_RELATION;
+    /** @var Log::HISTORY_* */
     public static $log_history_1_lock     = Log::HISTORY_LOCK_RELATION;
+    /** @var Log::HISTORY_* */
     public static $log_history_1_unlock   = Log::HISTORY_UNLOCK_RELATION;
 
     // Item 2 information
@@ -70,24 +79,36 @@ abstract class CommonDBRelation extends CommonDBConnexity
     /** @var ?string $items_id_2 */
     public static $items_id_2; // Field name
     // * entity inheritance
+    /** @var bool */
     public static $take_entity_2          = false;
     // * rights
+    /** @var CommonDBConnexity::DONT_CHECK_ITEM_RIGHTS|CommonDBConnexity::HAVE_VIEW_RIGHT_ON_ITEM|CommonDBConnexity::HAVE_SAME_RIGHT_ON_ITEM */
     public static $checkItem_2_Rights     = self::HAVE_SAME_RIGHT_ON_ITEM;
+    /** @var bool  */
     public static $mustBeAttached_2       = true;
     // * log
+    /** @var bool */
     public static $logs_for_item_2        = true;
+    /** @var Log::HISTORY_* */
     public static $log_history_2_add      = Log::HISTORY_ADD_RELATION;
+    /** @var Log::HISTORY_* */
     public static $log_history_2_update   = Log::HISTORY_UPDATE_RELATION;
+    /** @var Log::HISTORY_* */
     public static $log_history_2_delete   = Log::HISTORY_DEL_RELATION;
+    /** @var Log::HISTORY_* */
     public static $log_history_2_lock     = Log::HISTORY_LOCK_RELATION;
+    /** @var Log::HISTORY_* */
     public static $log_history_2_unlock   = Log::HISTORY_UNLOCK_RELATION;
 
     // Relation between items to check
     /// If both items must be checked for rights (default is only one)
+    /** @var bool */
     public static $checkAlwaysBothItems   = false;
     /// If both items must be in viewable each other entities
+    /** @var bool */
     public static $check_entity_coherency = true;
 
+    /** @var bool */
     public $no_form_page                  = true;
 
     /**
@@ -98,7 +119,7 @@ abstract class CommonDBRelation extends CommonDBConnexity
     protected $_force_log_option = 0;
 
     /**
-     * Get request cirteria to search for an item
+     * Get request criteria to search for an item
      *
      * @since 9.4
      *

src/CommonDropdown.php

@@ -47,10 +47,18 @@ abstract class CommonDropdown extends CommonDBTM
     // From CommonDBTM
     public $dohistory                   = true;
 
-    // For delete operation (entity will overload this value)
+    /**
+     * For delete operation (entity will overload this value)
+     *
+     * @var bool
+     */
     public $must_be_replace = false;
 
-    //Menu & navigation
+    /**
+     * Menu & navigation
+     *
+     * @var bool
+     */
     public $display_dropdowntitle  = true;
 
     //This dropdown can be translated