diff --git a/htdocs/accountancy/class/accountancycategory.class.php b/htdocs/accountancy/class/accountancycategory.class.php index e1a881c9dfa..fec51f84cee 100644 --- a/htdocs/accountancy/class/accountancycategory.class.php +++ b/htdocs/accountancy/class/accountancycategory.class.php @@ -56,24 +56,69 @@ class AccountancyCategory // extends CommonObject */ public $table_element='c_accounting_category'; - public $id; + /** + * @var int ID + */ + public $id; + + /** + * @var mixed Sample property 1 + */ public $code; /** - * @var string proper name for given parameter + * @var string Accountancy Category label */ public $label; + /** + * @var mixed Sample property 1 + */ public $range_account; + + /** + * @var mixed Sample property 1 + */ public $sens; + + /** + * @var mixed Sample property 1 + */ public $category_type; + + /** + * @var mixed Sample property 1 + */ public $formula; + + /** + * @var mixed Sample property 1 + */ public $position; + + /** + * @var mixed Sample property 1 + */ public $fk_country; + + /** + * @var mixed Sample property 1 + */ public $active; + /** + * @var mixed Sample property 1 + */ public $lines_cptbk; + + /** + * @var mixed Sample property 1 + */ public $lines_display; + + /** + * @var mixed Sample property 1 + */ public $sdc; diff --git a/htdocs/accountancy/class/accountancysystem.class.php b/htdocs/accountancy/class/accountancysystem.class.php index 8b30070317a..d126bd84acc 100644 --- a/htdocs/accountancy/class/accountancysystem.class.php +++ b/htdocs/accountancy/class/accountancysystem.class.php @@ -32,22 +32,22 @@ class AccountancySystem * @var DoliDB Database handler. */ public $db; - + /** * @var string Error code (or message) */ public $error=''; - + var $rowid; var $fk_pcg_version; var $pcg_type; var $pcg_subtype; - + /** - * @var string proper name for given parameter + * @var string Accountancy System label */ public $label; - + var $account_number; var $account_parent; diff --git a/htdocs/accountancy/class/accountingaccount.class.php b/htdocs/accountancy/class/accountingaccount.class.php index f2e2bbaf04c..4929e118a3b 100644 --- a/htdocs/accountancy/class/accountingaccount.class.php +++ b/htdocs/accountancy/class/accountingaccount.class.php @@ -37,6 +37,9 @@ class AccountingAccount extends CommonObject */ public $table_element='accounting_account'; + /** + * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png + */ public $picto = 'billr'; /** @@ -71,14 +74,19 @@ class AccountingAccount extends CommonObject */ public $id; - var $rowid; - var $datec; // Creation date - var $fk_pcg_version; - var $pcg_type; - var $pcg_subtype; - var $account_number; - var $account_parent; - var $account_category; + /** + * @var int ID + */ + public $rowid; + + public $datec; // Creation date + public $fk_pcg_version; + public $pcg_type; + public $pcg_subtype; + public $account_number; + public $account_parent; + public $account_category; + public $status; /** * @var string Label of account @@ -96,7 +104,6 @@ class AccountingAccount extends CommonObject public $fk_user_modif; public $active; // duplicate with status - public $status; /** diff --git a/htdocs/accountancy/class/accountingjournal.class.php b/htdocs/accountancy/class/accountingjournal.class.php index 282ac93c72a..058bdb3dddb 100644 --- a/htdocs/accountancy/class/accountingjournal.class.php +++ b/htdocs/accountancy/class/accountingjournal.class.php @@ -36,16 +36,27 @@ class AccountingJournal extends CommonObject */ public $table_element='accounting_journal'; + /** + * @var int Field with ID of parent key if this field has a parent + */ public $fk_element = ''; + public $ismultientitymanaged = 0; // 0=No test on entity, 1=Test with field entity, 2=Test with link by societe + + /** + * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png + */ public $picto = 'generic'; + /** + * @var int ID + */ public $rowid; public $code; /** - * @var string proper name for given parameter + * @var string Accounting Journal label */ public $label; diff --git a/htdocs/accountancy/class/bookkeeping.class.php b/htdocs/accountancy/class/bookkeeping.class.php index 85d25aad432..cacf9b0a641 100644 --- a/htdocs/accountancy/class/bookkeeping.class.php +++ b/htdocs/accountancy/class/bookkeeping.class.php @@ -35,22 +35,25 @@ class BookKeeping extends CommonObject * @var string Error code (or message) */ public $error; - + /** * @var string[] Error codes (or messages) */ public $errors = array(); - + /** * @var string Id to identify managed objects */ public $element = 'accountingbookkeeping'; - + /** * @var string Name of table without prefix where object is stored */ public $table_element = 'accounting_bookkeeping'; + /** + * @var int Entity + */ public $entity; /** @@ -62,8 +65,7 @@ class BookKeeping extends CommonObject * @var int ID */ public $id; - /** - */ + public $doc_date; public $date_lim_reglement; public $doc_type; @@ -1862,7 +1864,11 @@ class BookKeeping extends CommonObject */ class BookKeepingLine { + /** + * @var int ID + */ public $id; + public $doc_date = ''; public $doc_type; public $doc_ref; diff --git a/htdocs/adherents/class/adherent.class.php b/htdocs/adherents/class/adherent.class.php index 9d52e8560af..63e3e6d13a5 100644 --- a/htdocs/adherents/class/adherent.class.php +++ b/htdocs/adherents/class/adherent.class.php @@ -53,67 +53,73 @@ class Adherent extends CommonObject public $ismultientitymanaged = 1; // 0=No test on entity, 1=Test with field entity, 2=Test with link by societe - var $mesgs; + public $mesgs; - var $login; + public $login; //! Clear password in memory - var $pass; + public $pass; //! Clear password in database (defined if DATABASE_PWD_ENCRYPTED=0) - var $pass_indatabase; + public $pass_indatabase; //! Encrypted password in database (always defined) - var $pass_indatabase_crypted; + public $pass_indatabase_crypted; - var $societe; - var $company; - var $address; - var $zip; - var $town; + public $societe; + public $company; + public $address; + public $zip; + public $town; - var $state_id; // Id of department - var $state_code; // Code of department - var $state; // Label of department + public $state_id; // Id of department + public $state_code; // Code of department + public $state; // Label of department - var $email; - var $skype; - var $phone; - var $phone_perso; - var $phone_mobile; + public $email; + public $skype; + public $phone; + public $phone_perso; + public $phone_mobile; - var $morphy; - var $public; - var $statut; // -1:brouillon, 0:resilie, >=1:valide,paye - var $photo; + public $morphy; + public $public; + public $statut; // -1:brouillon, 0:resilie, >=1:valide,paye + public $photo; - var $datec; - var $datem; - var $datefin; - var $datevalid; - var $birth; + public $datec; + public $datem; + public $datefin; + public $datevalid; + public $birth; - var $note_public; - var $note_private; + public $note_public; + public $note_private; - var $typeid; // Id type adherent - var $type; // Libelle type adherent - var $need_subscription; + public $typeid; // Id type adherent + public $type; // Libelle type adherent + public $need_subscription; - var $user_id; - var $user_login; + public $user_id; + public $user_login; - var $fk_soc; + /** + * @var int Thirdparty ID + */ + public $fk_soc; // Fields loaded by fetch_subscriptions() - var $first_subscription_date; - var $first_subscription_amount; - var $last_subscription_date; - var $last_subscription_date_start; - var $last_subscription_date_end; - var $last_subscription_amount; - var $subscriptions=array(); + public $first_subscription_date; + public $first_subscription_amount; + public $last_subscription_date; + public $last_subscription_date_start; + public $last_subscription_date_end; + public $last_subscription_amount; + public $subscriptions=array(); - var $oldcopy; // To contains a clone of this when we need to save old properties of object + public $oldcopy; // To contains a clone of this when we need to save old properties of object + /** + * @var int Entity + */ public $entity; /** diff --git a/htdocs/adherents/class/adherent_type.class.php b/htdocs/adherents/class/adherent_type.class.php index 9b24461c60d..a9d7fd7ead3 100644 --- a/htdocs/adherents/class/adherent_type.class.php +++ b/htdocs/adherents/class/adherent_type.class.php @@ -42,7 +42,11 @@ class AdherentType extends CommonObject */ public $element = 'adherent_type'; + /** + * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png + */ public $picto = 'group'; + public $ismultientitymanaged = 1; // 0=No test on entity, 1=Test with field entity, 2=Test with link by societe /** @@ -51,19 +55,25 @@ class AdherentType extends CommonObject * @see label */ public $libelle; + /** @var string Label */ public $label; + /** * @var int Subsription required (0 or 1) * @since 5.0 */ public $subscription; + /** @var string Public note */ public $note; + /** @var integer Can vote */ public $vote; + /** @var string Email sent during validation */ public $mail_valid; + /** @var array Array of members */ public $members=array(); diff --git a/htdocs/adherents/class/subscription.class.php b/htdocs/adherents/class/subscription.class.php index 6ad63a0f682..1c64560cf79 100644 --- a/htdocs/adherents/class/subscription.class.php +++ b/htdocs/adherents/class/subscription.class.php @@ -42,15 +42,18 @@ class Subscription extends CommonObject */ public $table_element='subscription'; - public $picto='payment'; + /** + * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png + */ + public $picto='payment'; - var $datec; // Date creation - var $datem; // Date modification - var $dateh; // Subscription start date (date subscription) - var $datef; // Subscription end date - var $fk_adherent; - var $amount; - var $fk_bank; + public $datec; // Date creation + public $datem; // Date modification + public $dateh; // Subscription start date (date subscription) + public $datef; // Subscription end date + public $fk_adherent; + public $amount; + public $fk_bank; /** diff --git a/htdocs/asset/class/asset.class.php b/htdocs/asset/class/asset.class.php index f94fa4b8a12..cb75f2a0a11 100644 --- a/htdocs/asset/class/asset.class.php +++ b/htdocs/asset/class/asset.class.php @@ -95,18 +95,36 @@ class Asset extends CommonObject 'import_key' => array('type'=>'varchar(14)', 'label'=>'ImportId', 'visible'=>-2, 'enabled'=>1, 'position'=>1000, 'notnull'=>-1,), 'status' => array('type'=>'integer', 'label'=>'Status', 'visible'=>1, 'enabled'=>1, 'position'=>1000, 'notnull'=>1, 'index'=>1, 'arrayofkeyval'=>array('0'=>'Draft', '1'=>'Active', '-1'=>'Cancel')), ); + + /** + * @var int ID + */ public $rowid; + + /** + * @var string Ref + */ public $ref; + public $entity; /** - * @var string proper name for given parameter + * @var string Asset label */ - public $label; + public $label; public $amount; - public $fk_soc; + + /** + * @var int Thirdparty ID + */ + public $fk_soc; + + /** + * @var string description + */ public $description; + public $note_public; public $note_private; public $date_creation; diff --git a/htdocs/asset/class/asset_type.class.php b/htdocs/asset/class/asset_type.class.php index 7aa9beda627..df2f4c1415e 100644 --- a/htdocs/asset/class/asset_type.class.php +++ b/htdocs/asset/class/asset_type.class.php @@ -39,19 +39,28 @@ class AssetType extends CommonObject */ public $element = 'asset_type'; + /** + * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png + */ public $picto = 'group'; + public $ismultientitymanaged = 1; // 0=No test on entity, 1=Test with field entity, 2=Test with link by societe /** @var string Label */ public $label; + /** @var string Accountancy code asset */ public $accountancy_code_asset; + /** @var string Accountancy code depreciation asset */ public $accountancy_code_depreciation_asset; + /** @var string Accountancy code depreciation expense */ public $accountancy_code_depreciation_expense; + /** @var string Public note */ public $note; + /** @var array Array of asset */ public $asset=array(); diff --git a/htdocs/blockedlog/class/blockedlog.class.php b/htdocs/blockedlog/class/blockedlog.class.php index eaec787b099..dab99d80bc9 100644 --- a/htdocs/blockedlog/class/blockedlog.class.php +++ b/htdocs/blockedlog/class/blockedlog.class.php @@ -39,6 +39,7 @@ class BlockedLog * @var int */ public $id; + /** * Entity * @var int @@ -46,7 +47,7 @@ class BlockedLog public $entity; public $error = ''; - + /** * @var string[] Error codes (or messages) */ diff --git a/htdocs/bookmarks/class/bookmark.class.php b/htdocs/bookmarks/class/bookmark.class.php index 2d156832861..7f3b2c58300 100644 --- a/htdocs/bookmarks/class/bookmark.class.php +++ b/htdocs/bookmarks/class/bookmark.class.php @@ -32,14 +32,18 @@ class Bookmark extends CommonObject * @var string ID to identify managed object */ public $element='bookmark'; - + /** * @var string Name of table without prefix where object is stored */ public $table_element='bookmark'; - + public $ismultientitymanaged = 1; // 0=No test on entity, 1=Test with field entity, 2=Test with link by societe - public $picto = 'bookmark'; + + /** + * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png + */ + public $picto = 'bookmark'; /** * @var DoliDB Database handler. @@ -50,14 +54,18 @@ class Bookmark extends CommonObject * @var int ID */ public $id; - - var $fk_user; - var $datec; - var $url; - var $target; // 0=replace, 1=new window - var $title; - var $position; - var $favicon; + + /** + * @var int User ID + */ + public $fk_user; + + public $datec; + public $url; + public $target; // 0=replace, 1=new window + public $title; + public $position; + public $favicon; /** diff --git a/htdocs/cashdesk/class/Facturation.class.php b/htdocs/cashdesk/class/Facturation.class.php index 755c48faf88..3051035813a 100644 --- a/htdocs/cashdesk/class/Facturation.class.php +++ b/htdocs/cashdesk/class/Facturation.class.php @@ -37,7 +37,12 @@ class Facturation * int $prix => Prix HT du produit en cours * int $tva => 'rowid' du taux de tva dans llx_c_tva */ - public $id; + + /** + * @var int ID + */ + public $id; + protected $ref; protected $qte; protected $stock; diff --git a/htdocs/categories/class/categorie.class.php b/htdocs/categories/class/categorie.class.php index 32910c3ed8a..98bd2a437b9 100644 --- a/htdocs/categories/class/categorie.class.php +++ b/htdocs/categories/class/categorie.class.php @@ -51,8 +51,11 @@ class Categorie extends CommonObject const TYPE_USER = 'user'; const TYPE_PROJECT = 'project'; const TYPE_ACCOUNT = 'bank_account'; - const TYPE_BANK_LINE = 'bank_line'; + const TYPE_BANK_LINE = 'bank_line'; + /** + * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png + */ public $picto = 'category'; @@ -161,11 +164,15 @@ class Categorie extends CommonObject public $fk_parent; /** - * @var string proper name for given parameter + * @var string Category label */ - public $label; + public $label; + /** + * @var string description + */ public $description; + /** * @var string Color */ diff --git a/htdocs/comm/action/class/actioncomm.class.php b/htdocs/comm/action/class/actioncomm.class.php index ef6e2d2c5e4..86ac99ee2fe 100644 --- a/htdocs/comm/action/class/actioncomm.class.php +++ b/htdocs/comm/action/class/actioncomm.class.php @@ -35,9 +35,9 @@ require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php'; class ActionComm extends CommonObject { /** - * @var string ID to identify managed object - */ - public $element='action'; + * @var string ID to identify managed object + */ + public $element='action'; /** * @var string Name of table without prefix where object is stored @@ -45,7 +45,11 @@ class ActionComm extends CommonObject public $table_element = 'actioncomm'; public $table_rowid = 'id'; - public $picto='action'; + + /** + * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png + */ + public $picto = 'action'; /** * 0=No test on entity, 1=Test with field entity, 2=Test with link by societe @@ -78,7 +82,7 @@ class ActionComm extends CommonObject var $code; // Free code to identify action. Ie: Agenda trigger add here AC_TRIGGERNAME ('AC_COMPANY_CREATE', 'AC_PROPAL_VALIDATE', ...) /** - * @var string proper name for given parameter + * @var string Agenda event label */ public $label; diff --git a/htdocs/comm/action/class/actioncommreminder.class.php b/htdocs/comm/action/class/actioncommreminder.class.php index b93684233c1..63773661cbd 100644 --- a/htdocs/comm/action/class/actioncommreminder.class.php +++ b/htdocs/comm/action/class/actioncommreminder.class.php @@ -84,7 +84,12 @@ class ActionCommReminder extends CommonObject public $rowid; public $dateremind; public $typeremind; + + /** + * @var int User ID + */ public $fk_user; + public $offsetvalue; public $offsetunit; public $status; diff --git a/htdocs/comm/action/class/cactioncomm.class.php b/htdocs/comm/action/class/cactioncomm.class.php index e7fa7a3d2ef..d6c25f6d4c1 100644 --- a/htdocs/comm/action/class/cactioncomm.class.php +++ b/htdocs/comm/action/class/cactioncomm.class.php @@ -24,7 +24,7 @@ /** - * Class to manage different types of events + * Class to manage different types of events */ class CActionComm { @@ -43,20 +43,24 @@ class CActionComm */ public $id; - var $code; - var $type; - var $libelle; // deprecated + public $code; + public $type; + public $libelle; // deprecated /** - * @var string proper name for given parameter + * @var string Type of agenda event label */ public $label; - var $active; - var $color; - var $picto; + public $active; + public $color; - var $type_actions=array(); + /** + * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png + */ + public $picto; + + public $type_actions=array(); /** diff --git a/htdocs/comm/mailing/class/mailing.class.php b/htdocs/comm/mailing/class/mailing.class.php index 4b7b31b6b13..7a0d758ae17 100644 --- a/htdocs/comm/mailing/class/mailing.class.php +++ b/htdocs/comm/mailing/class/mailing.class.php @@ -41,42 +41,45 @@ class Mailing extends CommonObject */ public $table_element='mailing'; + /** + * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png + */ public $picto='email'; - var $titre; - var $sujet; - var $body; - var $nbemail; - var $bgcolor; - var $bgimage; + public $titre; + public $sujet; + public $body; + public $nbemail; + public $bgcolor; + public $bgimage; - var $statut; // Status 0=Draft, 1=Validated, 2=Sent partially, 3=Sent completely + public $statut; // Status 0=Draft, 1=Validated, 2=Sent partially, 3=Sent completely - var $email_from; - var $email_replyto; - var $email_errorsto; + public $email_from; + public $email_replyto; + public $email_errorsto; - var $joined_file1; - var $joined_file2; - var $joined_file3; - var $joined_file4; + public $joined_file1; + public $joined_file2; + public $joined_file3; + public $joined_file4; - var $user_creat; - var $user_valid; + public $user_creat; + public $user_valid; - var $date_creat; - var $date_valid; + public $date_creat; + public $date_valid; - var $extraparams=array(); + public $extraparams=array(); public $statut_dest=array(); public $statuts=array(); - /** + /** * Constructor * - * @param DoliDb $db Database handler + * @param DoliDb $db Database handler */ function __construct($db) { diff --git a/htdocs/comm/propal/class/propal.class.php b/htdocs/comm/propal/class/propal.class.php index e8437e66498..30ad7cd76b2 100644 --- a/htdocs/comm/propal/class/propal.class.php +++ b/htdocs/comm/propal/class/propal.class.php @@ -55,8 +55,19 @@ class Propal extends CommonObject */ public $table_element='propal'; + /** + * @var int Name of subtable line + */ public $table_element_line='propaldet'; - public $fk_element='fk_propal'; + + /** + * @var int Field with ID of parent key if this field has a parent + */ + public $fk_element ='fk_propal'; + + /** + * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png + */ public $picto='propal'; /** diff --git a/htdocs/commande/class/commande.class.php b/htdocs/commande/class/commande.class.php index 6c939cfa410..3611d8b3d98 100644 --- a/htdocs/commande/class/commande.class.php +++ b/htdocs/commande/class/commande.class.php @@ -52,15 +52,26 @@ class Commande extends CommonOrder */ public $table_element='commande'; + /** + * @var int Name of subtable line + */ public $table_element_line = 'commandedet'; + public $class_element_line = 'OrderLine'; + + /** + * @var int Field with ID of parent key if this field has a parent + */ public $fk_element = 'fk_commande'; + public $picto = 'order'; + /** * 0=No test on entity, 1=Test with field entity, 2=Test with link by societe * @var int */ public $ismultientitymanaged = 1; + /** * 0=Default, 1=View may be restricted to sales representative only if no permission to see all or to company of external user if external user * @var integer @@ -87,6 +98,7 @@ class Commande extends CommonOrder * @var int */ public $statut; + /** * Billed * @var int @@ -109,21 +121,25 @@ class Commande extends CommonOrder * @var int */ public $mode_reglement_id; + /** * Payment mode code * @var string */ public $mode_reglement_code; + /** * Availability delivery time id * @var int */ public $availability_id; + /** * Availability delivery time code * @var string */ public $availability_code; + /** * Label of availability delivery time. Use it in case translation cannot be found. * @var string @@ -133,11 +149,13 @@ class Commande extends CommonOrder public $demand_reason_id; // Source reason. Why we receive order (after a phone campaign, ...) public $demand_reason_code; public $date; // Date commande + /** * @deprecated * @see date */ public $date_commande; + public $date_livraison; // Date expected of shipment (date starting shipment, not the reception that occurs some days after) public $fk_remise_except; public $remise_percent; @@ -3849,7 +3867,7 @@ class OrderLine extends CommonOrderLine var $fk_facture; /** - * @var string proper name for given parameter + * @var string Order lines label */ public $label; diff --git a/htdocs/compta/bank/class/account.class.php b/htdocs/compta/bank/class/account.class.php index 4a1d2b047ab..515f0d1170f 100644 --- a/htdocs/compta/bank/class/account.class.php +++ b/htdocs/compta/bank/class/account.class.php @@ -1664,42 +1664,46 @@ class AccountLine extends CommonObject */ public $table_element='bank'; - var $picto = 'generic'; + public $picto = 'generic'; /** * @var int ID */ public $id; - var $ref; - var $datec; - var $dateo; + /** + * @var string Ref + */ + public $ref; + + public $datec; + public $dateo; /** * Value date */ - var $datev; - var $amount; + public $datev; + public $amount; - /** - * @var string proper name for given parameter + /** + * @var string bank transaction lines label */ public $label; - var $note; - var $fk_user_author; - var $fk_user_rappro; - var $fk_type; - var $rappro; // Is it conciliated - var $num_releve; // If conciliated, what is bank statement - var $num_chq; // Num of cheque - var $bank_chq; // Bank of cheque - var $fk_bordereau; // Id of cheque receipt + public $note; + public $fk_user_author; + public $fk_user_rappro; + public $fk_type; + public $rappro; // Is it conciliated + public $num_releve; // If conciliated, what is bank statement + public $num_chq; // Num of cheque + public $bank_chq; // Bank of cheque + public $fk_bordereau; // Id of cheque receipt - var $fk_account; // Id of bank account - var $bank_account_label; // Label of bank account + public $fk_account; // Id of bank account + public $bank_account_label; // Label of bank account - public $emetteur; + public $emetteur; /** * Constructor diff --git a/htdocs/compta/bank/class/bankcateg.class.php b/htdocs/compta/bank/class/bankcateg.class.php index 9aefcd5d863..10bcd9a07c4 100644 --- a/htdocs/compta/bank/class/bankcateg.class.php +++ b/htdocs/compta/bank/class/bankcateg.class.php @@ -32,10 +32,13 @@ class BankCateg // extends CommonObject //public $table_element='bank_categ'; //!< Name of table without prefix where object is stored public $picto='generic'; - public $id; + /** + * @var int ID + */ + public $id; /** - * @var string proper name for given parameter + * @var string bank categories label */ public $label; diff --git a/htdocs/compta/bank/class/paymentvarious.class.php b/htdocs/compta/bank/class/paymentvarious.class.php index df3507d4dca..24f6020690c 100644 --- a/htdocs/compta/bank/class/paymentvarious.class.php +++ b/htdocs/compta/bank/class/paymentvarious.class.php @@ -47,25 +47,29 @@ class PaymentVarious extends CommonObject */ public $id; - var $ref; - var $tms; - var $datep; - var $datev; - var $sens; - var $amount; - var $type_payment; - var $num_payment; + /** + * @var string Ref + */ + public $ref; + + public $tms; + public $datep; + public $datev; + public $sens; + public $amount; + public $type_payment; + public $num_payment; /** - * @var string proper name for given parameter + * @var string various payments label */ public $label; - var $accountancy_code; - var $fk_project; - var $fk_bank; - var $fk_user_author; - var $fk_user_modif; + public $accountancy_code; + public $fk_project; + public $fk_bank; + public $fk_user_author; + public $fk_user_modif; /** @@ -85,7 +89,7 @@ class PaymentVarious extends CommonObject * Update database * * @param User $user User that modify - * @param int $notrigger 0=no, 1=yes (no update trigger) + * @param int $notrigger 0=no, 1=yes (no update trigger) * @return int <0 if KO, >0 if OK */ function update($user=null, $notrigger=0) diff --git a/htdocs/compta/deplacement/class/deplacement.class.php b/htdocs/compta/deplacement/class/deplacement.class.php index 2330e81d3a0..403988052bd 100644 --- a/htdocs/compta/deplacement/class/deplacement.class.php +++ b/htdocs/compta/deplacement/class/deplacement.class.php @@ -41,21 +41,34 @@ class Deplacement extends CommonObject */ public $table_element='deplacement'; + /** + * @var int Name of subtable line + */ public $table_element_line = ''; + + /** + * @var int Field with ID of parent key if this field has a parent + */ public $fk_element = ''; + public $ismultientitymanaged = 0; // 0=No test on entity, 1=Test with field entity, 2=Test with link by societe - var $datec; // Creation date - var $dated; - var $fk_user_author; - var $fk_user; - var $km; - var $socid; - var $statut; // 0=draft, 1=validated - var $extraparams=array(); + public $datec; // Creation date + public $dated; + public $fk_user_author; - var $statuts=array(); - var $statuts_short=array(); + /** + * @var int User ID + */ + public $fk_user; + + public $km; + public $socid; + public $statut; // 0=draft, 1=validated + public $extraparams=array(); + + public $statuts=array(); + public $statuts_short=array(); /** * Constructor diff --git a/htdocs/compta/facture/class/facture-rec.class.php b/htdocs/compta/facture/class/facture-rec.class.php index 51b031b5c7c..431638a2401 100644 --- a/htdocs/compta/facture/class/facture-rec.class.php +++ b/htdocs/compta/facture/class/facture-rec.class.php @@ -49,34 +49,42 @@ class FactureRec extends CommonInvoice */ public $table_element='facture_rec'; + /** + * @var int Name of subtable line + */ public $table_element_line='facturedet_rec'; + + /** + * @var int Field with ID of parent key if this field has a parent + */ public $fk_element='fk_facture'; + public $picto='bill'; - var $entity; - var $number; - var $date; - var $amount; - var $remise; - var $tva; - var $total; - var $db_table; - var $propalid; + public $entity; + public $number; + public $date; + public $amount; + public $remise; + public $tva; + public $total; + public $db_table; + public $propalid; - var $date_last_gen; - var $date_when; - var $nb_gen_done; - var $nb_gen_max; + public $date_last_gen; + public $date_when; + public $nb_gen_done; + public $nb_gen_max; - var $frequency; - var $unit_frequency; + public $frequency; + public $unit_frequency; - var $rang; - var $special_code; + public $rang; + public $special_code; - var $usenewprice=0; + public $usenewprice=0; - var $suspended; // status + public $suspended; // status const STATUS_NOTSUSPENDED = 0; const STATUS_SUSPENDED = 1; diff --git a/htdocs/compta/facture/class/facture.class.php b/htdocs/compta/facture/class/facture.class.php index b873b402f5a..e0926337200 100644 --- a/htdocs/compta/facture/class/facture.class.php +++ b/htdocs/compta/facture/class/facture.class.php @@ -63,14 +63,24 @@ class Facture extends CommonInvoice */ public $table_element='facture'; + /** + * @var int Name of subtable line + */ public $table_element_line = 'facturedet'; + + /** + * @var int Field with ID of parent key if this field has a parent + */ public $fk_element = 'fk_facture'; + public $picto='bill'; + /** * 0=No test on entity, 1=Test with field entity, 2=Test with link by societe * @var int */ public $ismultientitymanaged = 1; + /** * 0=Default, 1=View may be restricted to sales representative only if no permission to see all or to company of external user if external user * @var integer @@ -120,14 +130,17 @@ class Facture extends CommonInvoice public $cond_reglement_code; // Code in llx_c_paiement public $mode_reglement_code; // Code in llx_c_paiement public $fk_bank; // Field to store bank id to use when payment mode is withdraw + /** * @deprecated */ public $products=array(); + /** * @var FactureLigne[] */ public $lines=array(); + public $line; public $extraparams=array(); public $specimen; diff --git a/htdocs/compta/facture/class/paymentterm.class.php b/htdocs/compta/facture/class/paymentterm.class.php index 2bdd288e748..619487e9574 100644 --- a/htdocs/compta/facture/class/paymentterm.class.php +++ b/htdocs/compta/facture/class/paymentterm.class.php @@ -32,7 +32,7 @@ class PaymentTerm // extends CommonObject * @var DoliDB Database handler. */ public $db; - + /** * @var string Error code (or message) */ @@ -42,24 +42,24 @@ class PaymentTerm // extends CommonObject * @var string[] Error codes (or messages) */ public $errors = array(); - + //public $element='c_payment_term'; //!< Id that identify managed objects //public $table_element='c_payment_term'; //!< Name of table without prefix where object is stored - var $context =array(); + public $context =array(); /** * @var int ID */ public $id; - var $code; - var $sortorder; - var $active; - var $libelle; - var $libelle_facture; - var $type_cdr; - var $nbjour; - var $decalage; + public $code; + public $sortorder; + public $active; + public $libelle; + public $libelle_facture; + public $type_cdr; + public $nbjour; + public $decalage; diff --git a/htdocs/compta/localtax/class/localtax.class.php b/htdocs/compta/localtax/class/localtax.class.php index 2c777d671fc..54f37205292 100644 --- a/htdocs/compta/localtax/class/localtax.class.php +++ b/htdocs/compta/localtax/class/localtax.class.php @@ -48,7 +48,7 @@ class Localtax extends CommonObject var $amount; /** - * @var string proper name for given parameter + * @var string local tax */ public $label; diff --git a/htdocs/compta/paiement/cheque/class/remisecheque.class.php b/htdocs/compta/paiement/cheque/class/remisecheque.class.php index 70e642cbf90..eb598912b05 100644 --- a/htdocs/compta/paiement/cheque/class/remisecheque.class.php +++ b/htdocs/compta/paiement/cheque/class/remisecheque.class.php @@ -56,6 +56,10 @@ class RemiseCheque extends CommonObject public $account_label; public $author_id; public $nbcheque; + + /** + * @var string Ref + */ public $ref; /** diff --git a/htdocs/compta/salaries/class/paymentsalary.class.php b/htdocs/compta/salaries/class/paymentsalary.class.php index 7630800ad15..67307f46777 100644 --- a/htdocs/compta/salaries/class/paymentsalary.class.php +++ b/htdocs/compta/salaries/class/paymentsalary.class.php @@ -44,7 +44,12 @@ class PaymentSalary extends CommonObject public $picto='payment'; public $tms; + + /** + * @var int User ID + */ public $fk_user; + public $datep; public $datev; public $amount; @@ -53,7 +58,7 @@ class PaymentSalary extends CommonObject public $num_payment; /** - * @var string proper name for given parameter + * @var string salary payments label */ public $label; diff --git a/htdocs/compta/tva/class/tva.class.php b/htdocs/compta/tva/class/tva.class.php index b1197260240..bca523bfb36 100644 --- a/htdocs/compta/tva/class/tva.class.php +++ b/htdocs/compta/tva/class/tva.class.php @@ -53,7 +53,7 @@ class Tva extends CommonObject var $num_payment; /** - * @var string proper name for given parameter + * @var string label */ public $label; diff --git a/htdocs/contrat/class/contrat.class.php b/htdocs/contrat/class/contrat.class.php index ee62ee5680c..226af980919 100644 --- a/htdocs/contrat/class/contrat.class.php +++ b/htdocs/contrat/class/contrat.class.php @@ -51,8 +51,16 @@ class Contrat extends CommonObject */ public $table_element='contrat'; + /** + * @var int Name of subtable line + */ public $table_element_line='contratdet'; + + /** + * @var int Field with ID of parent key if this field has a parent + */ public $fk_element='fk_contrat'; + public $picto='contract'; /** @@ -76,27 +84,29 @@ class Contrat extends CommonObject * Customer reference of the contract * @var string */ - var $ref_customer; + public $ref_customer; /** * Supplier reference of the contract * @var string */ - var $ref_supplier; + public $ref_supplier; /** * Client id linked to the contract * @var int */ - var $socid; - var $societe; // Objet societe + public $socid; + + public $societe; // Objet societe /** * Status of the contract * @var int */ - var $statut=0; // 0=Draft, - var $product; + public $statut=0; // 0=Draft, + + public $product; /** * @var int Id of user author of the contract @@ -123,7 +133,7 @@ class Contrat extends CommonObject /** * @var int Date of creation */ - var $date_creation; + public $date_creation; /** * @var int Date of last modification. Not filled until you call ->info() @@ -133,34 +143,34 @@ class Contrat extends CommonObject /** * @var int Date of validation */ - var $date_validation; + public $date_validation; /** * @var int Date when contract was signed */ - var $date_contrat; + public $date_contrat; /** * @var int Date of contract closure * @deprecated we close contract lines, not a contract */ - var $date_cloture; + public $date_cloture; - var $commercial_signature_id; - var $commercial_suivi_id; + public $commercial_signature_id; + public $commercial_suivi_id; /** * @deprecated Use fk_project instead * @see fk_project */ - var $fk_projet; + public $fk_projet; - var $extraparams=array(); + public $extraparams=array(); /** * @var ContratLigne[] Contract lines */ - var $lines=array(); + public $lines=array(); /** * Maps ContratLigne IDs to $this->lines indexes @@ -2490,51 +2500,60 @@ class ContratLigne extends CommonObjectLine */ public $id; - var $ref; - var $tms; + /** + * @var string Ref + */ + public $ref; + + public $tms; + + public $fk_contrat; + public $fk_product; + public $statut; // 0 inactive, 4 active, 5 closed + public $type; // 0 for product, 1 for service - var $fk_contrat; - var $fk_product; - var $statut; // 0 inactive, 4 active, 5 closed - var $type; // 0 for product, 1 for service /** * @var string * @deprecated */ - var $label; + public $label; + /** * @var string * @deprecated */ public $libelle; - var $description; + /** + * @var string description + */ + public $description; - var $product_ref; - var $product_label; + public $product_ref; + public $product_label; - var $date_commande; + public $date_commande; - var $date_start; // date start planned - var $date_start_real; // date start real - var $date_end; // date end planned - var $date_end_real; // date end real + public $date_start; // date start planned + public $date_start_real; // date start real + public $date_end; // date end planned + public $date_end_real; // date end real // For backward compatibility - var $date_ouverture_prevue; // date start planned - var $date_ouverture; // date start real - var $date_fin_validite; // date end planned - var $date_cloture; // date end real - var $tva_tx; - var $localtax1_tx; - var $localtax2_tx; - var $localtax1_type; // Local tax 1 type - var $localtax2_type; // Local tax 2 type - var $qty; - var $remise_percent; - var $remise; - var $fk_remise_except; + public $date_ouverture_prevue; // date start planned + public $date_ouverture; // date start real + public $date_fin_validite; // date end planned + public $date_cloture; // date end real + public $tva_tx; + public $localtax1_tx; + public $localtax2_tx; + public $localtax1_type; // Local tax 1 type + public $localtax2_type; // Local tax 2 type + public $qty; + public $remise_percent; + public $remise; + public $fk_remise_except; - var $subprice; // Unit price HT + public $subprice; // Unit price HT /** * @var float @@ -2543,22 +2562,22 @@ class ContratLigne extends CommonObjectLine */ public $price; - var $price_ht; + public $price_ht; - var $total_ht; - var $total_tva; - var $total_localtax1; - var $total_localtax2; - var $total_ttc; + public $total_ht; + public $total_tva; + public $total_localtax1; + public $total_localtax2; + public $total_ttc; - var $fk_fournprice; - var $pa_ht; + public $fk_fournprice; + public $pa_ht; - var $info_bits; - var $fk_user_author; - var $fk_user_ouverture; - var $fk_user_cloture; - var $commentaire; + public $info_bits; + public $fk_user_author; + public $fk_user_ouverture; + public $fk_user_cloture; + public $commentaire; const STATUS_INITIAL = 0; const STATUS_OPEN = 4; diff --git a/htdocs/core/class/ccountry.class.php b/htdocs/core/class/ccountry.class.php index 30f426ec30d..2f9a8636c8b 100644 --- a/htdocs/core/class/ccountry.class.php +++ b/htdocs/core/class/ccountry.class.php @@ -36,7 +36,7 @@ class Ccountry // extends CommonObject * @var DoliDB Database handler. */ public $db; - + /** * @var string Error code (or message) */ @@ -46,7 +46,7 @@ class Ccountry // extends CommonObject * @var string[] Error codes (or messages) */ public $errors = array(); - + //var $element='ccountry'; //!< Id that identify managed objects //var $table_element='ccountry'; //!< Name of table without prefix where object is stored @@ -54,16 +54,16 @@ class Ccountry // extends CommonObject * @var int ID */ public $id; - - var $code; - var $code_iso; - + + public $code; + public $code_iso; + /** - * @var string proper name for given parameter + * @var string Countries label */ public $label; - - var $active; + + public $active; diff --git a/htdocs/core/class/comment.class.php b/htdocs/core/class/comment.class.php index 518f02ef2af..287d260f4d2 100644 --- a/htdocs/core/class/comment.class.php +++ b/htdocs/core/class/comment.class.php @@ -31,9 +31,16 @@ class Comment extends CommonObject */ public $table_element='comment'; - public $fk_element; + /** + * @var int Field with ID of parent key if this field has a parent + */ + public $fk_element =''; + public $element_type; + /** + * @var string description + */ public $description; public $tms; @@ -42,6 +49,9 @@ class Comment extends CommonObject public $fk_user_author; + /** + * @var int Entity + */ public $entity; public $import_key; diff --git a/htdocs/core/class/commonobject.class.php b/htdocs/core/class/commonobject.class.php index ca493b98041..5aa9af34146 100644 --- a/htdocs/core/class/commonobject.class.php +++ b/htdocs/core/class/commonobject.class.php @@ -73,9 +73,9 @@ abstract class CommonObject public $table_element; /** - * @var + * @var int Name of subtable line */ - public $table_element_line; + public $table_element_line=''; /** * @var string Key value used to track if data is coming from import wizard @@ -168,6 +168,7 @@ abstract class CommonObject * @see fetch_origin() */ public $origin; + /** * @var int The id of originating object * @see fetch_origin() diff --git a/htdocs/core/class/cstate.class.php b/htdocs/core/class/cstate.class.php index 3b1016aa55f..085da06c754 100644 --- a/htdocs/core/class/cstate.class.php +++ b/htdocs/core/class/cstate.class.php @@ -36,7 +36,7 @@ class Cstate // extends CommonObject * @var DoliDB Database handler. */ public $db; - + /** * @var string Error code (or message) */ @@ -46,7 +46,7 @@ class Cstate // extends CommonObject * @var string[] Error codes (or messages) */ public $errors = array(); - + //var $element='cstate'; //!< Id that identify managed objects //var $table_element='cstate'; //!< Name of table without prefix where object is stored @@ -54,10 +54,10 @@ class Cstate // extends CommonObject * @var int ID */ public $id; - - var $code_departement; - var $nom; - var $active; + + public $code_departement; + public $nom; + public $active; diff --git a/htdocs/core/class/ctypent.class.php b/htdocs/core/class/ctypent.class.php index aa3e6620d4f..9366cf6317b 100644 --- a/htdocs/core/class/ctypent.class.php +++ b/htdocs/core/class/ctypent.class.php @@ -31,7 +31,7 @@ class Ctypent // extends CommonObject * @var DoliDB Database handler. */ public $db; - + /** * @var string Error code (or message) */ @@ -41,7 +41,7 @@ class Ctypent // extends CommonObject * @var string[] Error codes (or messages) */ public $errors = array(); - + //var $element='ctypent'; //!< Id that identify managed objects //var $table_element='ctypent'; //!< Name of table without prefix where object is stored @@ -49,11 +49,11 @@ class Ctypent // extends CommonObject * @var int ID */ public $id; - - var $code; - var $libelle; - var $active; - var $module; + + public $code; + public $libelle; + public $active; + public $module; diff --git a/htdocs/core/class/ctyperesource.class.php b/htdocs/core/class/ctyperesource.class.php index d459ff6fb41..ae4036214a2 100644 --- a/htdocs/core/class/ctyperesource.class.php +++ b/htdocs/core/class/ctyperesource.class.php @@ -50,7 +50,7 @@ class Ctyperesource public $code; /** - * @var string proper name for given parameter + * @var string Type resource label */ public $label; @@ -486,7 +486,7 @@ class CtyperesourceLine public $code; /** - * @var string proper name for given parameter + * @var string Type resource line label */ public $label; diff --git a/htdocs/core/class/discount.class.php b/htdocs/core/class/discount.class.php index b1a92ae0f5f..9e4c048e61d 100644 --- a/htdocs/core/class/discount.class.php +++ b/htdocs/core/class/discount.class.php @@ -43,15 +43,32 @@ class DiscountAbsolute */ public $errors=array(); - public $id; // Id discount + /** + * @var int ID discount + */ + public $id; + + /** + * @var int Thirdparty ID + */ public $fk_soc; + public $discount_type; // 0 => customer discount, 1 => supplier discount public $amount_ht; // public $amount_tva; // public $amount_ttc; // public $tva_tx; // Vat rate - public $fk_user; // Id utilisateur qui accorde la remise - public $description; // Description libre + + /** + * @var int User ID Id utilisateur qui accorde la remise + */ + public $fk_user; + + /** + * @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) diff --git a/htdocs/core/class/emailsenderprofile.class.php b/htdocs/core/class/emailsenderprofile.class.php index 37685001aba..d2bf33b5461 100644 --- a/htdocs/core/class/emailsenderprofile.class.php +++ b/htdocs/core/class/emailsenderprofile.class.php @@ -88,8 +88,17 @@ class EmailSenderProfile extends CommonObject 'tms' => array('type'=>'timestamp', 'label'=>'DateModification', 'visible'=>-1, 'enabled'=>1, 'position'=>500, 'notnull'=>1,), 'active' => array('type'=>'integer', 'label'=>'Status', 'visible'=>1, 'enabled'=>1, 'position'=>1000, 'notnull'=>-1, 'index'=>1), ); + + /** + * @var int ID + */ public $rowid; + + /** + * @var int Entity + */ public $entity; + public $label; public $email; public $date_creation; diff --git a/htdocs/core/class/events.class.php b/htdocs/core/class/events.class.php index bc9f5ca1fcc..2ac2a51d2ed 100644 --- a/htdocs/core/class/events.class.php +++ b/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( diff --git a/htdocs/core/class/fiscalyear.class.php b/htdocs/core/class/fiscalyear.class.php index 4e9b4021ee5..de4dc46ac90 100644 --- a/htdocs/core/class/fiscalyear.class.php +++ b/htdocs/core/class/fiscalyear.class.php @@ -38,25 +38,36 @@ class Fiscalyear extends CommonObject */ public $table_element='accounting_fiscalyear'; + /** + * @var int Name of subtable line + */ public $table_element_line = ''; - public $fk_element = ''; - public $ismultientitymanaged = 1; // 0=No test on entity, 1=Test with field entity, 2=Test with link by societe - - var $rowid; /** - * @var string proper name for given parameter + * @var int Field with ID of parent key if this field has a parent + */ + public $fk_element = ''; + + public $ismultientitymanaged = 1; // 0=No test on entity, 1=Test with field entity, 2=Test with link by societe + + /** + * @var int ID + */ + public $rowid; + + /** + * @var string fiscal year label */ public $label; - var $date_start; - var $date_end; - var $datec; - var $statut; // 0=open, 1=closed - var $entity; + public $date_start; + public $date_end; + public $datec; + public $statut; // 0=open, 1=closed + public $entity; - var $statuts=array(); - var $statuts_short=array(); + public $statuts=array(); + public $statuts_short=array(); /** * Constructor diff --git a/htdocs/core/class/html.formmail.class.php b/htdocs/core/class/html.formmail.class.php index 3edfb2d2f77..cdc6a20ffa1 100644 --- a/htdocs/core/class/html.formmail.class.php +++ b/htdocs/core/class/html.formmail.class.php @@ -1402,10 +1402,13 @@ class FormMail extends Form */ class ModelMail { + /** + * @var int ID + */ public $id; /** - * @var string proper name for given parameter + * @var string Model mail label */ public $label; diff --git a/htdocs/core/class/link.class.php b/htdocs/core/class/link.class.php index 02298ac53ff..b1196d6746b 100644 --- a/htdocs/core/class/link.class.php +++ b/htdocs/core/class/link.class.php @@ -32,21 +32,25 @@ class Link extends CommonObject * @var string ID to identify managed object */ public $element = 'link'; - + /** * @var string Name of table without prefix where object is stored */ public $table_element = 'links'; - public $entity; + /** + * @var int Entity + */ + public $entity; + public $datea; public $url; - + /** - * @var string proper name for given parameter + * @var string Links label */ public $label; - + public $objecttype; public $objectid; diff --git a/htdocs/core/class/menubase.class.php b/htdocs/core/class/menubase.class.php index 5078d7759ea..7db88051e5e 100644 --- a/htdocs/core/class/menubase.class.php +++ b/htdocs/core/class/menubase.class.php @@ -43,7 +43,10 @@ class Menubase */ public $errors = array(); - public $id; + /** + * @var int ID + */ + public $id; public $menu_handler; public $module; diff --git a/htdocs/core/class/notify.class.php b/htdocs/core/class/notify.class.php index 8087d316cf4..439e9b60d3c 100644 --- a/htdocs/core/class/notify.class.php +++ b/htdocs/core/class/notify.class.php @@ -34,12 +34,12 @@ class Notify * @var int ID */ public $id; - + /** * @var DoliDB Database handler. */ public $db; - + /** * @var string Error code (or message) */ @@ -51,7 +51,12 @@ class Notify public $errors = array(); var $author; - var $ref; + + /** + * @var string Ref + */ + public $ref; + var $date; var $duree; var $note; diff --git a/htdocs/core/modules/action/rapport.pdf.php b/htdocs/core/modules/action/rapport.pdf.php index 3babb23456b..8fb183a2446 100644 --- a/htdocs/core/modules/action/rapport.pdf.php +++ b/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; diff --git a/htdocs/core/modules/export/export_csv.modules.php b/htdocs/core/modules/export/export_csv.modules.php index d3ad7419c2e..a0f8f0df543 100644 --- a/htdocs/core/modules/export/export_csv.modules.php +++ b/htdocs/core/modules/export/export_csv.modules.php @@ -34,21 +34,21 @@ class ExportCsv extends ModeleExports * @var int ID */ public $id; - + /** - * @var string proper name for given parameter + * @var string export files label */ public $label; - - var $extension; - var $version; - var $label_lib; - var $version_lib; + public $extension; + public $version; - var $separator; + public $label_lib; + public $version_lib; - var $handle; // Handle fichier + public $separator; + + public $handle; // Handle fichier /** diff --git a/htdocs/core/modules/export/export_excel.modules.php b/htdocs/core/modules/export/export_excel.modules.php index ce38a0c995b..6c50b3c46de 100644 --- a/htdocs/core/modules/export/export_excel.modules.php +++ b/htdocs/core/modules/export/export_excel.modules.php @@ -36,23 +36,23 @@ class ExportExcel extends ModeleExports * @var int ID */ public $id; - + /** - * @var string proper name for given parameter + * @var string Export Excel label */ public $label; - - var $extension; - var $version; - var $label_lib; - var $version_lib; + public $extension; + public $version; - var $workbook; // Handle fichier - var $worksheet; // Handle onglet - var $row; - var $col; - var $file; // To save filename + public $label_lib; + public $version_lib; + + public $workbook; // Handle fichier + public $worksheet; // Handle onglet + public $row; + public $col; + public $file; // To save filename /** diff --git a/htdocs/core/modules/export/export_excel2007.modules.php b/htdocs/core/modules/export/export_excel2007.modules.php index 0c13dfde688..5b2fd563427 100644 --- a/htdocs/core/modules/export/export_excel2007.modules.php +++ b/htdocs/core/modules/export/export_excel2007.modules.php @@ -39,21 +39,21 @@ class ExportExcel2007 extends ExportExcel public $id; /** - * @var string proper name for given parameter + * @var string label */ public $label; - var $extension; - var $version; + public $extension; + public $version; - var $label_lib; - var $version_lib; + public $label_lib; + public $version_lib; - var $workbook; // Handle fichier - var $worksheet; // Handle onglet - var $row; - var $col; - var $file; // To save filename + public $workbook; // Handle fichier + public $worksheet; // Handle onglet + public $row; + public $col; + public $file; // To save filename /** * Constructor diff --git a/htdocs/core/modules/export/export_tsv.modules.php b/htdocs/core/modules/export/export_tsv.modules.php index b5391896b78..db96382a04a 100644 --- a/htdocs/core/modules/export/export_tsv.modules.php +++ b/htdocs/core/modules/export/export_tsv.modules.php @@ -35,21 +35,21 @@ class ExportTsv extends ModeleExports * @var int ID */ public $id; - + /** - * @var string proper name for given parameter + * @var string label */ public $label; - - var $extension; - var $version; - var $label_lib; - var $version_lib; + public $extension; + public $version; - var $separator="\t"; + public $label_lib; + public $version_lib; - var $handle; // Handle fichier + public $separator="\t"; + + public $handle; // Handle fichier /** diff --git a/htdocs/core/modules/import/import_csv.modules.php b/htdocs/core/modules/import/import_csv.modules.php index 08ecb719266..36a5d3d70ba 100644 --- a/htdocs/core/modules/import/import_csv.modules.php +++ b/htdocs/core/modules/import/import_csv.modules.php @@ -37,14 +37,14 @@ class ImportCsv extends ModeleImports * @var DoliDB Database handler. */ public $db; - + var $datatoimport; /** * @var string Error code (or message) */ public $error=''; - + /** * @var string[] Error codes (or messages) */ @@ -54,28 +54,28 @@ class ImportCsv extends ModeleImports * @var int ID */ public $id; - + /** - * @var string proper name for given parameter + * @var string label */ public $label; - - var $extension; // Extension of files imported by driver - var $version; // Version of driver - var $label_lib; // Label of external lib used by driver - var $version_lib; // Version of external lib used by driver + public $extension; // Extension of files imported by driver + public $version; // Version of driver - var $separator; + public $label_lib; // Label of external lib used by driver + public $version_lib; // Version of external lib used by driver - var $file; // Path of file - var $handle; // Handle fichier + public $separator; - var $cacheconvert=array(); // Array to cache list of value found after a convertion - var $cachefieldtable=array(); // Array to cache list of value found into fields@tables + public $file; // Path of file + public $handle; // Handle fichier - var $nbinsert = 0; // # of insert done during the import - var $nbupdate = 0; // # of update done during the import + public $cacheconvert=array(); // Array to cache list of value found after a convertion + public $cachefieldtable=array(); // Array to cache list of value found into fields@tables + + public $nbinsert = 0; // # of insert done during the import + public $nbupdate = 0; // # of update done during the import /** diff --git a/htdocs/core/modules/import/import_xlsx.modules.php b/htdocs/core/modules/import/import_xlsx.modules.php index 09c45da2a72..9ac1d8bc6a6 100644 --- a/htdocs/core/modules/import/import_xlsx.modules.php +++ b/htdocs/core/modules/import/import_xlsx.modules.php @@ -37,14 +37,14 @@ class ImportXlsx extends ModeleImports * @var DoliDB Database handler. */ public $db; - + var $datatoimport; /** * @var string Error code (or message) */ public $error=''; - + /** * @var string[] Error codes (or messages) */ @@ -54,29 +54,29 @@ class ImportXlsx extends ModeleImports * @var int ID */ public $id; - + /** - * @var string proper name for given parameter + * @var string label */ public $label; - - var $extension; // Extension of files imported by driver - var $version; // Version of driver - var $label_lib; // Label of external lib used by driver - var $version_lib; // Version of external lib used by driver + public $extension; // Extension of files imported by driver + public $version; // Version of driver - var $separator; + public $label_lib; // Label of external lib used by driver + public $version_lib; // Version of external lib used by driver - var $file; // Path of file - var $handle; // Handle fichier + public $separator; - var $cacheconvert=array(); // Array to cache list of value found after a convertion - var $cachefieldtable=array(); // Array to cache list of value found into fields@tables + public $file; // Path of file + public $handle; // Handle fichier - var $workbook; // temporary import file - var $record; // current record - var $headers; + public $cacheconvert=array(); // Array to cache list of value found after a convertion + public $cachefieldtable=array(); // Array to cache list of value found into fields@tables + + public $workbook; // temporary import file + public $record; // current record + public $headers; /** diff --git a/htdocs/core/modules/import/modules_import.php b/htdocs/core/modules/import/modules_import.php index a76ae01a325..5bf74ba48d1 100644 --- a/htdocs/core/modules/import/modules_import.php +++ b/htdocs/core/modules/import/modules_import.php @@ -45,7 +45,7 @@ class ModeleImports public $id; /** - * @var string proper name for given parameter + * @var string label */ public $label; diff --git a/htdocs/core/modules/security/generate/modGeneratePassNone.class.php b/htdocs/core/modules/security/generate/modGeneratePassNone.class.php index df3071f7b26..d0e8c617217 100644 --- a/htdocs/core/modules/security/generate/modGeneratePassNone.class.php +++ b/htdocs/core/modules/security/generate/modGeneratePassNone.class.php @@ -35,17 +35,17 @@ class modGeneratePassNone extends ModeleGenPassword * @var int ID */ public $id; - - var $length; + + public $length; /** * @var DoliDB Database handler. */ public $db; - - var $conf; - var $lang; - var $user; + + public $conf; + public $lang; + public $user; /** diff --git a/htdocs/core/modules/security/generate/modGeneratePassPerso.class.php b/htdocs/core/modules/security/generate/modGeneratePassPerso.class.php index d0ae019bf09..a95a48d20b2 100644 --- a/htdocs/core/modules/security/generate/modGeneratePassPerso.class.php +++ b/htdocs/core/modules/security/generate/modGeneratePassPerso.class.php @@ -37,30 +37,30 @@ class modGeneratePassPerso extends ModeleGenPassword * @var int ID */ public $id; - - var $length; - var $length2; // didn't overright display - var $NbMaj; - var $NbNum; - var $NbSpe; - var $NbRepeat; - var $WithoutAmbi; + + public $length; + public $length2; // didn't overright display + public $NbMaj; + public $NbNum; + public $NbSpe; + public $NbRepeat; + public $WithoutAmbi; /** * @var DoliDB Database handler. */ public $db; - - var $conf; - var $lang; - var $user; - var $Maj; - var $Min; - var $Nb; - var $Spe; - var $Ambi; - var $All; + public $conf; + public $lang; + public $user; + + public $Maj; + public $Min; + public $Nb; + public $Spe; + public $Ambi; + public $All; /** * Constructor diff --git a/htdocs/core/modules/security/generate/modGeneratePassStandard.class.php b/htdocs/core/modules/security/generate/modGeneratePassStandard.class.php index 87a792672fb..d051c173c6d 100644 --- a/htdocs/core/modules/security/generate/modGeneratePassStandard.class.php +++ b/htdocs/core/modules/security/generate/modGeneratePassStandard.class.php @@ -35,17 +35,17 @@ class modGeneratePassStandard extends ModeleGenPassword * @var int ID */ public $id; - - var $length; + + public $length; /** * @var DoliDB Database handler. */ public $db; - - var $conf; - var $lang; - var $user; + + public $conf; + public $lang; + public $user; /** diff --git a/htdocs/cron/class/cronjob.class.php b/htdocs/cron/class/cronjob.class.php index 7c9396c70e8..00e33cfb5e7 100644 --- a/htdocs/cron/class/cronjob.class.php +++ b/htdocs/cron/class/cronjob.class.php @@ -42,7 +42,11 @@ class Cronjob extends CommonObject public $picto = 'cron'; - public $entity; + /** + * @var int Entity + */ + public $entity; + public $jobtype; public $tms=''; public $datec=''; @@ -1337,7 +1341,14 @@ class Cronjob extends CommonObject class Cronjobline { + /** + * @var int ID + */ public $id; + + /** + * @var string Ref + */ public $ref; public $tms=''; diff --git a/htdocs/don/class/don.class.php b/htdocs/don/class/don.class.php index 958924c4da5..0f31130c7a6 100644 --- a/htdocs/don/class/don.class.php +++ b/htdocs/don/class/don.class.php @@ -44,32 +44,36 @@ class Don extends CommonObject */ public $table_element='don'; + /** + * @var int Field with ID of parent key if this field has a parent + */ public $fk_element = 'fk_donation'; + public $ismultientitymanaged = 1; // 0=No test on entity, 1=Test with field entity, 2=Test with link by societe - var $picto = 'generic'; + public $picto = 'generic'; - var $date; - var $amount; - var $societe; - var $address; - var $zip; - var $town; - var $email; - var $public; - var $fk_project; - var $fk_typepayment; - var $num_payment; - var $date_valid; - var $modepaymentid = 0; + public $date; + public $amount; + public $societe; + public $address; + public $zip; + public $town; + public $email; + public $public; + public $fk_project; + public $fk_typepayment; + public $num_payment; + public $date_valid; + public $modepaymentid = 0; - var $labelstatut; - var $labelstatutshort; + public $labelstatut; + public $labelstatutshort; /** * @deprecated * @see note_private, note_public */ - var $commentaire; + public $commentaire; /** diff --git a/htdocs/don/class/paymentdonation.class.php b/htdocs/don/class/paymentdonation.class.php index 575a5355877..62b8c6cac5c 100644 --- a/htdocs/don/class/paymentdonation.class.php +++ b/htdocs/don/class/paymentdonation.class.php @@ -41,6 +41,9 @@ class PaymentDonation extends CommonObject public $picto = 'payment'; + /** + * @var int ID + */ public $rowid; public $fk_donation; diff --git a/htdocs/ecm/class/ecmdirectory.class.php b/htdocs/ecm/class/ecmdirectory.class.php index 349cea676f1..a1945565a12 100644 --- a/htdocs/ecm/class/ecmdirectory.class.php +++ b/htdocs/ecm/class/ecmdirectory.class.php @@ -37,7 +37,7 @@ class EcmDirectory // extends CommonObject */ //public $table_element='ecm_directories'; - var $picto = 'dir'; + public $picto = 'dir'; /** * @var int ID @@ -45,24 +45,33 @@ class EcmDirectory // extends CommonObject public $id; /** - * @var string proper name for given parameter + * @var string ECM directories label */ public $label; - var $fk_parent; - var $description; - var $cachenbofdoc=-1; // By default cache initialized with value 'not calculated' - var $date_c; - var $date_m; + public $fk_parent; + + /** + * @var string description + */ + public $description; + + public $cachenbofdoc=-1; // By default cache initialized with value 'not calculated' + public $date_c; + public $date_m; public $fk_user_m; public $fk_user_c; + + /** + * @var string Ref + */ public $ref; - var $cats=array(); - var $motherof=array(); + public $cats=array(); + public $motherof=array(); - var $forbiddenchars = array('<','>',':','/','\\','?','*','|','"'); - var $forbiddencharsdir = array('<','>',':','?','*','|','"'); + public $forbiddenchars = array('<','>',':','/','\\','?','*','|','"'); + public $forbiddencharsdir = array('<','>',':','?','*','|','"'); public $full_arbo_loaded; diff --git a/htdocs/ecm/class/ecmfiles.class.php b/htdocs/ecm/class/ecmfiles.class.php index 38d155f3328..bf264b76207 100644 --- a/htdocs/ecm/class/ecmfiles.class.php +++ b/htdocs/ecm/class/ecmfiles.class.php @@ -48,14 +48,28 @@ class EcmFiles extends CommonObject public $picto = 'generic'; - public $ref; // hash of file path + /** + * @var string Ref hash of file path + */ + public $ref; + public $label; // hash of file content (md5_file(dol_osencode($destfull)) public $share; // hash for file sharing, empty by default (example: getRandomPassword(true)) + + /** + * @var int Entity + */ public $entity; + public $filename; public $filepath; public $fullpath_orig; + + /** + * @var string description + */ public $description; + public $keywords; public $cover; public $position; @@ -832,11 +846,21 @@ class EcmFiles extends CommonObject class EcmfilesLine { public $label; + + /** + * @var int Entity + */ public $entity; + public $filename; public $filepath; public $fullpath_orig; + + /** + * @var string description + */ public $description; + public $keywords; public $cover; public $position; diff --git a/htdocs/expedition/class/expedition.class.php b/htdocs/expedition/class/expedition.class.php index e40faafeefd..dd238adc6a3 100644 --- a/htdocs/expedition/class/expedition.class.php +++ b/htdocs/expedition/class/expedition.class.php @@ -56,53 +56,61 @@ class Expedition extends CommonObject */ public $table_element="expedition"; + /** + * @var int Name of subtable line + */ public $table_element_line="expeditiondet"; + public $ismultientitymanaged = 1; // 0=No test on entity, 1=Test with field entity, 2=Test with link by societe public $picto = 'sending'; - var $socid; - var $ref_customer; - var $ref_int; - var $brouillon; - var $entrepot_id; - var $lines=array(); - var $tracking_number; - var $tracking_url; - var $billed; - var $model_pdf; + public $socid; + public $ref_customer; + public $ref_int; + public $brouillon; + public $entrepot_id; + public $lines=array(); + public $tracking_number; + public $tracking_url; + public $billed; + public $model_pdf; - var $trueWeight; - var $weight_units; - var $trueWidth; - var $width_units; - var $trueHeight; - var $height_units; - var $trueDepth; - var $depth_units; + public $trueWeight; + public $weight_units; + public $trueWidth; + public $width_units; + public $trueHeight; + public $height_units; + public $trueDepth; + public $depth_units; // A denormalized value - var $trueSize; + public $trueSize; + + public $date_delivery; // Date delivery planed - var $date_delivery; // Date delivery planed /** * @deprecated * @see date_shipping */ - var $date; + public $date; + /** * @deprecated * @see date_shipping */ - var $date_expedition; + public $date_expedition; + /** * Effective delivery date * @var int */ public $date_shipping; - var $date_creation; - var $date_valid; - var $meths; - var $listmeths; // List of carriers + public $date_creation; + public $date_valid; + + public $meths; + public $listmeths; // List of carriers const STATUS_DRAFT = 0; diff --git a/htdocs/fichinter/class/fichinter.class.php b/htdocs/fichinter/class/fichinter.class.php index 4a983d02104..1dbbf01e42f 100644 --- a/htdocs/fichinter/class/fichinter.class.php +++ b/htdocs/fichinter/class/fichinter.class.php @@ -45,8 +45,16 @@ class Fichinter extends CommonObject */ public $table_element='fichinter'; + /** + * @var int Field with ID of parent key if this field has a parent + */ public $fk_element='fk_fichinter'; + + /** + * @var int Name of subtable line + */ public $table_element_line='fichinterdet'; + public $picto = 'intervention'; /** @@ -54,36 +62,44 @@ class Fichinter extends CommonObject */ protected $table_ref_field = 'ref'; - var $socid; // Id client + public $socid; // Id client - var $author; - var $datec; - var $datev; - var $dateo; - var $datee; - var $datet; - var $datem; - var $duration; - var $statut = 0; // 0=draft, 1=validated, 2=invoiced, 3=Terminate - var $description; - var $fk_contrat = 0; - var $fk_project = 0; - var $extraparams=array(); + public $author; + public $datec; + public $datev; + public $dateo; + public $datee; + public $datet; + public $datem; + public $duration; + public $statut = 0; // 0=draft, 1=validated, 2=invoiced, 3=Terminate - var $lines = array(); + /** + * @var string description + */ + public $description; + + public $fk_contrat = 0; + public $fk_project = 0; + public $extraparams=array(); + + public $lines = array(); /** * Draft status */ const STATUS_DRAFT = 0; + /** * Validated status */ const STATUS_VALIDATED = 1; + /** * Billed */ const STATUS_BILLED = 2; + /** * Closed */ @@ -1339,11 +1355,11 @@ class FichinterLigne extends CommonObjectLine public $error=''; // From llx_fichinterdet - var $fk_fichinter; - var $desc; // Description ligne - var $datei; // Date intervention - var $duration; // Duree de l'intervention - var $rang = 0; + public $fk_fichinter; + public $desc; // Description ligne + public $datei; // Date intervention + public $duration; // Duree de l'intervention + public $rang = 0; /** * @var string ID to identify managed object @@ -1355,12 +1371,15 @@ class FichinterLigne extends CommonObjectLine */ public $table_element='fichinterdet'; + /** + * @var int Field with ID of parent key if this field has a parent + */ public $fk_element='fk_fichinter'; /** - * Constructor + * Constructor * - * @param DoliDB $db Database handler + * @param DoliDB $db Database handler */ function __construct($db) { diff --git a/htdocs/fourn/class/fournisseur.commande.class.php b/htdocs/fourn/class/fournisseur.commande.class.php index a25d1b96752..0ef569f3304 100644 --- a/htdocs/fourn/class/fournisseur.commande.class.php +++ b/htdocs/fourn/class/fournisseur.commande.class.php @@ -4,11 +4,11 @@ * Copyright (C) 2005-2012 Regis Houssin * Copyright (C) 2007 Franky Van Liedekerke * Copyright (C) 2010-2014 Juanjo Menent - * Copyright (C) 2010-2016 Philippe Grand + * Copyright (C) 2010-2018 Philippe Grand * Copyright (C) 2012-2015 Marcos García * Copyright (C) 2013 Florian Henry * Copyright (C) 2013 Cédric Salvador - * Copyright (C) 2018 Nicolas ZABOURI + * Copyright (C) 2018 Nicolas ZABOURI * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -50,8 +50,16 @@ class CommandeFournisseur extends CommonOrder */ public $table_element='commande_fournisseur'; - public $table_element_line = 'commande_fournisseurdet'; - public $fk_element = 'fk_commande'; + /** + * @var int Name of subtable line + */ + public $table_element_line = 'commande_fournisseurdet'; + + /** + * @var int Field with ID of parent key if this field has a parent + */ + public $fk_element = 'fk_commande'; + public $picto='order'; /** @@ -71,7 +79,10 @@ class CommandeFournisseur extends CommonOrder */ protected $table_ref_field = 'ref'; - public $id; + /** + * @var int ID + */ + public $id; /** * Supplier order reference @@ -100,17 +111,20 @@ class CommandeFournisseur extends CommonOrder * Delivery date */ public $date_livraison; + public $total_ht; public $total_tva; public $total_localtax1; // Total Local tax 1 public $total_localtax2; // Total Local tax 2 public $total_ttc; public $source; + /** * @deprecated * @see note_private, note_public */ public $note; + public $note_private; public $note_public; public $model_pdf; @@ -136,6 +150,7 @@ class CommandeFournisseur extends CommonOrder * @var CommandeFournisseurLigne[] */ public $lines = array(); + //Add for supplier_proposal public $origin; public $origin_id; @@ -153,34 +168,42 @@ class CommandeFournisseur extends CommonOrder * Draft status */ const STATUS_DRAFT = 0; + /** * Validated status */ const STATUS_VALIDATED = 1; + /** * Accepted */ const STATUS_ACCEPTED = 2; + /** * Order sent, shipment on process */ const STATUS_ORDERSENT = 3; + /** * Received partially */ const STATUS_RECEIVED_PARTIALLY = 4; + /** * Received completely */ const STATUS_RECEIVED_COMPLETELY = 5; + /** * Order canceled */ const STATUS_CANCELED = 6; + /** * Order canceled/never received */ const STATUS_CANCELED_AFTER_ORDER = 7; + /** * Refused */ diff --git a/htdocs/fourn/class/fournisseur.commande.dispatch.class.php b/htdocs/fourn/class/fournisseur.commande.dispatch.class.php index 847c1e249c4..906e9bb1377 100644 --- a/htdocs/fourn/class/fournisseur.commande.dispatch.class.php +++ b/htdocs/fourn/class/fournisseur.commande.dispatch.class.php @@ -60,14 +60,22 @@ class CommandeFournisseurDispatch extends CommonObject public $table_element='commande_fournisseur_dispatch'; //!< Name of table without prefix where object is stored public $lines=array(); - public $id; + /** + * @var int ID + */ + public $id; public $fk_commande; public $fk_product; public $fk_commandefourndet; public $qty; public $fk_entrepot; + + /** + * @var int User ID + */ public $fk_user; + public $datec=''; public $comment; public $status; diff --git a/htdocs/fourn/class/fournisseur.facture.class.php b/htdocs/fourn/class/fournisseur.facture.class.php index e8ef92a7d63..981f9e4d81a 100644 --- a/htdocs/fourn/class/fournisseur.facture.class.php +++ b/htdocs/fourn/class/fournisseur.facture.class.php @@ -5,7 +5,7 @@ * Copyright (C) 2005 Marc Barilley * Copyright (C) 2005-2012 Regis Houssin * Copyright (C) 2010-2017 Juanjo Menent - * Copyright (C) 2013 Philippe Grand + * Copyright (C) 2013-2018 Philippe Grand * Copyright (C) 2013 Florian Henry * Copyright (C) 2014-2016 Marcos García * Copyright (C) 2015 Bahfir Abbes @@ -51,8 +51,16 @@ class FactureFournisseur extends CommonInvoice */ public $table_element='facture_fourn'; - public $table_element_line='facture_fourn_det'; - public $fk_element='fk_facture_fourn'; + /** + * @var int Name of subtable line + */ + public $table_element_line='facture_fourn_det'; + + /** + * @var int Field with ID of parent key if this field has a parent + */ + public $fk_element='fk_facture_fourn'; + public $picto='bill'; /** @@ -72,8 +80,16 @@ class FactureFournisseur extends CommonInvoice */ protected $table_ref_field = 'ref'; - public $rowid; - public $ref; + /** + * @var int ID + */ + public $rowid; + + /** + * @var string Ref + */ + public $ref; + public $product_ref; public $ref_supplier; public $socid; @@ -131,6 +147,7 @@ class FactureFournisseur extends CommonInvoice * @var SupplierInvoiceLine[] */ public $lines = array(); + /** * @deprecated */ diff --git a/htdocs/fourn/class/fournisseur.product.class.php b/htdocs/fourn/class/fournisseur.product.class.php index 57502a52365..f97a6c4f4ba 100644 --- a/htdocs/fourn/class/fournisseur.product.class.php +++ b/htdocs/fourn/class/fournisseur.product.class.php @@ -47,7 +47,7 @@ class ProductFournisseur extends Product */ public $error=''; - var $product_fourn_price_id; // id of ligne product-supplier + public $product_fourn_price_id; // id of ligne product-supplier /** * @var int ID @@ -58,35 +58,35 @@ class ProductFournisseur extends Product * @deprecated * @see ref_supplier */ - var $fourn_ref; - var $delivery_time_days; - var $ref_supplier; // ref supplier (can be set by get_buyprice) - var $desc_supplier; - var $vatrate_supplier; // default vat rate for this supplier/qty/product (can be set by get_buyprice) + public $fourn_ref; + public $delivery_time_days; + public $ref_supplier; // ref supplier (can be set by get_buyprice) + public $desc_supplier; + public $vatrate_supplier; // default vat rate for this supplier/qty/product (can be set by get_buyprice) - var $fourn_id; //supplier id - var $fourn_qty; // quantity for price (can be set by get_buyprice) - var $fourn_pu; // unit price for quantity (can be set by get_buyprice) + public $fourn_id; //supplier id + public $fourn_qty; // quantity for price (can be set by get_buyprice) + public $fourn_pu; // unit price for quantity (can be set by get_buyprice) - var $fourn_price; // price for quantity - var $fourn_remise_percent; // discount for quantity (percent) - var $fourn_remise; // discount for quantity (amount) - var $product_fourn_id; // supplier id - var $fk_availability; // availability delay - visible/used if option FOURN_PRODUCT_AVAILABILITY is on (duplicate information compared to delivery delay) - var $fourn_unitprice; - var $fourn_tva_tx; - var $fourn_tva_npr; + public $fourn_price; // price for quantity + public $fourn_remise_percent; // discount for quantity (percent) + public $fourn_remise; // discount for quantity (amount) + public $product_fourn_id; // supplier id + public $fk_availability; // availability delay - visible/used if option FOURN_PRODUCT_AVAILABILITY is on (duplicate information compared to delivery delay) + public $fourn_unitprice; + public $fourn_tva_tx; + public $fourn_tva_npr; - var $fk_supplier_price_expression; - var $supplier_reputation; // reputation of supplier - var $reputations=array(); // list of available supplier reputations + public $fk_supplier_price_expression; + public $supplier_reputation; // reputation of supplier + public $reputations=array(); // list of available supplier reputations // Multicurreny - var $fourn_multicurrency_id; - var $fourn_multicurrency_code; - var $fourn_multicurrency_tx; - var $fourn_multicurrency_price; - var $fourn_multicurrency_unitprice; + public $fourn_multicurrency_id; + public $fourn_multicurrency_code; + public $fourn_multicurrency_tx; + public $fourn_multicurrency_price; + public $fourn_multicurrency_unitprice; /** * Constructor diff --git a/htdocs/holiday/class/holiday.class.php b/htdocs/holiday/class/holiday.class.php index 0f4107bf3ad..ae829333098 100644 --- a/htdocs/holiday/class/holiday.class.php +++ b/htdocs/holiday/class/holiday.class.php @@ -52,9 +52,18 @@ class Holiday extends CommonObject */ var $rowid; - var $fk_user; + /** + * @var int User ID + */ + 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 diff --git a/htdocs/hrm/class/establishment.class.php b/htdocs/hrm/class/establishment.class.php index 8ff5c2da52b..20850964a66 100644 --- a/htdocs/hrm/class/establishment.class.php +++ b/htdocs/hrm/class/establishment.class.php @@ -38,13 +38,32 @@ class Establishment extends CommonObject */ public $table_element='establishment'; + /** + * @var int Name of subtable line + */ public $table_element_line = ''; + + /** + * @var int Field with ID of parent key if this field has a parent + */ public $fk_element = 'fk_establishment'; + public $ismultientitymanaged = 1; // 0=No test on entity, 1=Test with field entity, 2=Test with link by societe public $picto='building'; - public $id; - public $ref; + /** + * @var int ID + */ + public $id; + + /** + * @var string Ref + */ + public $ref; + + /** + * @var int ID + */ public $rowid; public $name; @@ -52,6 +71,10 @@ class Establishment extends CommonObject public $zip; public $town; public $status; // 0=open, 1=closed + + /** + * @var int Entity + */ public $entity; public $country_id; diff --git a/htdocs/livraison/class/livraison.class.php b/htdocs/livraison/class/livraison.class.php index 70fd069356b..e3c03b723b1 100644 --- a/htdocs/livraison/class/livraison.class.php +++ b/htdocs/livraison/class/livraison.class.php @@ -3,8 +3,8 @@ * Copyright (C) 2005-2014 Regis Houssin * Copyright (C) 2006-2007 Laurent Destailleur * Copyright (C) 2007 Franky Van Liedekerke - * Copyright (C) 2011-2018 Philippe Grand - * Copyright (C) 2013 Florian Henry + * Copyright (C) 2011-2018 Philippe Grand + * Copyright (C) 2013 Florian Henry * Copyright (C) 2014-2015 Marcos García * * This program is free software; you can redistribute it and/or modify @@ -24,7 +24,7 @@ /** * \file htdocs/livraison/class/livraison.class.php * \ingroup delivery - * \brief Fichier de la classe de gestion des bons de livraison + * \brief Delivery Order Management Class File */ require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php'; @@ -44,6 +44,9 @@ class Livraison extends CommonObject */ public $element="delivery"; + /** + * @var int Field with ID of parent key if this field has a parent + */ public $fk_element="fk_livraison"; /** @@ -51,16 +54,19 @@ class Livraison extends CommonObject */ public $table_element="livraison"; + /** + * @var int Name of subtable line + */ public $table_element_line="livraisondet"; - var $brouillon; - var $socid; - var $ref_customer; + public $brouillon; + public $socid; + public $ref_customer; - var $date_delivery; // Date really received - var $date_creation; - var $date_valid; - var $model_pdf; + public $date_delivery; // Date really received + public $date_creation; + public $date_valid; + public $model_pdf; /** * Constructor @@ -158,7 +164,7 @@ class Livraison extends CommonObject /* - * Insertion des produits dans la base + * Inserting products into the database */ $num=count($this->lines); for ($i = 0; $i < $num; $i++) @@ -312,7 +318,7 @@ class Livraison extends CommonObject if ($this->statut == 0) $this->brouillon = 1; - // Retreive all extrafield + // Retreive all extrafields // fetch optionals attributes and labels $this->fetch_optionals(); @@ -363,7 +369,7 @@ class Livraison extends CommonObject { if (! empty($conf->global->LIVRAISON_ADDON_NUMBER)) { - // Definition du nom de module de numerotation de commande + // Setting the command numbering module name $modName = $conf->global->LIVRAISON_ADDON_NUMBER; if (is_readable(DOL_DOCUMENT_ROOT .'/core/modules/livraison/'.$modName.'.php')) @@ -372,7 +378,7 @@ class Livraison extends CommonObject $now=dol_now(); - // Recuperation de la nouvelle reference + // Retrieving the new reference $objMod = new $modName($this->db); $soc = new Societe($this->db); $soc->fetch($this->socid); @@ -387,8 +393,7 @@ class Livraison extends CommonObject } $this->newref = $numref; - // Tester si non deja au statut valide. Si oui, on arrete afin d'eviter - // de decrementer 2 fois le stock. + // Test if is not already in valid status. If so, we stop to avoid decrementing the stock twice. $sql = "SELECT ref"; $sql.= " FROM ".MAIN_DB_PREFIX."livraison"; $sql.= " WHERE ref = '".$this->db->escape($numref)."'"; @@ -496,10 +501,10 @@ class Livraison extends CommonObject // phpcs:disable PEAR.NamingConventions.ValidFunctionName.NotCamelCaps /** - * Cree le bon de livraison depuis une expedition existante + * Creating the delivery slip from an existing shipment * - * @param User $user Utilisateur qui cree - * @param int $sending_id Id de l'expedition qui sert de modele + * @param User $user User who creates + * @param int $sending_id Id of the expedition that serves as a model * @return integer */ function create_from_sending($user, $sending_id) @@ -1073,7 +1078,7 @@ class Livraison extends CommonObject /** - * Classe de gestion des lignes de bons de livraison + * Management class of delivery note lines */ class LivraisonLigne extends CommonObjectLine { @@ -1091,11 +1096,19 @@ class LivraisonLigne extends CommonObjectLine var $origin_id; /** - * @var string proper name for given parameter + * @var string delivery note lines label */ public $label; +<<<<<<< HEAD var $description; // Description produit +======= + /** + * @var string product description + */ + public $description; + +>>>>>>> upstream/develop /** * @deprecated * @see product_ref diff --git a/htdocs/loan/class/loan.class.php b/htdocs/loan/class/loan.class.php index ba14c2828b6..09956a30b7b 100644 --- a/htdocs/loan/class/loan.class.php +++ b/htdocs/loan/class/loan.class.php @@ -43,7 +43,11 @@ class Loan extends CommonObject public $picto = 'bill'; + /** + * @var int ID + */ public $rowid; + public $datestart; public $dateend; public $label; diff --git a/htdocs/modulebuilder/template/class/myobject.class.php b/htdocs/modulebuilder/template/class/myobject.class.php index a37f9d35c18..0f1b95b903c 100644 --- a/htdocs/modulebuilder/template/class/myobject.class.php +++ b/htdocs/modulebuilder/template/class/myobject.class.php @@ -101,9 +101,21 @@ class MyObject extends CommonObject 'status' =>array('type'=>'integer', 'label'=>'Status', 'enabled'=>1, 'visible'=>1, 'notnull'=>1, 'default'=>0, 'index'=>1, 'position'=>1000, 'arrayofkeyval'=>array(0=>'Draft', 1=>'Active', -1=>'Cancel')), ); + /** + * @var int ID + */ public $rowid; + + /** + * @var string Ref + */ public $ref; + + /** + * @var int Entity + */ public $entity; + public $label; public $amount; public $status; diff --git a/htdocs/multicurrency/class/multicurrency.class.php b/htdocs/multicurrency/class/multicurrency.class.php index 2e3723ab667..ab72aabaee0 100644 --- a/htdocs/multicurrency/class/multicurrency.class.php +++ b/htdocs/multicurrency/class/multicurrency.class.php @@ -42,12 +42,12 @@ class MultiCurrency extends CommonObject * @var string Id to identify managed objects */ public $element = 'multicurrency'; - + /** * @var string Name of table without prefix where object is stored */ public $table_element = 'multicurrency'; - + /** * @var string Name of table without prefix where object is stored */ @@ -62,32 +62,32 @@ class MultiCurrency extends CommonObject * @var mixed Sample property 1 */ public $id; - + /** * @var mixed Sample property 1 */ public $code; - + /** * @var mixed Sample property 2 */ public $name; - + /** - * @var mixed Sample property 2 + * @var int Entity */ public $entity; - + /** * @var mixed Sample property 2 */ public $date_create; - + /** * @var mixed Sample property 2 */ public $fk_user; - + /** * @var mixed Sample property 2 */ @@ -694,32 +694,32 @@ class CurrencyRate extends CommonObjectLine * @var string Id to identify managed objects */ public $element = 'multicurrency_rate'; - + /** * @var string Name of table without prefix where object is stored */ public $table_element = 'multicurrency_rate'; - + /** * @var int ID */ public $id; - + /** * @var double Rate */ public $rate; - + /** * @var date Date synchronisation */ public $date_sync; - + /** * @var int Id of currency */ public $fk_multicurrency; - + /** * @var int Id of entity */ diff --git a/htdocs/opensurvey/class/opensurveysondage.class.php b/htdocs/opensurvey/class/opensurveysondage.class.php index f0c01594191..169aebde712 100644 --- a/htdocs/opensurvey/class/opensurveysondage.class.php +++ b/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; diff --git a/htdocs/product/class/product.class.php b/htdocs/product/class/product.class.php index 4f81927dca0..2b5b9c71ba6 100644 --- a/htdocs/product/class/product.class.php +++ b/htdocs/product/class/product.class.php @@ -53,7 +53,11 @@ class Product extends CommonObject */ public $table_element='product'; + /** + * @var int Field with ID of parent key if this field has a parent + */ public $fk_element='fk_product'; + protected $childtables=array('supplier_proposaldet', 'propaldet','commandedet','facturedet','contratdet','facture_fourn_det','commande_fournisseurdet'); // To test if we can delete object public $ismultientitymanaged = 1; // 0=No test on entity, 1=Test with field entity, 2=Test with link by societe diff --git a/htdocs/product/class/productcustomerprice.class.php b/htdocs/product/class/productcustomerprice.class.php index 589321eacb0..681e0892af0 100644 --- a/htdocs/product/class/productcustomerprice.class.php +++ b/htdocs/product/class/productcustomerprice.class.php @@ -38,24 +38,34 @@ class Productcustomerprice extends CommonObject */ public $table_element = 'product_customer_price'; - var $entity; - var $datec = ''; - var $tms = ''; - var $fk_product; - var $fk_soc; - var $price; - var $price_ttc; - var $price_min; - var $price_min_ttc; - var $price_base_type; - var $tva_tx; - var $recuperableonly; - var $localtax1_type; - var $localtax1_tx; - var $localtax2_type; - var $localtax2_tx; - var $fk_user; - var $lines = array (); + public $entity; + public $datec = ''; + public $tms = ''; + public $fk_product; + + /** + * @var int Thirdparty ID + */ + public $fk_soc; + + public $price; + public $price_ttc; + public $price_min; + public $price_min_ttc; + public $price_base_type; + public $tva_tx; + public $recuperableonly; + public $localtax1_type; + public $localtax1_tx; + public $localtax2_type; + public $localtax2_tx; + + /** + * @var int User ID + */ + public $fk_user; + + public $lines = array (); /** * Constructor @@ -967,23 +977,33 @@ class PriceByCustomerLine */ public $id; - var $entity; - var $datec = ''; - var $tms = ''; - var $fk_product; - var $fk_soc; - var $price; - var $price_ttc; - var $price_min; - var $price_min_ttc; - var $price_base_type; - var $default_vat_code; - var $tva_tx; - var $recuperableonly; - var $localtax1_tx; - var $localtax2_tx; - var $fk_user; - var $import_key; - var $socname; - var $prodref; + public $entity; + public $datec = ''; + public $tms = ''; + public $fk_product; + + /** + * @var int Thirdparty ID + */ + public $fk_soc; + + public $price; + public $price_ttc; + public $price_min; + public $price_min_ttc; + public $price_base_type; + public $default_vat_code; + public $tva_tx; + public $recuperableonly; + public $localtax1_tx; + public $localtax2_tx; + + /** + * @var int User ID + */ + public $fk_user; + + public $import_key; + public $socname; + public $prodref; } diff --git a/htdocs/product/class/propalmergepdfproduct.class.php b/htdocs/product/class/propalmergepdfproduct.class.php index b02f1710bb5..e58e09c4bfd 100644 --- a/htdocs/product/class/propalmergepdfproduct.class.php +++ b/htdocs/product/class/propalmergepdfproduct.class.php @@ -648,14 +648,14 @@ class PropalmergepdfproductLine */ public $id; - var $fk_product; - var $file_name; - var $lang; - var $fk_user_author; - var $fk_user_mod; - var $datec=''; - var $tms=''; - var $import_key; + public $fk_product; + public $file_name; + public $lang; + public $fk_user_author; + public $fk_user_mod; + public $datec=''; + public $tms=''; + public $import_key; /** * Constructor diff --git a/htdocs/product/dynamic_price/class/price_expression.class.php b/htdocs/product/dynamic_price/class/price_expression.class.php index 8d7dfbb7ce4..c7300be5d20 100644 --- a/htdocs/product/dynamic_price/class/price_expression.class.php +++ b/htdocs/product/dynamic_price/class/price_expression.class.php @@ -49,13 +49,13 @@ class PriceExpression */ public $id; - var $title; - var $expression; + public $title; + public $expression; /** - * @var string Name of table without prefix where object is stored - */ - public $table_element = "c_price_expression"; + * @var string Name of table without prefix where object is stored + */ + public $table_element = "c_price_expression"; /** * Constructor diff --git a/htdocs/product/dynamic_price/class/price_global_variable.class.php b/htdocs/product/dynamic_price/class/price_global_variable.class.php index f30260a30c0..ebdba3b5949 100644 --- a/htdocs/product/dynamic_price/class/price_global_variable.class.php +++ b/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 $value; - + + public $code; + + /** + * @var string description + */ + public $description; + + public $value; + /** * @var string Name of table without prefix where object is stored */ diff --git a/htdocs/product/dynamic_price/class/price_global_variable_updater.class.php b/htdocs/product/dynamic_price/class/price_global_variable_updater.class.php index 69639677f73..14ea4357a66 100644 --- a/htdocs/product/dynamic_price/class/price_global_variable_updater.class.php +++ b/htdocs/product/dynamic_price/class/price_global_variable_updater.class.php @@ -44,21 +44,26 @@ class PriceGlobalVariableUpdater */ public $errors = array(); - var $types=array(0, 1); //!< Updater types - var $update_min = 5; //!< Minimal update rate + public $types=array(0, 1); //!< Updater types + public $update_min = 5; //!< Minimal update rate /** * @var int ID */ public $id; - var $type; - var $description; - var $parameters; - var $fk_variable; - var $update_interval; //!< Interval in mins - var $next_update; //!< Next update timestamp - var $last_status; + public $type; + + /** + * @var string description + */ + public $description; + + public $parameters; + public $fk_variable; + public $update_interval; //!< Interval in mins + public $next_update; //!< Next update timestamp + public $last_status; /** * @var string Name of table without prefix where object is stored @@ -68,7 +73,7 @@ class PriceGlobalVariableUpdater /** * Constructor * - * @param DoliDb $db Database handler + * @param DoliDb $db Database handler */ function __construct($db) { diff --git a/htdocs/product/inventory/class/inventory.class.php b/htdocs/product/inventory/class/inventory.class.php index ae5cbd0e580..750b675c92a 100644 --- a/htdocs/product/inventory/class/inventory.class.php +++ b/htdocs/product/inventory/class/inventory.class.php @@ -99,9 +99,21 @@ class Inventory extends CommonObject 'status' => array('type'=>'integer', 'label'=>'Status', 'visible'=>1, 'enabled'=>1, 'position'=>1000, 'default'=>0, 'arrayofkeyval'=>array(0=>'Todo', 1=>'Done', -1=>'Cancel')), ); + /** + * @var int ID + */ public $rowid; + + /** + * @var string Ref + */ public $ref; + + /** + * @var int Entity + */ public $entity; + public $fk_warehouse; public $date_inventory; public $title; @@ -472,10 +484,12 @@ class InventoryObjectLine * @var int ID */ public $id; + /** * @var mixed Sample line property 1 */ public $prop1; + /** * @var mixed Sample line property 2 */ diff --git a/htdocs/product/stock/class/entrepot.class.php b/htdocs/product/stock/class/entrepot.class.php index a0aee6fb2b5..9f205580444 100644 --- a/htdocs/product/stock/class/entrepot.class.php +++ b/htdocs/product/stock/class/entrepot.class.php @@ -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; diff --git a/htdocs/product/stock/class/productlot.class.php b/htdocs/product/stock/class/productlot.class.php index 2cee8f7a2a1..7eb3593de35 100644 --- a/htdocs/product/stock/class/productlot.class.php +++ b/htdocs/product/stock/class/productlot.class.php @@ -55,9 +55,10 @@ class Productlot extends CommonObject public $lines = array(); /** + * @var int Entity */ - public $entity; + public $fk_product; public $batch; public $eatby = ''; @@ -68,9 +69,6 @@ class Productlot extends CommonObject public $fk_user_modif; public $import_key; - /** - */ - /** * Constructor diff --git a/htdocs/projet/class/project.class.php b/htdocs/projet/class/project.class.php index 0cf0b35a985..9af52721787 100644 --- a/htdocs/projet/class/project.class.php +++ b/htdocs/projet/class/project.class.php @@ -43,8 +43,16 @@ class Project extends CommonObject */ public $table_element = 'projet'; - public $table_element_line = 'projet_task'; - public $fk_element = 'fk_projet'; + /** + * @var int Name of subtable line + */ + public $table_element_line = 'projet_task'; + + /** + * @var int Field with ID of parent key if this field has a parent + */ + public $fk_element = 'fk_projet'; + public $ismultientitymanaged = 1; // 0=No test on entity, 1=Test with field entity, 2=Test with link by societe public $picto = 'projectpub'; @@ -53,38 +61,43 @@ class Project extends CommonObject */ protected $table_ref_field = 'ref'; - var $description; + /** + * @var string description + */ + public $description; + /** * @var string * @deprecated * @see title */ public $titre; - var $title; - var $date_start; - var $date_end; - var $date_close; - var $socid; // To store id of thirdparty - var $thirdparty_name; // To store name of thirdparty (defined only in some cases) + public $title; + public $date_start; + public $date_end; + public $date_close; - var $user_author_id; //!< Id of project creator. Not defined if shared project. - var $user_close_id; - var $public; //!< Tell if this is a public or private project - var $budget_amount; - var $bill_time; // Is the time spent on project must be invoiced or not + public $socid; // To store id of thirdparty + public $thirdparty_name; // To store name of thirdparty (defined only in some cases) - var $statuts_short; - var $statuts_long; + public $user_author_id; //!< Id of project creator. Not defined if shared project. + public $user_close_id; + public $public; //!< Tell if this is a public or private project + public $budget_amount; + public $bill_time; // Is the time spent on project must be invoiced or not - var $statut; // 0=draft, 1=opened, 2=closed - var $opp_status; // opportunity status, into table llx_c_lead_status - var $opp_percent; // opportunity probability + public $statuts_short; + public $statuts_long; - var $oldcopy; + public $statut; // 0=draft, 1=opened, 2=closed + public $opp_status; // opportunity status, into table llx_c_lead_status + public $opp_percent; // opportunity probability - var $weekWorkLoad; // Used to store workload details of a projet - var $weekWorkLoadPerTask; // Used to store workload details of tasks of a projet + public $oldcopy; + + public $weekWorkLoad; // Used to store workload details of a projet + public $weekWorkLoadPerTask; // Used to store workload details of tasks of a projet /** * @var int Creation date @@ -92,16 +105,19 @@ class Project extends CommonObject * @see date_c */ public $datec; + /** * @var int Creation date */ public $date_c; + /** * @var int Modification date * @deprecated * @see date_m */ public $datem; + /** * @var int Modification date */ @@ -116,10 +132,12 @@ class Project extends CommonObject * Draft status */ const STATUS_DRAFT = 0; + /** * Open/Validated status */ const STATUS_VALIDATED = 1; + /** * Closed status */ diff --git a/htdocs/projet/class/task.class.php b/htdocs/projet/class/task.class.php index 9404bbc5aaa..a908f3315fd 100644 --- a/htdocs/projet/class/task.class.php +++ b/htdocs/projet/class/task.class.php @@ -41,7 +41,11 @@ class Task extends CommonObject */ public $table_element='projet_task'; + /** + * @var int Field with ID of parent key if this field has a parent + */ public $fk_element='fk_task'; + public $picto = 'task'; protected $childtables=array('projet_task_time'); // To test if we can delete object @@ -52,7 +56,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; diff --git a/htdocs/societe/class/address.class.php b/htdocs/societe/class/address.class.php index 578127fc248..5f8d8036b22 100644 --- a/htdocs/societe/class/address.class.php +++ b/htdocs/societe/class/address.class.php @@ -33,7 +33,11 @@ class Address { protected $db; + /** + * @var int ID + */ public $id; + public $type; public $label; public $socid; @@ -498,7 +502,12 @@ class Address class AddressLine { protected $db; + + /** + * @var int ID + */ public $id; + public $date_creation; public $date_modification; public $label; diff --git a/htdocs/societe/class/companypaymentmode.class.php b/htdocs/societe/class/companypaymentmode.class.php index 7ff2e2de6f9..d2c9dcc4a7d 100644 --- a/htdocs/societe/class/companypaymentmode.class.php +++ b/htdocs/societe/class/companypaymentmode.class.php @@ -118,8 +118,17 @@ class CompanyPaymentMode extends CommonObject 'import_key' =>array('type'=>'varchar(14)', 'label'=>'Import key', 'enabled'=>1, 'visible'=>-2, 'position'=>105), //'aaa' =>array('type'=>'date', 'label'=>'Ending date', 'enabled'=>0, 'visible'=>-2, 'position'=>185), ); + + /** + * @var int ID + */ public $rowid; - public $fk_soc; + + /** + * @var int Thirdparty ID + */ + public $fk_soc; + public $label; public $bank; public $code_banque; diff --git a/htdocs/societe/class/societe.class.php b/htdocs/societe/class/societe.class.php index 2cd3ba2f6d8..53dc04218fa 100644 --- a/htdocs/societe/class/societe.class.php +++ b/htdocs/societe/class/societe.class.php @@ -51,7 +51,11 @@ class Societe extends CommonObject */ public $table_element = 'societe'; + /** + * @var int Field with ID of parent key if this field has a parent + */ public $fk_element='fk_soc'; + public $fieldsforcombobox='nom,name_alias'; protected $childtables=array("supplier_proposal"=>'SupplierProposal',"propal"=>'Proposal',"commande"=>'Order',"facture"=>'Invoice',"facture_rec"=>'RecurringInvoiceTemplate',"contrat"=>'Contract',"fichinter"=>'Fichinter',"facture_fourn"=>'SupplierInvoice',"commande_fournisseur"=>'SupplierOrder',"projet"=>'Project',"expedition"=>'Shipment',"prelevement_lignes"=>'DirectDebitRecord'); // To test if we can delete object protected $childtablesoncascade=array("societe_prices", "societe_log", "societe_address", "product_fournisseur_price", "product_customer_price_log", "product_customer_price", "socpeople", "adherent", "societe_rib", "societe_remise", "societe_remise_except", "societe_commerciaux", "categorie", "notify", "notify_def", "actioncomm"); @@ -90,6 +94,9 @@ class Societe extends CommonObject ); + /** + * @var int Entity + */ public $entity; /** @@ -374,7 +381,11 @@ class Societe extends CommonObject */ public $default_lang; + /** + * @var string Ref + */ public $ref; + public $ref_int; /** * External user reference. diff --git a/htdocs/societe/class/societeaccount.class.php b/htdocs/societe/class/societeaccount.class.php index 61e7303a35b..690eacd4037 100644 --- a/htdocs/societe/class/societeaccount.class.php +++ b/htdocs/societe/class/societeaccount.class.php @@ -100,13 +100,23 @@ class SocieteAccount extends CommonObject 'status' => array('type'=>'integer', 'label'=>'Status', 'visible'=>1, 'enabled'=>1, 'position'=>1000, 'notnull'=>1, 'index'=>1, 'default'=>1, 'arrayofkeyval'=>array('1'=>'Active','0'=>'Disabled')), ); public $rowid; + + /** + * @var int Entity + */ public $entity; + public $key_account; public $login; public $pass_encoding; public $pass_crypted; public $pass_temp; - public $fk_soc; + + /** + * @var int Thirdparty ID + */ + public $fk_soc; + public $site; public $date_last_login; public $date_previous_login; diff --git a/htdocs/stripe/class/stripe.class.php b/htdocs/stripe/class/stripe.class.php index 5e3cfc7f522..4264ae984b0 100644 --- a/htdocs/stripe/class/stripe.class.php +++ b/htdocs/stripe/class/stripe.class.php @@ -28,15 +28,36 @@ require_once DOL_DOCUMENT_ROOT.'/stripe/config.php'; // This set stripe glo */ class Stripe extends CommonObject { + /** + * @var int ID + */ public $rowid; - public $fk_soc; + + /** + * @var int Thirdparty ID + */ + public $fk_soc; + public $fk_key; + + /** + * @var int ID + */ public $id; + public $mode; + + /** + * @var int Entity + */ public $entity; + public $statut; + public $type; + public $code; + public $message; /** diff --git a/htdocs/supplier_proposal/class/supplier_proposal.class.php b/htdocs/supplier_proposal/class/supplier_proposal.class.php index f690cdd8625..533b35ab0ab 100644 --- a/htdocs/supplier_proposal/class/supplier_proposal.class.php +++ b/htdocs/supplier_proposal/class/supplier_proposal.class.php @@ -7,7 +7,7 @@ * Copyright (C) 2006 Andre Cianfarani * Copyright (C) 2008 Raphael Bertrand * Copyright (C) 2010-2015 Juanjo Menent - * Copyright (C) 2010-2011 Philippe Grand + * Copyright (C) 2010-2018 Philippe Grand * Copyright (C) 2012-2014 Christophe Battarel * Copyright (C) 2013 Florian Henry * Copyright (C) 2014 Marcos García @@ -55,14 +55,21 @@ class SupplierProposal extends CommonObject */ public $table_element='supplier_proposal'; - public $table_element_line='supplier_proposaldet'; + /** + * @var int Name of subtable line + */ + public $table_element_line='supplier_proposaldet'; + public $fk_element='fk_supplier_proposal'; + public $picto='propal'; + /** * 0=No test on entity, 1=Test with field entity, 2=Test with link by societe * @var int */ public $ismultientitymanaged = 1; + /** * 0=Default, 1=View may be restricted to sales representative only if no permission to see all or to company of external user if external user * @var integer @@ -74,24 +81,25 @@ class SupplierProposal extends CommonObject */ protected $table_ref_field = 'ref'; - var $socid; // Id client + public $socid; // Id client /** * @deprecated * @see user_author_id */ - var $author; - var $ref_fourn; //Reference saisie lors de l'ajout d'une ligne à la demande - var $ref_supplier; //Reference saisie lors de l'ajout d'une ligne à la demande - var $statut; // 0 (draft), 1 (validated), 2 (signed), 3 (not signed), 4 (processed/billed) - var $date; // Date of proposal - var $date_livraison; + public $author; + + public $ref_fourn; //Reference saisie lors de l'ajout d'une ligne à la demande + public $ref_supplier; //Reference saisie lors de l'ajout d'une ligne à la demande + public $statut; // 0 (draft), 1 (validated), 2 (signed), 3 (not signed), 4 (processed/billed) + public $date; // Date of proposal + public $date_livraison; /** * @deprecated * @see date_creation */ - var $datec; + public $datec; /** * Creation date @@ -103,7 +111,7 @@ class SupplierProposal extends CommonObject * @deprecated * @see date_validation */ - var $datev; + public $datev; /** * Validation date @@ -112,70 +120,76 @@ class SupplierProposal extends CommonObject public $date_validation; - var $user_author_id; - var $user_valid_id; - var $user_close_id; + public $user_author_id; + public $user_valid_id; + public $user_close_id; /** * @deprecated * @see price_ht */ - var $price; + public $price; + /** * @deprecated * @see total_tva */ - var $tva; + public $tva; + /** * @deprecated * @see total_ttc */ - var $total; + public $total; - var $cond_reglement_code; - var $mode_reglement_code; - var $remise = 0; - var $remise_percent = 0; - var $remise_absolue = 0; + public $cond_reglement_code; + public $mode_reglement_code; + public $remise = 0; + public $remise_percent = 0; + public $remise_absolue = 0; - var $products=array(); - var $extraparams=array(); + public $products=array(); + public $extraparams=array(); - var $lines = array(); - var $line; + public $lines = array(); + public $line; - var $labelstatut=array(); - var $labelstatut_short=array(); + public $labelstatut=array(); + public $labelstatut_short=array(); - var $nbtodo; - var $nbtodolate; + public $nbtodo; + public $nbtodolate; - var $specimen; + public $specimen; // Multicurrency - var $fk_multicurrency; - var $multicurrency_code; - var $multicurrency_tx; - var $multicurrency_total_ht; - var $multicurrency_total_tva; - var $multicurrency_total_ttc; + public $fk_multicurrency; + public $multicurrency_code; + public $multicurrency_tx; + public $multicurrency_total_ht; + public $multicurrency_total_tva; + public $multicurrency_total_ttc; /** * Draft status */ const STATUS_DRAFT = 0; + /** * Validated status */ const STATUS_VALIDATED = 1; + /** * Signed quote */ const STATUS_SIGNED = 2; + /** * Not signed quote, canceled */ const STATUS_NOTSIGNED = 3; + /** * Billed or closed/processed quote */ @@ -2685,25 +2699,37 @@ class SupplierProposalLine extends CommonObjectLine */ public $table_element='supplier_proposaldet'; - var $oldline; + public $oldline; // From llx_supplier_proposaldet +<<<<<<< HEAD var $rowid; // deprecated +======= + public $rowid; // deprecated +>>>>>>> upstream/develop /** * @var int ID */ public $id; +<<<<<<< HEAD var $fk_supplier_proposal; var $fk_parent_line; var $desc; // Description ligne var $fk_product; // Id produit predefini +======= + public $fk_supplier_proposal; + public $fk_parent_line; + public $desc; // Description ligne + public $fk_product; // Id produit predefini + +>>>>>>> upstream/develop /** * @deprecated * @see product_type */ - var $fk_product_type; + public $fk_product_type; /** * Product type * @var int @@ -2711,89 +2737,94 @@ class SupplierProposalLine extends CommonObjectLine */ public $product_type = Product::TYPE_PRODUCT; - var $qty; - var $tva_tx; - var $subprice; - var $remise_percent; - var $fk_remise_except; + public $qty; + public $tva_tx; + public $subprice; + public $remise_percent; + public $fk_remise_except; - var $rang = 0; + public $rang = 0; - var $fk_fournprice; - var $pa_ht; - var $marge_tx; - var $marque_tx; + public $fk_fournprice; + public $pa_ht; + public $marge_tx; + public $marque_tx; - var $special_code; // Tag for special lines (exlusive tags) + public $special_code; // Tag for special lines (exlusive tags) // 1: frais de port // 2: ecotaxe // 3: option line (when qty = 0) - var $info_bits = 0; // Liste d'options cumulables: + public $info_bits = 0; // Liste d'options cumulables: // Bit 0: 0 si TVA normal - 1 si TVA NPR // Bit 1: 0 ligne normale - 1 si ligne de remise fixe - var $total_ht; // Total HT de la ligne toute quantite et incluant la remise ligne - var $total_tva; // Total TVA de la ligne toute quantite et incluant la remise ligne - var $total_ttc; // Total TTC de la ligne toute quantite et incluant la remise ligne + public $total_ht; // Total HT de la ligne toute quantite et incluant la remise ligne + public $total_tva; // Total TVA de la ligne toute quantite et incluant la remise ligne + public $total_ttc; // Total TTC de la ligne toute quantite et incluant la remise ligne /** * @deprecated * @see remise_percent, fk_remise_except */ - var $remise; + public $remise; + /** * @deprecated * @see subprice */ - var $price; + public $price; // From llx_product /** * @deprecated * @see product_ref */ - var $ref; + public $ref; + /** * Product reference * @var string */ public $product_ref; + /** * @deprecated * @see product_label */ - var $libelle; + public $libelle; + /** * Product label * @var string */ public $product_label; + /** * Product description * @var string */ public $product_desc; - var $localtax1_tx; // Local tax 1 - var $localtax2_tx; // Local tax 2 - var $localtax1_type; // Local tax 1 type - var $localtax2_type; // Local tax 2 type - var $total_localtax1; // Line total local tax 1 - var $total_localtax2; // Line total local tax 2 + public $localtax1_tx; // Local tax 1 + public $localtax2_tx; // Local tax 2 + public $localtax1_type; // Local tax 1 type + public $localtax2_type; // Local tax 2 type + public $total_localtax1; // Line total local tax 1 + public $total_localtax2; // Line total local tax 2 - var $skip_update_total; // Skip update price total for special lines + public $skip_update_total; // Skip update price total for special lines - var $ref_fourn; - var $ref_supplier; + public $ref_fourn; + public $ref_supplier; // Multicurrency - var $fk_multicurrency; - var $multicurrency_code; - var $multicurrency_subprice; - var $multicurrency_total_ht; - var $multicurrency_total_tva; - var $multicurrency_total_ttc; + public $fk_multicurrency; + public $multicurrency_code; + public $multicurrency_subprice; + public $multicurrency_total_ht; + public $multicurrency_total_tva; + public $multicurrency_total_ttc; /** * Class line Contructor diff --git a/htdocs/ticket/class/actions_ticket.class.php b/htdocs/ticket/class/actions_ticket.class.php index 8cf9dc40ed5..845ca8ca773 100644 --- a/htdocs/ticket/class/actions_ticket.class.php +++ b/htdocs/ticket/class/actions_ticket.class.php @@ -61,9 +61,17 @@ class ActionsTicket public $template; public $label; - public $description; + + /** + * @var string description + */ + public $description; public $fk_statut; + + /** + * @var int Thirdparty ID + */ public $fk_soc; /** diff --git a/htdocs/ticket/class/ticket.class.php b/htdocs/ticket/class/ticket.class.php index 10ddd3054c1..03aec1eb818 100644 --- a/htdocs/ticket/class/ticket.class.php +++ b/htdocs/ticket/class/ticket.class.php @@ -2486,7 +2486,10 @@ class Ticket extends CommonObject */ class TicketsLine { - public $id; + /** + * @var int ID + */ + public $id; /** * @var string $ref Ticket reference @@ -2499,8 +2502,8 @@ class TicketsLine public $track_id; /** - * Thirdparty ID - */ + * @var int Thirdparty ID + */ public $fk_soc; /** diff --git a/htdocs/ticket/class/ticketlogs.class.php b/htdocs/ticket/class/ticketlogs.class.php index e006759ed51..c5e77bc9dae 100644 --- a/htdocs/ticket/class/ticketlogs.class.php +++ b/htdocs/ticket/class/ticketlogs.class.php @@ -57,7 +57,10 @@ class Ticketlogs// extends CommonObject */ public $table_element = 'ticketlogs'; //!< Name of table without prefix where object is stored - public $id; + /** + * @var int ID + */ + public $id; public $fk_track_id; public $fk_user_create; diff --git a/htdocs/user/class/user.class.php b/htdocs/user/class/user.class.php index 2e566226423..3f3e217dc04 100644 --- a/htdocs/user/class/user.class.php +++ b/htdocs/user/class/user.class.php @@ -76,6 +76,10 @@ class User extends CommonObject public $admin; public $login; public $api_key; + + /** + * @var int Entity + */ public $entity; //! Clear password in memory @@ -103,6 +107,10 @@ class User extends CommonObject public $contactid; public $fk_member; + + /** + * @var int User ID + */ public $fk_user; public $clicktodial_url; diff --git a/htdocs/user/class/usergroup.class.php b/htdocs/user/class/usergroup.class.php index 33360116c97..78ef5b7a390 100644 --- a/htdocs/user/class/usergroup.class.php +++ b/htdocs/user/class/usergroup.class.php @@ -47,8 +47,11 @@ class UserGroup extends CommonObject public $ismultientitymanaged = 1; // 0=No test on entity, 1=Test with field entity, 2=Test with link by societe public $picto='group'; - public $entity; // Entity of group + /** + * @var int Entity of group + */ + public $entity; public $name; // Name of group /** diff --git a/htdocs/website/class/website.class.php b/htdocs/website/class/website.class.php index 039bea84bc6..d8e5b4e7c52 100644 --- a/htdocs/website/class/website.class.php +++ b/htdocs/website/class/website.class.php @@ -56,22 +56,22 @@ class Website extends CommonObject public $picto = 'globe'; /** - * @var int + * @var int Entity */ public $entity; /** - * @var string + * @var string Ref */ public $ref; /** - * @var string + * @var string description */ public $description; /** - * @var int + * @var int Status */ public $status; diff --git a/htdocs/website/class/websitepage.class.php b/htdocs/website/class/websitepage.class.php index 3f446f13a5b..a3a7f2e94f9 100644 --- a/htdocs/website/class/websitepage.class.php +++ b/htdocs/website/class/websitepage.class.php @@ -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;