#30 [Mod] fix: clean mod class files

Evarisk · Nov 3, 2022 · d04faef · d04faef
1 parent 290db95
commit d04faef
Show file tree

Hide file tree

Showing 7 changed files with 20 additions and 29 deletions.
diff --git a/core/modules/dolisirh/certificate/mod_certificate_standard.php b/core/modules/dolisirh/certificate/mod_certificate_standard.php
@@ -30,11 +30,14 @@
 class mod_certificate_standard extends ModeleNumRefDoliSIRH
 {
 	/**
-	 * Dolibarr version of the loaded document
+	 * Dolibarr version of the loaded numbering module ref
 	 * @var string
 	 */
 	public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr'
 
+    /**
+     * @var string numbering module ref prefix
+     */
 	public $prefix = 'CERT';
 
 	/**
@@ -87,8 +90,6 @@ public function canBeActivated(object $object): bool
 		$sql .= " WHERE ref LIKE '".$db->escape($this->prefix)."____-%'";
 		if ($object->ismultientitymanaged == 1) {
 			$sql .= " AND entity = ".$conf->entity;
-		} elseif ($object->ismultientitymanaged == 2) {
-			// TODO
 		}
 
 		$resql = $db->query($sql);
@@ -125,8 +126,6 @@ public function getNextValue(object $object)
 		$sql .= " WHERE ref LIKE '".$db->escape($this->prefix)."____-%'";
 		if ($object->ismultientitymanaged == 1) {
 			$sql .= " AND entity = ".$conf->entity;
-		} elseif ($object->ismultientitymanaged == 2) {
-			// TODO
 		}
 
 		$resql = $db->query($sql);

diff --git a/...dules/dolisirh/dolisirhdocuments/certificatedocument/mod_certificatedocument_standard.php b/...dules/dolisirh/dolisirhdocuments/certificatedocument/mod_certificatedocument_standard.php
@@ -49,7 +49,7 @@ class mod_certificatedocument_standard
 	public $name = 'Skrymir';
 
 	/**
-	 *  Return description of numbering module
+	 *  Return description of document
 	 *
 	 *  @return string Text with description
 	 */
@@ -71,7 +71,7 @@ public function isEnabled(): bool
 	}
 
 	/**
-	 *  Return an example of numbering
+	 *  Return an example of document
 	 *
 	 *  @return string Example
 	 */
@@ -82,7 +82,7 @@ public function getExample(): string
 
 	/**
 	 *  Checks if the numbers already in the database do not
-	 *  cause conflicts that would prevent this numbering working.
+	 *  cause conflicts that would prevent this document working.
 	 *
 	 *  @param  Object  $object	Object we need next value for
 	 *  @return boolean         false if are conflict, true if ok
@@ -169,7 +169,7 @@ public function getNextValue(object $object)
 	}
 
 	/**
-	 *	Returns version of numbering module
+	 *	Returns version of document
 	 *
 	 *	@return string Value
 	 */

diff --git a/core/modules/dolisirh/dolisirhdocuments/certificatedocument/modules_certificatedocument.php b/core/modules/dolisirh/dolisirhdocuments/certificatedocument/modules_certificatedocument.php
@@ -22,7 +22,7 @@
  *  \brief			File that contains parent class for certificates document models
  */
 
-require_once DOL_DOCUMENT_ROOT.'/core/class/commondocgenerator.class.php';
+require_once DOL_DOCUMENT_ROOT . '/core/class/commondocgenerator.class.php';
 
 /**
  *	Parent class for documents models

diff --git a/core/modules/dolisirh/dolisirhdocuments/timesheetdocument/mod_timesheetdocument_standard.php b/core/modules/dolisirh/dolisirhdocuments/timesheetdocument/mod_timesheetdocument_standard.php
@@ -49,7 +49,7 @@ class mod_timesheetdocument_standard
 	public $name = 'Égéon';
 
 	/**
-	 *  Return description of numbering module
+	 *  Return description of document
 	 *
 	 *  @return string Text with description
 	 */
@@ -71,7 +71,7 @@ public function isEnabled(): bool
 	}
 
 	/**
-	 *  Return an example of numbering
+	 *  Return an example of document
 	 *
 	 *  @return string Example
 	 */
