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

doxygen societe class

Browse Source
This commit is contained in:
Frédéric FRANCE 2019-12-08 14:26:59 +01:00
parent 3f0fd9b82a
commit 48564ea760
No known key found for this signature in database
GPG Key ID: 06809324E4B2ABC1
2 changed files with 148 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
htdocs/install/mysql/tables/llx_societe.sql
View File

@ -52,15 +52,15 @@ create table llx_societe
email varchar(128), -- email varchar(128), --
socialnetworks text DEFAULT NULL, -- json with socialnetworks socialnetworks text DEFAULT NULL, -- json with socialnetworks
skype varchar(255), -- skype varchar(255), -- deprecated
twitter varchar(255), -- twitter varchar(255), -- deprecated
facebook varchar(255), -- facebook varchar(255), -- deprecated
linkedin varchar(255), -- linkedin varchar(255), -- deprecated
instagram varchar(255), -- instagram varchar(255), -- deprecated
snapchat varchar(255), -- snapchat varchar(255), -- deprecated
googleplus varchar(255), -- googleplus varchar(255), -- deprecated
youtube varchar(255), -- youtube varchar(255), -- deprecated
whatsapp varchar(255), -- whatsapp varchar(255), -- deprecated
fk_effectif integer DEFAULT 0, -- fk_effectif integer DEFAULT 0, --
fk_typent integer DEFAULT 0, -- fk_typent integer DEFAULT 0, --

155
htdocs/societe/class/societe.class.php
View File

