lainwir3d/dolibarr
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #12300 from frederic34/patch-23

Browse Source 
doxygen Commande class
This commit is contained in:
Laurent Destailleur 2019-11-02 10:08:14 +01:00 committed by GitHub
commit c078ef991f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 40 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
htdocs/commande/class/commande.class.php
View File

@ -53,19 +53,22 @@ class Commande extends CommonOrder
public $table_element='commande'; public $table_element='commande';
/** /**
* @var int Name of subtable line * @var string Name of subtable line
*/ */
public $table_element_line = 'commandedet'; public $table_element_line = 'commandedet';
/**
* @var string Name of class line
*/
public $class_element_line = 'OrderLine'; public $class_element_line = 'OrderLine';
/** /**
* @var int Field with ID of parent key if this field has a parent * @var string Field name with ID of parent key if this field has a parent
*/ */
public $fk_element = 'fk_commande'; public $fk_element = 'fk_commande';
/** /**
* @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png * @var string String with name of icon for commande class. Here is object_order.png
*/ */
public $picto = 'order'; public $picto = 'order';
@ -87,13 +90,23 @@ class Commande extends CommonOrder
protected $table_ref_field = 'ref'; protected $table_ref_field = 'ref';
/** /**
* Client ID * @var int Thirparty ID
* @var int
*/ */
public $socid; public $socid;
/**
* @var string Thirparty ref of order
*/
public $ref_client; public $ref_client;
/**
* @var string Internal ref for order
*/
public $ref_int; public $ref_int;
/**
* @var int Contact ID
*/
public $contactid; public $contactid;
/** /**
@ -103,10 +116,9 @@ class Commande extends CommonOrder
public $statut; public $statut;
/** /**
* Billed * @var int Status Billed or not
* @var int
*/ */
public $billed; // billed or not public $billed;
/** /**
* @var int Draft Status of the order * @var int Draft Status of the order
@ -115,25 +127,22 @@ class Commande extends CommonOrder
public $cond_reglement_code; public $cond_reglement_code;
/** /**
* @var int ID * @var int bank account ID
*/ */
public $fk_account; public $fk_account;
/** /**
* It holds the label of the payment mode. Use it in case translation cannot be found. * @var string It holds the label of the payment mode. Use it in case translation cannot be found.
* @var string
*/ */
public $mode_reglement; public $mode_reglement;
/** /**
* Payment mode id * @var int Payment mode id
* @var int
*/ */
public $mode_reglement_id; public $mode_reglement_id;
/** /**
* Payment mode code * @var string Payment mode code
* @var string
*/ */
public $mode_reglement_code; public $mode_reglement_code;
@ -157,9 +166,13 @@ class Commande extends CommonOrder
public $demand_reason_id; // Source reason. Why we receive order (after a phone campaign, ...) public $demand_reason_id; // Source reason. Why we receive order (after a phone campaign, ...)
public $demand_reason_code; public $demand_reason_code;
public $date; // Date commande /**
* @var int Date of order
*/
public $date;
/** /**
* @var int Date of order
* @deprecated * @deprecated
* @see $date * @see $date
*/ */
@ -182,7 +195,14 @@ class Commande extends CommonOrder
public $linked_objects=array(); public $linked_objects=array();
/**
* @var int User author ID
*/
public $user_author_id; public $user_author_id;
/**
* @var int User validator ID
*/
public $user_valid; public $user_valid;
/** /**
@ -192,7 +212,7 @@ class Commande extends CommonOrder
// Multicurrency // Multicurrency
/** /**
* @var int ID * @var int Currency ID
*/ */
public $fk_multicurrency; public $fk_multicurrency;
@ -202,6 +222,9 @@ class Commande extends CommonOrder
public $multicurrency_total_tva; public $multicurrency_total_tva;
public $multicurrency_total_ttc; public $multicurrency_total_ttc;
/**
* @var Commande clone of order object
*/
public $oldcopy; public $oldcopy;
//! key of module source when order generated from a dedicated module ('cashdesk', 'takepos', ...) //! key of module source when order generated from a dedicated module ('cashdesk', 'takepos', ...)