Qual: Fix some phan typing related to getNextValue()

# Qual: Fix some phan typing related to getNextValue() This fixes a few typings in relation to getNextValue().
Dolibarr · Aug 22, 2024 · 5d83c6b · 5d83c6b
1 parent a59e933
commit 5d83c6b
Show file tree

Hide file tree

Showing 12 changed files with 34 additions and 21 deletions.
diff --git a/htdocs/comm/propal/class/propal.class.php b/htdocs/comm/propal/class/propal.class.php
@@ -3643,7 +3643,8 @@ public function getNextNumRef($soc)
 			}
 
 			$obj = new $classname();
-			$numref = "";
+			'@phan-var-force ModeleNumRefPropales $obj';
+
 			$numref = $obj->getNextValue($soc, $this);
 
 			if ($numref != "") {

diff --git a/htdocs/commande/class/commande.class.php b/htdocs/commande/class/commande.class.php
@@ -449,6 +449,8 @@ public function getNextNumRef($soc)
 			}
 
 			$obj = new $classname();
+			'@phan-var-force ModeleNumRefCommandes $obj';
+
 			$numref = $obj->getNextValue($soc, $this);
 
 			if ($numref != "") {

diff --git a/htdocs/compta/paiement/class/paiement.class.php b/htdocs/compta/paiement/class/paiement.class.php
@@ -1212,7 +1212,8 @@ public function getNextNumRef($soc, $mode = 'next')
 			}
 
 			$obj = new $classname();