@@ -82,7 +82,7 @@ public function getExample(): string
 
 	/**
 	 *  Checks if the numbers already in the database do not
-	 *  cause conflicts that would prevent this numbering working.
+	 *  cause conflicts that would prevent this document working.
 	 *
 	 *  @param  Object  $object	Object we need next value for
 	 *  @return boolean         false if are conflict, true if ok
@@ -99,8 +99,6 @@ public function canBeActivated(object $object): bool
 		$sql .= " WHERE ref LIKE '".$db->escape($this->prefix)."____-%'";
 		if ($object->ismultientitymanaged == 1) {
 			$sql .= " AND entity = ".$conf->entity;
-		} elseif ($object->ismultientitymanaged == 2) {
-			// TODO
 		}
 
 		$resql = $db->query($sql);
@@ -137,8 +135,6 @@ public function getNextValue(object $object)
 		$sql .= " WHERE ref LIKE '".$db->escape($this->prefix)."____-%'";
 		if ($object->ismultientitymanaged == 1) {
 			$sql .= " AND entity = ".$conf->entity;
-		} elseif ($object->ismultientitymanaged == 2) {
-			// TODO
 		}
 
 		$resql = $db->query($sql);
@@ -169,7 +165,7 @@ public function getNextValue(object $object)
 	}
 
 	/**
-	 *	Returns version of numbering module
+	 *	Returns version of document
 	 *
 	 *	@return string Value
 	 */

diff --git a/core/modules/dolisirh/dolisirhdocuments/timesheetdocument/modules_timesheetdocument.php b/core/modules/dolisirh/dolisirhdocuments/timesheetdocument/modules_timesheetdocument.php
@@ -22,7 +22,7 @@
  *  \brief			File that contains parent class for timesheet document models and parent class for timesheet numbering models
  */
 
-require_once DOL_DOCUMENT_ROOT.'/core/class/commondocgenerator.class.php';
+require_once DOL_DOCUMENT_ROOT . '/core/class/commondocgenerator.class.php';
 
 /**
  *	Parent class for documents models

diff --git a/core/modules/dolisirh/timesheet/mod_timesheet_standard.php b/core/modules/dolisirh/timesheet/mod_timesheet_standard.php
@@ -30,13 +30,13 @@
 class mod_timesheet_standard extends ModeleNumRefDoliSIRH
 {
 	/**
-	 * Dolibarr version of the loaded document
+	 * Dolibarr version of the loaded numbering module ref
 	 * @var string
 	 */
 	public $version = 'dolibarr'; // 'development', 'experimental', 'dolibarr'
 
 	/**
-	 * @var string document prefix
+	 * @var string numbering module ref prefix
 	 */
 	public $prefix = 'TR';
 
@@ -91,8 +91,6 @@ public function canBeActivated(object $object): bool
 		$sql .= " WHERE ref LIKE '".$db->escape($this->prefix)."____-%'";
 		if ($object->ismultientitymanaged == 1) {
 			$sql .= " AND entity = ".$conf->entity;
-		} elseif ($object->ismultientitymanaged == 2) {
-			// TODO
 		}
 
 		$resql = $db->query($sql);
@@ -129,8 +127,6 @@ public function getNextValue(object $object)
 		$sql .= " WHERE ref LIKE '".$db->escape($this->prefix)."____-%'";
 		if ($object->ismultientitymanaged == 1) {
 			$sql .= " AND entity = ".$conf->entity;
-		} elseif ($object->ismultientitymanaged == 2) {
-			// TODO
 		}
 
 		$resql = $db->query($sql);

diff --git a/dolisirhindex.php b/dolisirhindex.php
@@ -45,18 +45,18 @@
 // Load translation files required by the page
 $langs->loadLangs(array("dolisirh@dolisirh"));
 
-// Parameters
+// Get parameters
 $action = GETPOST('action', 'alpha');
 
 // Initialize technical objects
 $dolisirh = new modDoliSIRH($db);
 
 // Security check
-if (! $user->rights->dolisirh->lire) accessforbidden();
+if (!$user->rights->dolisirh->lire) accessforbidden();
 
 /*
- *  Actions
-*/
+ * Actions
+ */
 
 require_once './core/tpl/dolisirh_projectcreation_action.tpl.php';