Doxygen

htdocs/core/class/commonobject.class.php

@@ -35,45 +35,67 @@
  */
 abstract class CommonObject
 {
-    public $db;
+    /**
+     * @var db			Database handler (result of a new DoliDB)
+     */
+	public $db;
 
     /**
-     * @var error 	Error string
-     * @deprecated	Use instead the array of error strings
+     * @var error 		Error string
+     * @deprecated		Use instead the array of error strings
      */
     public $error;
 
     /**
-     * @var errors	Aray of error string
+     * @var errors		Array of error string
      */
     public $errors;
 
-    public $canvas;                // Contains canvas name if it is
-	public $context=array();		// Use to pass context information
+    /**
+     * @var string		Column name of the ref field.
+     */
+    protected $table_ref_field = '';
 
-    public $name;
-    public $lastname;
-    public $firstname;
-    public $civility_id;
-    public $import_key;
+    /**
+     * @var context		Can be used to pass information when only object is provied to method
+     */
+    public $context=array();
 
-    public $array_options=array();
+    /**
+     * @var context		Contains canvas name if record is an alternative canvas record
+     */
+    public $canvas;
 
     /**
-     * @var Societe
+     * @var import_key	Key value used to track if data is coming from import wizard
      */
-    public $thirdparty;
+    public $import_key;
 
-    public $linkedObjectsIds;	// Loaded by ->fetchObjectLinked
-    public $linkedObjects;		// Loaded by ->fetchObjectLinked
+    /**
+     * @var array_options	Contains data to manage extrafields
+     */
+    public $array_options=array();
 
-    // No constructor as it is an abstract class
+    /**
+     * @var linkedObjectsIds	Array of linked objects ids. Loaded by ->fetchObjectLinked
+     */
+    public $linkedObjectsIds;
 
     /**
-     * Column name of the ref field.
-     * @var string
+     * @var linkedObjectsIds	Array of linked objects. Loaded by ->fetchObjectLinked
      */
-    protected $table_ref_field = '';
+    public $linkedObjects;
+
+
+    // Following var are used by some objects only. We keep this property here in CommonObject to be able to provide common method using them.
+
+    public $name;
+    public $lastname;
+    public $firstname;
+    public $civility_id;
+    public $thirdparty;
+
+    // No constructor as it is an abstract class
 
 
     /**

htdocs/core/class/fiscalyear.class.php

@@ -26,7 +26,7 @@ require_once DOL_DOCUMENT_ROOT .'/core/class/commonobject.class.php';
 /**
  * Class to manage fiscal year
  */
-class Fiscalyear
+class Fiscalyear extends CommonObject
 {
 	public $element='fiscalyear';
 	public $table_element='accounting_fiscalyear';