@ -59,16 +59,51 @@ class Societe extends CommonObject
*/ */
public $fk_element = 'fk_soc'; public $fk_element = 'fk_soc';
/**
* @var string Fields for combobox
*/
public $fieldsforcombobox = 'nom,name_alias'; public $fieldsforcombobox = 'nom,name_alias';
/** /**
* @var array List of child tables. To test if we can delete object. * @var array List of child tables. To test if we can delete object.
*/ */
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'); 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',
);
/** /**
* @var array List of child tables. To know object to delete on cascade. * @var array List of child tables. To know object to delete on cascade.
*/ */
protected $childtablesoncascade = array("societe_prices", "societe_log", "societe_address", "product_fournisseur_price", "product_customer_price_log", "product_customer_price", "socpeople", "adherent", "societe_account", "societe_rib", "societe_remise", "societe_remise_except", "societe_commerciaux", "categorie", "notify", "notify_def", "actioncomm"); protected $childtablesoncascade = array(
"societe_prices",
"societe_log",
"societe_address",
"product_fournisseur_price",
"product_customer_price_log",
"product_customer_price",
"socpeople",
"adherent",
"societe_account",
"societe_rib",
"societe_remise",
"societe_remise_except",
"societe_commerciaux",
"categorie",
"notify",
"notify_def",
"actioncomm",
);
/** /**
* @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png * @var string String with name of icon for myobject. Must be the part after the 'object_' into object_myobject.png
@ -87,8 +122,6 @@ class Societe extends CommonObject
*/ */
public $restrictiononfksoc = 1; public $restrictiononfksoc = 1;
// BEGIN MODULEBUILDER PROPERTIES
/** /**
* @var array Array with all fields and their property. Do not use it as a static var. It may be modified by constructor. * @var array Array with all fields and their property. Do not use it as a static var. It may be modified by constructor.
*/ */
@ -123,7 +156,7 @@ class Societe extends CommonObject
public $nom; public $nom;
/** /**
* @var string name * @var string Thirdparty name
*/ */
public $name; public $name;
@ -133,6 +166,9 @@ class Societe extends CommonObject
*/ */
public $name_alias; public $name_alias;
/**
* @var int Physical thirdparty not a company
*/
public $particulier; public $particulier;
/** /**
@ -140,7 +176,14 @@ class Societe extends CommonObject
*/ */
public $address; public $address;
/**
* @var string Zip code of thirdparty
*/
public $zip; public $zip;
/**
* @var string Town of thirdparty
*/
public $town; public $town;
/** /**
@ -154,7 +197,15 @@ class Societe extends CommonObject
* @var int * @var int
*/ */
public $state_id; public $state_id;
/**
* @var string State code
*/
public $state_code; public $state_code;
/**
* @var string State name
*/
public $state; public $state;
/** /**
@ -162,11 +213,14 @@ class Societe extends CommonObject
* @var int * @var int
*/ */
public $region_code; public $region_code;
/**
* @var string Region name
*/
public $region; public $region;
/** /**
* State code * @var string State code
* @var string
* @deprecated Use state_code instead * @deprecated Use state_code instead
* @see $state_code * @see $state_code
*/ */
@ -220,25 +274,27 @@ class Societe extends CommonObject
* @deprecated * @deprecated
*/ */
public $twitter; public $twitter;
/** /**
* Facebook username * Facebook username
* @var string * @var string
* @deprecated * @deprecated
*/ */
public $facebook; public $facebook;
/** /**
* LinkedIn username * LinkedIn username
* @var string * @var string
* @deprecated * @deprecated
*/ */
public $linkedin; public $linkedin;
/** /**
* Webpage * Webpage
* @var string * @var string
*/ */
public $url; public $url;
//! barcode
/** /**
* Barcode value * Barcode value
* @var string * @var string
@ -283,9 +339,16 @@ class Societe extends CommonObject
*/ */
public $idprof6; public $idprof6;
/**
* @var string Prefix comm
*/
public $prefix_comm; public $prefix_comm;
/**
* @var int Vat concerned
*/
public $tva_assuj = 1; public $tva_assuj = 1;
/** /**
* Intracommunitary VAT ID * Intracommunitary VAT ID
* @var string * @var string
@ -298,8 +361,19 @@ class Societe extends CommonObject
public $localtax2_assuj; public $localtax2_assuj;
public $localtax2_value; public $localtax2_value;
/**
* @var string Manager
*/
public $managers; public $managers;
/**
* @var float Capital
*/
public $capital; public $capital;
/**
* @var int Type thirdparty
*/
public $typent_id = 0; public $typent_id = 0;
public $typent_code; public $typent_code;
public $effectif; public $effectif;
@ -317,6 +391,9 @@ class Societe extends CommonObject
*/ */
public $fk_prospectlevel; public $fk_prospectlevel;
/**
* @var string second name
*/
public $name_bis; public $name_bis;
//Log data //Log data
@ -326,6 +403,7 @@ class Societe extends CommonObject
* @var string * @var string
*/ */
public $date_modification; public $date_modification;
/** /**
* User that made last update * User that made last update
* @var string * @var string
@ -351,11 +429,13 @@ class Societe extends CommonObject
* @var int * @var int
*/ */
public $client = 0; public $client = 0;
/** /**
* 0=no prospect, 1=prospect * 0=no prospect, 1=prospect
* @var int * @var int
*/ */
public $prospect = 0; public $prospect = 0;
/** /**
* 0=no supplier, 1=supplier * 0=no supplier, 1=supplier
* @var int * @var int
@ -416,6 +496,7 @@ class Societe extends CommonObject
* @var int * @var int
*/ */
public $stcomm_id; public $stcomm_id;
/** /**
* Status prospect label * Status prospect label
* @var int * @var int
@ -427,12 +508,20 @@ class Societe extends CommonObject
* @var int * @var int
*/ */
public $price_level; public $price_level;
/**
* @var string outstanding limit
*/
public $outstanding_limit; public $outstanding_limit;
/** /**
* Min order amounts * @var string Min order amount
*/ */
public $order_min_amount; public $order_min_amount;
/**
* @var string Supplier min order amount
*/
public $supplier_order_min_amount; public $supplier_order_min_amount;
/** /**
@ -440,11 +529,13 @@ class Societe extends CommonObject
* @var int * @var int
*/ */
public $commercial_id; public $commercial_id;
/** /**
* Id of parent thirdparty (if one) * Id of parent thirdparty (if one)
* @var int * @var int
*/ */
public $parent; public $parent;
/** /**
* Default language code of thirdparty (en_US, ...) * Default language code of thirdparty (en_US, ...)
* @var string * @var string
@ -456,7 +547,11 @@ class Societe extends CommonObject
*/ */
public $ref; public $ref;
/**
* @var string Internal ref
*/
public $ref_int; public $ref_int;
/** /**
* External user reference. * External user reference.
* This is to allow external systems to store their id and make self-developed synchronizing functions easier to * This is to allow external systems to store their id and make self-developed synchronizing functions easier to
@ -485,22 +580,49 @@ class Societe extends CommonObject
*/ */
public $webservices_key; public $webservices_key;
/**
* @var string Logo
*/
public $logo; public $logo;
/**
* @var string logo small
*/
public $logo_small; public $logo_small;
/**
* @var string Logo mini
*/
public $logo_mini; public $logo_mini;
/**
* @var string Logo squarred
*/
public $logo_squarred; public $logo_squarred;
/**
* @var string Logo squarred small
*/
public $logo_squarred_small; public $logo_squarred_small;
/**
* @var string Logo squarred mini
*/
public $logo_squarred_mini; public $logo_squarred_mini;
public $array_options;
// Incoterms
/** /**
* @var int ID * @var int ID Incoterms
*/ */
public $fk_incoterms; public $fk_incoterms;
/**
* @var string Incoterms Location
*/
public $location_incoterms; public $location_incoterms;
/**
* @var string Incoterm label
*/
public $label_incoterms; //Used into tooltip public $label_incoterms; //Used into tooltip
// Multicurrency // Multicurrency
@ -509,12 +631,11 @@ class Societe extends CommonObject
*/ */
public $fk_multicurrency; public $fk_multicurrency;
/**
* @var string Multicurrency code
*/
public $multicurrency_code; public $multicurrency_code;
// END MODULEBUILDER PROPERTIES
/** /**
* Constructor * Constructor
* *