-			$numref = "";
+			'@phan-var-force ModeleNumRefPayments $obj';
+
 			$numref = $obj->getNextValue($soc, $this);
 
 			/**

diff --git a/htdocs/core/actions_massactions.inc.php b/htdocs/core/actions_massactions.inc.php
@@ -47,6 +47,13 @@
 }
 $error = 0;
 
+// Note: list of strings for objectclass could be extended to accepted/expected classes
+'
+@phan-var-force "Societe"|"Contact"|"ExpenseReport"|"Partnership"|"Holiday"|"ConferenceOrBoothAttendee"|"Facture"|"CommandeFournisseur" $objectclass
+@phan-var-force string $massaction
+';
+
+
 // For backward compatibility
 if (!empty($permtoread) && empty($permissiontoread)) {
 	$permissiontoread = $permtoread;
@@ -1780,6 +1787,7 @@
 		if (getDolGlobalString('PROJECT_TASK_ADDON') && is_readable(DOL_DOCUMENT_ROOT . "/core/modules/project/task/" . getDolGlobalString('PROJECT_TASK_ADDON') . ".php")) {
 			require_once DOL_DOCUMENT_ROOT . "/core/modules/project/task/" . getDolGlobalString('PROJECT_TASK_ADDON') . '.php';
 			$modTask = new $obj();
+			'@phan-var-force ModeleNumRefTask $modTask';
 			$defaultref = $modTask->getNextValue(0, $clone_task);
 		}
 

diff --git a/htdocs/core/class/timespent.class.php b/htdocs/core/class/timespent.class.php
@@ -953,6 +953,7 @@ public function getNextNumRef()
 
 			if (class_exists($classname)) {
 				$obj = new $classname();
+				'@phan-var-force CommonNumRefGenerator $obj';
 				$numref = $obj->getNextValue($this);
 
 				if ($numref != '' && $numref != '-1') {

diff --git a/htdocs/core/modules/bom/mod_bom_advanced.php b/htdocs/core/modules/bom/mod_bom_advanced.php
@@ -107,7 +107,7 @@ public function getExample()
 		$old_code_type = $mysoc->typent_code;
 		$mysoc->code_client = 'CCCCCCCCCC';
 		$mysoc->typent_code = 'TTTTTTTTTT';
-		$numExample = $this->getNextValue($mysoc, '');
+		$numExample = $this->getNextValue($mysoc, null);
 		$mysoc->code_client = $old_code_client;
 		$mysoc->typent_code = $old_code_type;
 
@@ -120,9 +120,9 @@ public function getExample()
 	/**
 	 * 	Return next free value
 	 *
-	 *  @param	Product			$objprod    Object product
-	 *  @param  Bom				$object		Object we need next value for
-	 *  @return string|int      			Next value if OK, 0 if KO
+	 *  @param	Product			$objprod	Object product
+	 *  @param  ?Bom			$object		Object we need next value for
+	 *  @return string|int<-1,0>			Next value if OK, 0 if KO
 	 */
 	public function getNextValue($objprod, $object)
 	{

diff --git a/htdocs/core/modules/bom/mod_bom_standard.php b/htdocs/core/modules/bom/mod_bom_standard.php
@@ -114,9 +114,9 @@ public function canBeActivated($object)
 	/**
 	 * 	Return next free value
 	 *
-	 *  @param	Product	$objprod    Object product
-	 *  @param  Bom		$object		Object we need next value for
-	 *  @return string|int<-1,-1>	Next value if OK, -1 if KO
+	 *  @param	Product		$objprod    Object product
+	 *  @param  ?Bom		$object		Object we need next value for
+	 *  @return string|int<-1,0>		Next value if OK, 0 if KO
 	 */
 	public function getNextValue($objprod, $object)
 	{

diff --git a/htdocs/core/modules/bom/modules_bom.php b/htdocs/core/modules/bom/modules_bom.php
@@ -88,9 +88,9 @@ abstract class ModeleNumRefBoms extends CommonNumRefGenerator
 	/**
 	 * 	Return next free value
 	 *
-	 *  @param	Product	$objprod    Object product
-	 *  @param  Bom		$object		Object we need next value for
-	 *  @return string|int<-1,-1>	Next value if OK, -1 if KO
+	 *  @param	Product	$objprod		Object product
+	 *  @param  ?Bom	$object			Object we need next value for
+	 *  @return string|int<-1,0>		Next value if OK, 0 if KO
 	 */
 	abstract public function getNextValue($objprod, $object);
 }
diff --git a/htdocs/core/modules/facture/mod_facture_mars.php b/htdocs/core/modules/facture/mod_facture_mars.php
@@ -160,9 +160,9 @@ public function canBeActivated($object)
 	 * Return next value not used or last value used
 	 *
 	 * @param	Societe		$objsoc		Object third party
-	 * @param   Facture		$invoice	Object invoice
+	 * @param   ?Facture	$invoice	Object invoice
 	 * @param   string		$mode		'next' for next value or 'last' for last value
-	 * @return  string|int<-1,1>		Value if OK, <=0 if KO
+	 * @return  string|int<-1,0>		Value if OK, <=0 if KO
 	 */
 	public function getNextValue($objsoc, $invoice, $mode = 'next')
 	{

diff --git a/htdocs/core/modules/facture/mod_facture_mercure.php b/htdocs/core/modules/facture/mod_facture_mercure.php
@@ -125,7 +125,7 @@ public function getExample()
 		$old_code_type = $mysoc->typent_code;
 		$mysoc->code_client = 'CCCCCCCCCC';
 		$mysoc->typent_code = 'TTTTTTTTTT';
-		$numExample = $this->getNextValue($mysoc, '');
+		$numExample = $this->getNextValue($mysoc, null);
 		$mysoc->code_client = $old_code_client;
 		$mysoc->typent_code = $old_code_type;
 
@@ -139,9 +139,9 @@ public function getExample()
 	 * Return next value not used or last value used
 	 *
 	 * @param	Societe		$objsoc		Object third party
-	 * @param   Facture		$invoice	Object invoice
+	 * @param   ?Facture	$invoice	Object invoice
 	 * @param   string		$mode		'next' for next value or 'last' for last value
-	 * @return  string|int<-1,1>		Value if OK, <=0 if KO
+	 * @return  string|int<-1,0>		Value if OK, <=0 if KO
 	 */
 	public function getNextValue($objsoc, $invoice, $mode = 'next')
 	{

diff --git a/htdocs/core/modules/facture/mod_facture_terre.php b/htdocs/core/modules/facture/mod_facture_terre.php
@@ -201,9 +201,9 @@ public function canBeActivated($object)
 	 * ALTER TABLE llx_facture ADD INDEX calculated_numrefonly_idx (calculated_numrefonly);
 	 *
 	 * @param	Societe		$objsoc		Object third party
-	 * @param   Facture		$invoice	Object invoice
+	 * @param   ?Facture	$invoice	Object invoice
 	 * @param   string		$mode		'next' for next value or 'last' for last value
-	 * @return  string|int<-1,1>		Value if OK, <=0 if KO
+	 * @return  string|int<-1,0>		Value if OK, <=0 if KO
 	 */
 	public function getNextValue($objsoc, $invoice, $mode = 'next')
 	{

diff --git a/htdocs/core/modules/facture/modules_facture.php b/htdocs/core/modules/facture/modules_facture.php
@@ -272,9 +272,9 @@ abstract class ModeleNumRefFactures extends CommonNumRefGenerator
 	 * Return next value not used or last value used
 	 *
 	 * @param	Societe		$objsoc		Object third party
-	 * @param   Facture		$invoice	Object invoice
+	 * @param   ?Facture	$invoice	Object invoice
 	 * @param   string		$mode		'next' for next value or 'last' for last value
-	 * @return  string|int<-1,1>		Value if OK, <=0 if KO
+	 * @return  string|int<-1,0>		Value if OK, <=0 if KO
 	 */
 	abstract public function getNextValue($objsoc, $invoice, $mode = 'next');
 }