浏览代码

Standardize and update code

Philippe GRAND 6 年之前
父节点
当前提交
3a8bde227b

+ 5 - 0
htdocs/asset/class/asset.class.php

@@ -111,7 +111,12 @@ class Asset extends CommonObject
 
 	public $amount;
 	public $fk_soc;
+
+	/**
+	 * @var string description
+	 */
 	public $description;
+
 	public $note_public;
 	public $note_private;
 	public $date_creation;

+ 10 - 6
htdocs/categories/class/categorie.class.php

@@ -152,20 +152,24 @@ class Categorie extends CommonObject
 	 * @var string ID to identify managed object
 	 */
 	public $element='category';
-	
+
 	/**
 	 * @var string Name of table without prefix where object is stored
 	 */
 	public $table_element='categorie';
 
 	public $fk_parent;
-	
+
 	/**
-     	 * @var string proper name for given parameter
-     	 */
-    	public $label;
-    
+     * @var string proper name for given parameter
+     */
+   	public $label;
+
+	/**
+	 * @var string description
+	 */
 	public $description;
+
 	/**
 	 * @var string     Color
 	 */

+ 4 - 1
htdocs/contrat/class/contrat.class.php

@@ -2498,7 +2498,10 @@ class ContratLigne extends CommonObjectLine
 	 */
 	public $libelle;
 
-	var $description;
+	/**
+	 * @var string description
+	 */
+	public $description;
 
 	var $product_ref;
 	var $product_label;

+ 3 - 0
htdocs/core/class/comment.class.php

@@ -34,6 +34,9 @@ class Comment extends CommonObject
 	public $fk_element;
 	public $element_type;
 
+	/**
+	 * @var string description
+	 */
 	public $description;
 
 	public $tms;

+ 5 - 1
htdocs/core/class/discount.class.php

@@ -51,7 +51,11 @@ class DiscountAbsolute
 	 */
 	public $fk_user;
 
-    public $description;			// Description libre
+    /**
+	 * @var string description
+	 */
+	public $description;
+
     public $datec;					// Date creation
     public $fk_facture_line;  		// Id invoice line when a discount is used into an invoice line (for absolute discounts)
     public $fk_facture;			    // Id invoice when a discount line is used into an invoice (for credit note)

+ 5 - 1
htdocs/core/class/events.class.php

@@ -63,7 +63,11 @@ class Events // extends CommonObject
 	var $type;
 	var $entity;
 	var $dateevent;
