From 154f0c7e8d9c51f4898089ca48f61b809be2990f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20FRANCE?= Date: Tue, 24 Nov 2020 21:28:57 +0100 Subject: [PATCH] doxygen --- htdocs/bom/class/bom.class.php | 70 ++++++++++++++++++++++- htdocs/bookmarks/class/bookmark.class.php | 6 ++ htdocs/ecm/class/ecmfiles.class.php | 63 ++++++++++++++++---- 3 files changed, 125 insertions(+), 14 deletions(-) diff --git a/htdocs/bom/class/bom.class.php b/htdocs/bom/class/bom.class.php index 192acc22d83..2689a1a69e6 100644 --- a/htdocs/bom/class/bom.class.php +++ b/htdocs/bom/class/bom.class.php @@ -112,13 +112,31 @@ class BOM extends CommonObject 'model_pdf' =>array('type'=>'varchar(255)', 'label'=>'Model pdf', 'enabled'=>1, 'visible'=>0, 'position'=>1010), 'status' => array('type'=>'integer', 'label'=>'Status', 'enabled'=>1, 'visible'=>2, 'position'=>1000, 'notnull'=>1, 'default'=>0, 'index'=>1, 'arrayofkeyval'=>array(0=>'Draft', 1=>'Enabled', 9=>'Disabled')), ); + + /** + * @var int rowid + */ public $rowid; + + /** + * @var string ref + */ public $ref; + + /** + * @var string label + */ public $label; + + /** + * @var int bomtype + */ public $bomtype; + + /** + * @var string description + */ public $description; - public $note_public; - public $note_private; /** * @var integer|string date_creation @@ -127,10 +145,30 @@ class BOM extends CommonObject public $tms; + + /** + * @var int Id User creator + */ public $fk_user_creat; + + /** + * @var int Id User modifying + */ public $fk_user_modif; + + /** + * @var string import key + */ public $import_key; + + /** + * @var int status + */ public $status; + + /** + * @var int product Id + */ public $fk_product; public $qty; public $efficiency; @@ -1097,15 +1135,43 @@ class BOMLine extends CommonObjectLine 'position' => array('type'=>'integer', 'label'=>'Rank', 'enabled'=>1, 'visible'=>0, 'default'=>0, 'position'=>200, 'notnull'=>1,), 'import_key' => array('type'=>'varchar(14)', 'label'=>'ImportId', 'enabled'=>1, 'visible'=>-2, 'position'=>1000, 'notnull'=>-1,), ); + + /** + * @var int rowid + */ public $rowid; + + /** + * @var int fk_bom + */ public $fk_bom; + + /** + * @var int Id of product + */ public $fk_product; + + /** + * @var string description + */ public $description; public $qty; + + /** + * @var int qty frozen + */ public $qty_frozen; public $disable_stock_change; public $efficiency; + + /** + * @var int position of line + */ public $position; + + /** + * @var string import key + */ public $import_key; // END MODULEBUILDER PROPERTIES diff --git a/htdocs/bookmarks/class/bookmark.class.php b/htdocs/bookmarks/class/bookmark.class.php index 7f19b1bd21e..f7098f1d780 100644 --- a/htdocs/bookmarks/class/bookmark.class.php +++ b/htdocs/bookmarks/class/bookmark.class.php @@ -71,10 +71,16 @@ class Bookmark extends CommonObject */ public $datec; + /** + * @var string url + */ public $url; public $target; // 0=replace, 1=new window + /** + * @var string title + */ public $title; public $position; diff --git a/htdocs/ecm/class/ecmfiles.class.php b/htdocs/ecm/class/ecmfiles.class.php index e229663e55f..978b6e46d9e 100644 --- a/htdocs/ecm/class/ecmfiles.class.php +++ b/htdocs/ecm/class/ecmfiles.class.php @@ -60,15 +60,29 @@ class EcmFiles extends CommonObject */ public $label; - public $share; // hash for file sharing, empty by default (example: getRandomPassword(true)) + /** + * @var string hash for file sharing, empty by default (example: getRandomPassword(true)) + */ + public $share; /** * @var int Entity */ public $entity; - public $filename; // Note: Into ecm database record, the entry $filename never ends with .noexe + /** + * @var string filename, Note: Into ecm database record, the entry $filename never ends with .noexe + */ + public $filename; + + /** + * @var string filepath + */ public $filepath; + + /** + * @var string fullpath origin + */ public $fullpath_orig; /** @@ -76,12 +90,31 @@ class EcmFiles extends CommonObject */ public $description; + /** + * @var string keywords + */ public $keywords; public $cover; public $position; - public $gen_or_uploaded; // can be 'generated', 'uploaded', 'unknown' + + /** + * @var string can be 'generated', 'uploaded', 'unknown' + */ + public $gen_or_uploaded; + + /** + * @var string extraparams + */ public $extraparams; + + /** + * @var int|string date create + */ public $date_c = ''; + + /** + * @var int|string date modify + */ public $date_m = ''; /** @@ -94,6 +127,9 @@ class EcmFiles extends CommonObject */ public $fk_user_m; + /** + * @var string acl + */ public $acl; public $src_object_type; public $src_object_id; @@ -135,7 +171,7 @@ class EcmFiles extends CommonObject $this->share = trim($this->share); } if (isset($this->entity)) { - $this->entity = trim($this->entity); + $this->entity = (int) $this->entity; } if (isset($this->filename)) { $this->filename = preg_replace('/\.noexe$/', '', trim($this->filename)); @@ -163,10 +199,10 @@ class EcmFiles extends CommonObject $this->extraparams = trim($this->extraparams); } if (isset($this->fk_user_c)) { - $this->fk_user_c = trim($this->fk_user_c); + $this->fk_user_c = (int) $this->fk_user_c; } if (isset($this->fk_user_m)) { - $this->fk_user_m = trim($this->fk_user_m); + $this->fk_user_m = (int) $this->fk_user_m; } if (isset($this->acl)) { $this->acl = trim($this->acl); @@ -174,13 +210,16 @@ class EcmFiles extends CommonObject if (isset($this->src_object_type)) { $this->src_object_type = trim($this->src_object_type); } - if (empty($this->date_c)) $this->date_c = dol_now(); - if (empty($this->date_m)) $this->date_m = dol_now(); + if (empty($this->date_c)) { + $this->date_c = dol_now(); + } + if (empty($this->date_m)) { + $this->date_m = dol_now(); + } // If ref not defined $ref = ''; - if (!empty($this->ref)) - { + if (!empty($this->ref)) { $ref = $this->ref; } else { include_once DOL_DOCUMENT_ROOT.'/core/lib/security.lib.php'; @@ -188,8 +227,8 @@ class EcmFiles extends CommonObject } $maxposition = 0; - if (empty($this->position)) // Get max used - { + if (empty($this->position)) { + // Get max used $sql = "SELECT MAX(position) as maxposition FROM ".MAIN_DB_PREFIX.$this->table_element; $sql .= " WHERE filepath ='".$this->db->escape($this->filepath)."'";