-	var $description;
+
+	/**
+	 * @var string description
+	 */
+	public $description;
 
 	// List of all Audit/Security events supported by triggers
 	var $eventstolog=array(

+ 7 - 3
htdocs/core/modules/action/rapport.pdf.php

@@ -39,8 +39,12 @@ class CommActionRapport
      * @var DoliDB Database handler.
      */
     public $db;
-    
-	var $description;
+
+	/**
+	 * @var string description
+	 */
+	public $description;
+
 	var $date_edition;
 	var $year;
 	var $month;
@@ -103,7 +107,7 @@ class CommActionRapport
 		if (! is_object($outputlangs)) $outputlangs=$langs;
 		// For backward compatibility with FPDF, force output charset to ISO, because FPDF expect text to be encoded in ISO
 		if (! empty($conf->global->MAIN_USE_FPDF)) $outputlangs->charset_output='ISO-8859-1';
-        
+
 		// Load traductions files requiredby by page
 		$outputlangs->loadLangs(array("main", "dict", "companies", "bills", "products"));
 

+ 6 - 1
htdocs/ecm/class/ecmdirectory.class.php

@@ -50,7 +50,12 @@ class EcmDirectory // extends CommonObject
     public $label;
 
 	var $fk_parent;
-	var $description;
+
+	/**
+	 * @var string description
+	 */
+	public $description;
+
 	var $cachenbofdoc=-1;	// By default cache initialized with value 'not calculated'
 	var $date_c;
 	var $date_m;

+ 10 - 0
htdocs/ecm/class/ecmfiles.class.php

@@ -64,7 +64,12 @@ class EcmFiles extends CommonObject
 	public $filename;
 	public $filepath;
 	public $fullpath_orig;
+
+	/**
+	 * @var string description
+	 */
 	public $description;
+
 	public $keywords;
 	public $cover;
 	public $position;
@@ -848,7 +853,12 @@ class EcmfilesLine
 	public $filename;
 	public $filepath;
 	public $fullpath_orig;
+
+	/**
+	 * @var string description
+	 */
 	public $description;
+
 	public $keywords;
 	public $cover;
 	public $position;

+ 11 - 6
htdocs/fichinter/class/fichinter.class.php

@@ -39,12 +39,12 @@ class Fichinter extends CommonObject
 	 * @var string ID to identify managed object
 	 */
 	public $element='fichinter';
-	
+
 	/**
 	 * @var string Name of table without prefix where object is stored
 	 */
 	public $table_element='fichinter';
-	
+
 	public $fk_element='fk_fichinter';
 	public $table_element_line='fichinterdet';
 	public $picto = 'intervention';
@@ -65,7 +65,12 @@ class Fichinter extends CommonObject
 	var $datem;
 	var $duration;
 	var $statut = 0;		// 0=draft, 1=validated, 2=invoiced, 3=Terminate
-	var $description;
+
+	/**
+	 * @var string description
+	 */
+	public $description;
+
 	var $fk_contrat = 0;
 	var $fk_project = 0;
 	var $extraparams=array();
@@ -1321,7 +1326,7 @@ class FichinterLigne extends CommonObjectLine
      * @var DoliDB Database handler.
      */
     public $db;
-	
+
 	/**
 	 * @var string Error code (or message)
 	 */
@@ -1338,12 +1343,12 @@ class FichinterLigne extends CommonObjectLine
 	 * @var string ID to identify managed object
 	 */
 	public $element='fichinterdet';
-	
+
 	/**
 	 * @var string Name of table without prefix where object is stored
 	 */
 	public $table_element='fichinterdet';
-	
+
 	public $fk_element='fk_fichinter';
 
 	/**

+ 6 - 1
htdocs/holiday/class/holiday.class.php

@@ -58,7 +58,12 @@ class Holiday extends CommonObject
 	public $fk_user;
 
 	var $date_create='';
-	var $description;
+
+	/**
+	 * @var string description
+	 */
+	public $description;
+
 	var $date_debut='';			// Date start in PHP server TZ
 	var $date_fin='';			// Date end in PHP server TZ
 	var $date_debut_gmt='';		// Date start in GMT

+ 11 - 7
htdocs/livraison/class/livraison.class.php

@@ -43,14 +43,14 @@ class Livraison extends CommonObject
 	 * @var string ID to identify managed object
 	 */
 	public $element="delivery";
-	
+
 	public $fk_element="fk_livraison";
-	
+
 	/**
 	 * @var string Name of table without prefix where object is stored
 	 */
 	public $table_element="livraison";
-	
+
 	public $table_element_line="livraisondet";
 
 	var $brouillon;
@@ -1078,13 +1078,17 @@ class LivraisonLigne extends CommonObjectLine
 	var $price;
 	var $fk_product;
 	var $origin_id;
-	
+
     /**
      * @var string proper name for given parameter
      */
     public $label;
-    
-	var $description;  // Description produit
+
+	/**
+	 * @var string description produit
+	 */
+	public $description;
+
 	/**
 	 * @deprecated
 	 * @see product_ref
@@ -1103,7 +1107,7 @@ class LivraisonLigne extends CommonObjectLine
 	 * @var string ID to identify managed object
 	 */
 	public $element='livraisondet';
-	
+
 	/**
 	 * @var string Name of table without prefix where object is stored
 	 */

+ 4 - 0
htdocs/opensurvey/class/opensurveysondage.class.php

@@ -52,6 +52,10 @@ class Opensurveysondage extends CommonObject
 	 * @see description
 	 */
 	public $commentaires;
+
+	/**
+	 * @var string description
+	 */
 	public $description;
 
 	public $mail_admin;

+ 11 - 6
htdocs/product/dynamic_price/class/price_global_variable.class.php

@@ -33,26 +33,31 @@ class PriceGlobalVariable
      * @var DoliDB Database handler.
      */
     public $db;
-   
+
     /**
 	 * @var string Error code (or message)
 	 */
 	public $error='';
-	
+
     /**
 	 * @var string[] Error codes (or messages)
 	 */
 	public $errors = array();
-	
+
     /**
 	 * @var int ID
 	 */
 	public $id;
-	
+
     var $code;
-    var $description;
+
+    /**
+	 * @var string description
+	 */
+	public $description;
+
     var $value;
-    
+
     /**
 	 * @var string Name of table without prefix where object is stored
 	 */

+ 12 - 7
htdocs/product/dynamic_price/class/price_global_variable_updater.class.php

@@ -33,33 +33,38 @@ class PriceGlobalVariableUpdater
      * @var DoliDB Database handler.
      */
     public $db;
-    
+
     /**
 	 * @var string Error code (or message)
 	 */
 	public $error='';
-	
+
     /**
 	 * @var string[] Error codes (or messages)
 	 */
 	public $errors = array();
-	
+
     var $types=array(0, 1);				//!< Updater types
     var $update_min = 5;				//!< Minimal update rate
-    
+
     /**
 	 * @var int ID
 	 */
 	public $id;
-	
+
     var $type;
-    var $description;
+
+    /**
+	 * @var string description
+	 */
+	public $description;
+
     var $parameters;
     var $fk_variable;
     var $update_interval;				//!< Interval in mins
     var $next_update;					//!< Next update timestamp
     var $last_status;
-    
+
     /**
 	 * @var string Name of table without prefix where object is stored
 	 */

+ 8 - 3
htdocs/product/stock/class/entrepot.class.php

@@ -37,12 +37,12 @@ class Entrepot extends CommonObject
 	 * @var string ID to identify managed object
 	 */
 	public $element='stock';
-	
+
 	/**
 	 * @var string Name of table without prefix where object is stored
 	 */
 	public $table_element='entrepot';
-	
+
 	public $picto='stock';
 
 	/**
@@ -61,7 +61,12 @@ class Entrepot extends CommonObject
 	const STATUS_OPEN_INTERNAL = 2;
 
 	var $libelle;
-	var $description;
+
+	/**
+	 * @var string description
+	 */
+	public $description;
+
 	var $statut;
 	var $lieu;
 	var $address;

+ 5 - 1
htdocs/projet/class/project.class.php

@@ -53,7 +53,11 @@ class Project extends CommonObject
      */
     protected $table_ref_field = 'ref';
 
-    var $description;
+    /**
+	 * @var string description
+	 */
+	public $description;
+
 	/**
 	 * @var string
 	 * @deprecated

+ 5 - 1
htdocs/projet/class/task.class.php

@@ -52,7 +52,11 @@ class Task extends CommonObject
      */
     public $label;
 
-	var $description;
+	/**
+	 * @var string description
+	 */
+	public $description;
+
 	var $duration_effective;		// total of time spent on this task
 	var $planned_workload;
 	var $date_c;

+ 9 - 5
htdocs/ticket/class/actions_ticket.class.php

@@ -39,21 +39,21 @@ class ActionsTicket
      * @var DoliDB Database handler.
      */
     public $db;
-    
+
     public $dao;
 
     public $mesg;
-    
+
     /**
 	 * @var string Error code (or message)
 	 */
 	public $error;
-	
+
     /**
 	 * @var string[] Error codes (or messages)
 	 */
 	public $errors = array();
-	
+
     //! Numero de l'erreur
     public $errno = 0;
 
@@ -61,7 +61,11 @@ class ActionsTicket
     public $template;
 
     public $label;
-    public $description;
+
+    /**
+	 * @var string description
+	 */
+	public $description;
 
     public $fk_statut;
     public $fk_soc;

+ 7 - 2
htdocs/website/class/websitepage.class.php

@@ -39,12 +39,12 @@ class WebsitePage extends CommonObject
 	 * @var string Id to identify managed objects
 	 */
 	public $element = 'websitepage';
-	
+
 	/**
 	 * @var string Name of table without prefix where object is stored
 	 */
 	public $table_element = 'website_page';
-	
+
 	/**
 	 * @var string String with name of icon for websitepage. Must be the part after the 'object_' into object_myobject.png
 	 */
@@ -55,7 +55,12 @@ class WebsitePage extends CommonObject
 	public $aliasalt;
 	public $type_container;
 	public $title;
+
+	/**
+	 * @var string description
+	 */
 	public $description;
+
 	public $keywords;
 	public $htmlheader;
 	public $content;