Fix doxygen

This commit is contained in:
Laurent Destailleur 2019-04-04 18:33:12 +02:00
parent 5891d0a056
commit fff9b7db9d
37 changed files with 128 additions and 142 deletions

View File

@ -56,7 +56,7 @@ class AdherentType extends CommonObject
/** /**
* @var string * @var string
* @deprecated Use label * @deprecated Use label
* @see label * @see $label
*/ */
public $libelle; public $libelle;

View File

@ -66,7 +66,7 @@ function bomAdminPrepareHead()
/** /**
* Prepare array of tabs for BillOfMaterials * Prepare array of tabs for BillOfMaterials
* *
* @param BillOfMaterials $object BillOfMaterials * @param BOM $object BillOfMaterials
* @return array Array of tabs * @return array Array of tabs
*/ */
function bomPrepareHead($object) function bomPrepareHead($object)

View File

@ -281,7 +281,7 @@ class Facturation
* Getter for id * Getter for id
* *
* @param int $aId Id * @param int $aId Id
* @return id * @return int Id
*/ */
public function id($aId = null) public function id($aId = null)
{ {
@ -542,8 +542,8 @@ class Facturation
/** /**
* Get payment date * Get payment date
* *
* @param date $aPaiementLe Date * @param integer $aPaiementLe Date
* @return date Date * @return integer Date
*/ */
public function paiementLe($aPaiementLe = null) public function paiementLe($aPaiementLe = null)
{ {

View File

@ -1303,9 +1303,9 @@ class CMailFile
* This function has been modified as provided by SirSir to allow multiline responses when * This function has been modified as provided by SirSir to allow multiline responses when
* using SMTP Extensions. * using SMTP Extensions.
* *
* @param Socket $socket Socket * @param resource $socket Socket
* @param string $response Response string * @param string $response Response string
* @return boolean true if success * @return boolean true if success
*/ */
public function server_parse($socket, $response) public function server_parse($socket, $response)
{ {

View File

@ -3286,7 +3286,7 @@ abstract class CommonObject
* @param string $targettype Object target type * @param string $targettype Object target type
* @param int $rowid Row id of line to delete. If defined, other parameters are not used. * @param int $rowid Row id of line to delete. If defined, other parameters are not used.
* @return int >0 if OK, <0 if KO * @return int >0 if OK, <0 if KO
* @see add_object_linked, updateObjectLinked, fetchObjectLinked * @see add_object_linked(), updateObjectLinked(), fetchObjectLinked()
*/ */
public function deleteObjectLinked($sourceid = null, $sourcetype = '', $targetid = null, $targettype = '', $rowid = '') public function deleteObjectLinked($sourceid = null, $sourcetype = '', $targetid = null, $targettype = '', $rowid = '')
{ {

View File

@ -39,7 +39,7 @@ abstract class CommonObjectLine extends CommonObject
* Id of the line * Id of the line
* @var int * @var int
* @deprecated Try to use id property as possible (even if field into database is still rowid) * @deprecated Try to use id property as possible (even if field into database is still rowid)
* @see id * @see $id
*/ */
public $rowid; public $rowid;

View File

@ -41,7 +41,7 @@ abstract class CommonOrderLine extends CommonObjectLine
* Product ref * Product ref
* @var string * @var string
* @deprecated Use product_ref * @deprecated Use product_ref
* @see product_ref * @see $product_ref
*/ */
public $ref; public $ref;
@ -55,7 +55,7 @@ abstract class CommonOrderLine extends CommonObjectLine
* Product label * Product label
* @var string * @var string
* @deprecated Use product_label * @deprecated Use product_label
* @see product_label * @see $product_label
*/ */
public $libelle; public $libelle;
@ -80,7 +80,7 @@ abstract class CommonOrderLine extends CommonObjectLine
/** /**
* Unit price * Unit price
* @deprecated * @deprecated
* @see subprice * @see $subprice
*/ */
public $price; public $price;

View File

@ -82,7 +82,7 @@ class CoreObject extends CommonObject
* *
* @param string $field name of field * @param string $field name of field
* @param string $type type of field to test * @param string $type type of field to test
* @return value of field or false * @return boolean value of field or false
*/ */
private function checkFieldType($field, $type) private function checkFieldType($field, $type)
{ {

View File

@ -54,7 +54,7 @@ class Cstate // extends CommonObject
/** /**
* @var string * @var string
* @deprecated * @deprecated
* @see name * @see $name
*/ */
public $nom=''; public $nom='';

View File

@ -257,7 +257,7 @@ class DolGraph
* *
* @param array $data Data * @param array $data Data
* @return void * @return void
* @see draw_jflot for syntax of data array * @see draw_jflot() for syntax of data array
*/ */
public function SetData($data) public function SetData($data)
{ {

View File

@ -2321,7 +2321,7 @@ class Form
* constructProductListOption. * constructProductListOption.
* This define value for &$opt and &$optJson. * This define value for &$opt and &$optJson.
* *
* @param resultset $objp Resultset of fetch * @param resource $objp Resultset of fetch
* @param string $opt Option (var used for returned value in string option format) * @param string $opt Option (var used for returned value in string option format)
* @param string $optJson Option (var used for returned value in json format) * @param string $optJson Option (var used for returned value in json format)
* @param int $price_level Price level * @param int $price_level Price level
@ -5153,7 +5153,7 @@ class Form
* @param datetime $adddateof Add a link "Date of invoice" using the following date. * @param datetime $adddateof Add a link "Date of invoice" using the following date.
* @return string|void Nothing or string if nooutput is 1 * @return string|void Nothing or string if nooutput is 1
* @deprecated * @deprecated
* @see form_date, select_month, select_year, select_dayofweek * @see form_date(), select_month(), select_year(), select_dayofweek()
*/ */
public function select_date($set_time = '', $prefix = 're', $h = 0, $m = 0, $empty = 0, $form_name = "", $d = 1, $addnowlink = 0, $nooutput = 0, $disabled = 0, $fullday = '', $addplusone = '', $adddateof = '') public function select_date($set_time = '', $prefix = 're', $h = 0, $m = 0, $empty = 0, $form_name = "", $d = 1, $addnowlink = 0, $nooutput = 0, $disabled = 0, $fullday = '', $addplusone = '', $adddateof = '')
{ {
@ -6056,7 +6056,7 @@ class Form
* @param string $placeholder String to use as placeholder * @param string $placeholder String to use as placeholder
* @param integer $acceptdelayedhtml 1 = caller is requesting to have html js content not returned but saved into global $delayedhtmlcontent (so caller can show it at end of page to avoid flash FOUC effect) * @param integer $acceptdelayedhtml 1 = caller is requesting to have html js content not returned but saved into global $delayedhtmlcontent (so caller can show it at end of page to avoid flash FOUC effect)
* @return string HTML select string * @return string HTML select string
* @see selectArrayAjax, ajax_combobox in ajax.lib.php * @see selectArrayAjax(), ajax_combobox() in ajax.lib.php
*/ */
public static function selectArrayFilter($htmlname, $array, $id = '', $moreparam = '', $disableFiltering = 0, $disabled = 0, $minimumInputLength = 1, $morecss = '', $callurlonselect = 0, $placeholder = '', $acceptdelayedhtml = 0) public static function selectArrayFilter($htmlname, $array, $id = '', $moreparam = '', $disableFiltering = 0, $disabled = 0, $minimumInputLength = 1, $morecss = '', $callurlonselect = 0, $placeholder = '', $acceptdelayedhtml = 0)
{ {

View File

@ -215,7 +215,7 @@ class FormCompany
* @param integer $country_codeid Country code or id: 0=list for all countries, otherwise country code or country rowid to show * @param integer $country_codeid Country code or id: 0=list for all countries, otherwise country code or country rowid to show
* @param string $htmlname Id of department. If '', we want only the string with <option> * @param string $htmlname Id of department. If '', we want only the string with <option>
* @return string String with HTML select * @return string String with HTML select
* @see select_country * @see select_country()
*/ */
public function select_state($selected = '', $country_codeid = 0, $htmlname = 'state_id') public function select_state($selected = '', $country_codeid = 0, $htmlname = 'state_id')
{ {

View File

@ -1432,7 +1432,7 @@ class FormFile
* @param string $url Full url to use for click links ('' = autodetect) * @param string $url Full url to use for click links ('' = autodetect)
* @param int $addfilterfields Add line with filters * @param int $addfilterfields Add line with filters
* @return int <0 if KO, nb of files shown if OK * @return int <0 if KO, nb of files shown if OK
* @see list_of_documents * @see list_of_documents()
*/ */
public function list_of_autoecmfiles($upload_dir, $filearray, $modulepart, $param, $forcedownload = 0, $relativepath = '', $permtodelete = 1, $useinecm = 0, $textifempty = '', $maxlength = 0, $url = '', $addfilterfields = 0) public function list_of_autoecmfiles($upload_dir, $filearray, $modulepart, $param, $forcedownload = 0, $relativepath = '', $permtodelete = 1, $useinecm = 0, $textifempty = '', $maxlength = 0, $url = '', $addfilterfields = 0)
{ {

View File

@ -327,7 +327,7 @@ class FormOther
* @param int $showempty Add also an empty line * @param int $showempty Add also an empty line
* @param string $morecss More CSS * @param string $morecss More CSS
* @return string Html combo list code * @return string Html combo list code
* @see select_all_categories * @see select_all_categories()
*/ */
public function select_categories($type, $selected = 0, $htmlname = 'search_categ', $nocateg = 0, $showempty = 1, $morecss = '') public function select_categories($type, $selected = 0, $htmlname = 'search_categ', $nocateg = 0, $showempty = 1, $morecss = '')
{ {
@ -618,7 +618,7 @@ class FormOther
* @param string $color String with hex (FFFFFF) or comma RGB ('255,255,255') * @param string $color String with hex (FFFFFF) or comma RGB ('255,255,255')
* @param string $textifnotdefined Text to show if color not defined * @param string $textifnotdefined Text to show if color not defined
* @return string HTML code for color thumb * @return string HTML code for color thumb
* @see selectColor * @see selectColor()
*/ */
public static function showColor($color, $textifnotdefined = '') public static function showColor($color, $textifnotdefined = '')
{ {
@ -661,7 +661,7 @@ class FormOther
* @param array $arrayofcolors Array of colors. Example: array('29527A','5229A3','A32929','7A367A','B1365F','0D7813') * @param array $arrayofcolors Array of colors. Example: array('29527A','5229A3','A32929','7A367A','B1365F','0D7813')
* @param string $morecss Add css style into input field * @param string $morecss Add css style into input field
* @return string * @return string
* @see showColor * @see showColor()
*/ */
public static function selectColor($set_color = '', $prefix = 'f_color', $form_name = '', $showcolorbox = 1, $arrayofcolors = '', $morecss = '') public static function selectColor($set_color = '', $prefix = 'f_color', $form_name = '', $showcolorbox = 1, $arrayofcolors = '', $morecss = '')
{ {
@ -1233,7 +1233,7 @@ class FormOther
dol_print_error($this->db); dol_print_error($this->db);
} }
} }
/** /**
* Return an html string with a select combo box to choose yes or no * Return an html string with a select combo box to choose yes or no
* *

View File

@ -1759,7 +1759,7 @@ class SMTPs
* This function has been modified as provided by SirSir to allow multiline responses when * This function has been modified as provided by SirSir to allow multiline responses when
* using SMTP Extensions * using SMTP Extensions
* *
* @param Handler $socket Socket handler * @param resource $socket Socket handler
* @param string $response Response. Example: "550 5.7.1 https://support.google.com/a/answer/6140680#invalidcred j21sm814390wre.3" * @param string $response Response. Example: "550 5.7.1 https://support.google.com/a/answer/6140680#invalidcred j21sm814390wre.3"
* @return boolean True or false * @return boolean True or false
*/ */

View File

@ -152,7 +152,7 @@ class vCard
/** /**
* mise en forme de l'anniversaire * mise en forme de l'anniversaire
* *
* @param timestamp $date Date * @param integer $date Date
* @return void * @return void
*/ */
public function setBirthday($date) public function setBirthday($date)

View File

@ -61,7 +61,7 @@ abstract class DolibarrTriggers
* Error reported by the trigger * Error reported by the trigger
* @var string * @var string
* @deprecated Use $this->errors * @deprecated Use $this->errors
* @see errors * @see $errors
*/ */
public $error = ''; public $error = '';

View File

@ -127,13 +127,13 @@ class Expedition extends CommonObject
/** /**
* @deprecated * @deprecated
* @see date_shipping * @see $date_shipping
*/ */
public $date; public $date;
/** /**
* @deprecated * @deprecated
* @see date_shipping * @see $date_shipping
*/ */
public $date_expedition; public $date_expedition;
@ -1776,8 +1776,8 @@ class Expedition extends CommonObject
/** /**
* Set the planned delivery date * Set the planned delivery date
* *
* @param User $user Objet utilisateur qui modifie * @param User $user Objet user that modify
* @param timestamp $date_livraison Date de livraison * @param integer $date_livraison Date of delivery
* @return int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
*/ */
public function set_date_livraison($user, $date_livraison) public function set_date_livraison($user, $date_livraison)
@ -1840,7 +1840,7 @@ class Expedition extends CommonObject
/** /**
* Fetch all deliveries method and return an array. Load array this->listmeths. * Fetch all deliveries method and return an array. Load array this->listmeths.
* *
* @param id $id only this carrier, all if none * @param int $id only this carrier, all if none
* @return void * @return void
*/ */
public function list_delivery_methods($id = '') public function list_delivery_methods($id = '')
@ -1906,8 +1906,7 @@ class Expedition extends CommonObject
/** /**
* Activate delivery method. * Activate delivery method.
* *
* @param id $id id method to activate * @param int $id id method to activate
*
* @return void * @return void
*/ */
public function activ_delivery_method($id) public function activ_delivery_method($id)
@ -1923,7 +1922,7 @@ class Expedition extends CommonObject
/** /**
* DesActivate delivery method. * DesActivate delivery method.
* *
* @param id $id id method to desactivate * @param int $id id method to desactivate
* *
* @return void * @return void
*/ */
@ -2370,7 +2369,7 @@ class ExpeditionLigne extends CommonObjectLine
/** /**
* @deprecated * @deprecated
* @see fk_origin_line * @see $fk_origin_line
*/ */
public $origin_line_id; public $origin_line_id;
@ -2429,7 +2428,7 @@ class ExpeditionLigne extends CommonObjectLine
/** /**
* @deprecated * @deprecated
* @see product_label * @see $product_label
*/ */
public $libelle; public $libelle;
@ -2441,7 +2440,7 @@ class ExpeditionLigne extends CommonObjectLine
/** /**
* @var string product description * @var string product description
* @deprecated * @deprecated
* @see product_desc * @see $product_desc
*/ */
public $desc; public $desc;

View File

@ -1318,7 +1318,7 @@ class ExpenseReport extends CommonObject
* setDeny * setDeny
* *
* @param User $fuser User * @param User $fuser User
* @param Details $details Details * @param string $details Details
* @param int $notrigger Disable triggers * @param int $notrigger Disable triggers
* @return int * @return int
*/ */
@ -2088,10 +2088,10 @@ class ExpenseReport extends CommonObject
/** /**
* periode_existe * periode_existe
* *
* @param User $fuser User * @param User $fuser User
* @param Date $date_debut Start date * @param integer $date_debut Start date
* @param Date $date_fin End date * @param integer $date_fin End date
* @return int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
*/ */
public function periode_existe($fuser, $date_debut, $date_fin) public function periode_existe($fuser, $date_debut, $date_fin)
{ {

View File

@ -143,10 +143,10 @@ class ExpenseReportRule extends CoreObject
/** /**
* Return all rules or filtered by something * Return all rules or filtered by something
* *
* @param int $fk_c_type_fees type of expense * @param int $fk_c_type_fees type of expense
* @param date $date date of expense * @param integer $date date of expense
* @param type $fk_user user of expense * @param int $fk_user user of expense
* @return array \ExpenseReportRule * @return array Array with ExpenseReportRule
*/ */
public static function getAllRule($fk_c_type_fees = '', $date = '', $fk_user = '') public static function getAllRule($fk_c_type_fees = '', $date = '', $fk_user = '')
{ {

View File

@ -1042,7 +1042,7 @@ class Fichinter extends CommonObject
* Defines a delivery date of intervention * Defines a delivery date of intervention
* *
* @param User $user Object user who define * @param User $user Object user who define
* @param date $date_delivery date of delivery * @param integer $date_delivery date of delivery
* @return int <0 if ko, >0 if ok * @return int <0 if ko, >0 if ok
*/ */
public function set_date_delivery($user, $date_delivery) public function set_date_delivery($user, $date_delivery)
@ -1235,7 +1235,7 @@ class Fichinter extends CommonObject
* @param user $user User that do the action * @param user $user User that do the action
* @param int $fichinterid Id of intervention * @param int $fichinterid Id of intervention
* @param string $desc Line description * @param string $desc Line description
* @param date $date_intervention Intervention date * @param integer $date_intervention Intervention date
* @param int $duration Intervention duration * @param int $duration Intervention duration
* @param array $array_options Array option * @param array $array_options Array option
* @return int >0 if ok, <0 if ko * @return int >0 if ok, <0 if ko

View File

@ -123,7 +123,7 @@ class CommandeFournisseur extends CommonOrder
/** /**
* @deprecated * @deprecated
* @see note_private, note_public * @see $note_private, $note_public
*/ */
public $note; public $note;
@ -776,7 +776,7 @@ class CommandeFournisseur extends CommonOrder
* Returns the following order reference not used depending on the numbering model activated * Returns the following order reference not used depending on the numbering model activated
* defined within COMMANDE_SUPPLIER_ADDON_NUMBER * defined within COMMANDE_SUPPLIER_ADDON_NUMBER
* *
* @param Company $soc company object * @param Societe $soc company object
* @return string free reference for the invoice * @return string free reference for the invoice
*/ */
public function getNextNumRef($soc) public function getNextNumRef($soc)
@ -1145,7 +1145,7 @@ class CommandeFournisseur extends CommonOrder
* Submit a supplier order to supplier * Submit a supplier order to supplier
* *
* @param User $user User making change * @param User $user User making change
* @param date $date Date * @param integer $date Date
* @param int $methode Method * @param int $methode Method
* @param string $comment Comment * @param string $comment Comment
* @return int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
@ -1752,8 +1752,8 @@ class CommandeFournisseur extends CommonOrder
* @param int $entrepot Id of warehouse to add product * @param int $entrepot Id of warehouse to add product
* @param double $price Unit Price for PMP value calculation (Unit price without Tax and taking into account discount) * @param double $price Unit Price for PMP value calculation (Unit price without Tax and taking into account discount)
* @param string $comment Comment for stock movement * @param string $comment Comment for stock movement
* @param date $eatby eat-by date * @param integer $eatby eat-by date
* @param date $sellby sell-by date * @param integer $sellby sell-by date
* @param string $batch Lot number * @param string $batch Lot number
* @param int $fk_commandefourndet Id of supplier order line * @param int $fk_commandefourndet Id of supplier order line
* @param int $notrigger 1 = notrigger * @param int $notrigger 1 = notrigger
@ -2103,7 +2103,7 @@ class CommandeFournisseur extends CommonOrder
* Set a delivery in database for this supplier order * Set a delivery in database for this supplier order
* *
* @param User $user User that input data * @param User $user User that input data
* @param date $date Date of reception * @param integer $date Date of reception
* @param string $type Type of receipt ('tot' = total/done, 'par' = partial, 'nev' = never, 'can' = cancel) * @param string $type Type of receipt ('tot' = total/done, 'par' = partial, 'nev' = never, 'can' = cancel)
* @param string $comment Comment * @param string $comment Comment
* @return int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
@ -2220,7 +2220,7 @@ class CommandeFournisseur extends CommonOrder
* Set the planned delivery date * Set the planned delivery date
* *
* @param User $user Objet user making change * @param User $user Objet user making change
* @param timestamp $date_livraison Planned delivery date * @param integer $date_livraison Planned delivery date
* @param int $notrigger 1=Does not execute triggers, 0= execute triggers * @param int $notrigger 1=Does not execute triggers, 0= execute triggers
* @return int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
*/ */
@ -2465,8 +2465,8 @@ class CommandeFournisseur extends CommonOrder
* @param int $info_bits Miscellaneous informations * @param int $info_bits Miscellaneous informations
* @param int $type Type of line (0=product, 1=service) * @param int $type Type of line (0=product, 1=service)
* @param int $notrigger Disable triggers * @param int $notrigger Disable triggers
* @param timestamp $date_start Date start of service * @param integer $date_start Date start of service
* @param timestamp $date_end Date end of service * @param integer $date_end Date end of service
* @param array $array_options Extrafields array * @param array $array_options Extrafields array
* @param string $fk_unit Code of the unit to use. Null to use the default one * @param string $fk_unit Code of the unit to use. Null to use the default one
* @param double $pu_ht_devise Unit price in currency * @param double $pu_ht_devise Unit price in currency
@ -2508,7 +2508,7 @@ class CommandeFournisseur extends CommonOrder
$this->error=$langs->trans('ErrorStartDateGreaterEnd'); $this->error=$langs->trans('ErrorStartDateGreaterEnd');
return -1; return -1;
} }
$this->db->begin(); $this->db->begin();
// Calcul du total TTC et de la TVA pour la ligne a partir de // Calcul du total TTC et de la TVA pour la ligne a partir de
@ -2926,7 +2926,7 @@ class CommandeFournisseur extends CommonOrder
* Return the max number delivery delay in day * Return the max number delivery delay in day
* *
* @param Translate $langs Language object * @param Translate $langs Language object
* @return Translated string * @return string Translated string
*/ */
public function getMaxDeliveryTimeDay($langs) public function getMaxDeliveryTimeDay($langs)
{ {

View File

@ -90,7 +90,7 @@ class LoanSchedule extends CommonObject
/** /**
* @deprecated * @deprecated
* @see amount, amounts * @see $amount, $amounts
*/ */
public $total; public $total;
@ -177,7 +177,6 @@ class LoanSchedule extends CommonObject
if ($totalamount != 0 && ! $error) if ($totalamount != 0 && ! $error)
{ {
$this->amount_capital=$totalamount; $this->amount_capital=$totalamount;
$this->total=$totalamount; // deprecated
$this->db->commit(); $this->db->commit();
return $this->id; return $this->id;
} }

View File

@ -25,8 +25,8 @@
require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php'; require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';
/** \class PaymentLoan /**
* \brief Class to manage payments of loans * Class to manage payments of loans
*/ */
class PaymentLoan extends CommonObject class PaymentLoan extends CommonObject
{ {
@ -90,12 +90,6 @@ class PaymentLoan extends CommonObject
*/ */
public $fk_user_modif; public $fk_user_modif;
/**
* @deprecated
* @see amount, amounts
*/
public $total;
/** /**
* Constructor * Constructor
* *
@ -178,7 +172,6 @@ class PaymentLoan extends CommonObject
if ($totalamount != 0 && ! $error) if ($totalamount != 0 && ! $error)
{ {
$this->amount_capital=$totalamount; $this->amount_capital=$totalamount;
$this->total=$totalamount; // deprecated
$this->db->commit(); $this->db->commit();
return $this->id; return $this->id;
} }
@ -448,7 +441,7 @@ class PaymentLoan extends CommonObject
$acc = new Account($this->db); $acc = new Account($this->db);
$acc->fetch($accountid); $acc->fetch($accountid);
$total=$this->total; $total=$this->amount_capital;
if ($mode == 'payment_loan') $total=-$total; if ($mode == 'payment_loan') $total=-$total;
// Insert payment into llx_bank // Insert payment into llx_bank

View File

@ -492,10 +492,10 @@ class MultiCurrency extends CommonObject
/** /**
* Get id of currency from code * Get id of currency from code
* *
* @param DoliDB $db object db * @param DoliDB $db object db
* @param string $code code value search * @param string $code code value search
* *
* @return 0 if not found, >0 if OK * @return int 0 if not found, >0 if OK
*/ */
public static function getIdFromCode(&$db, $code) public static function getIdFromCode(&$db, $code)
{ {
@ -512,9 +512,9 @@ class MultiCurrency extends CommonObject
/** /**
* Get id and rate of currency from code * Get id and rate of currency from code
* *
* @param DoliDB $db object db * @param DoliDB $db Object db
* @param string $code code value search * @param string $code Code value search
* @param date $date_document date from document (propal, order, invoice, ...) * @param integer $date_document Date from document (propal, order, invoice, ...)
* *
* @return array [0] => id currency * @return array [0] => id currency
* [1] => rate * [1] => rate
@ -709,7 +709,7 @@ class CurrencyRate extends CommonObjectLine
public $rate; public $rate;
/** /**
* @var date Date synchronisation * @var integer Date synchronisation
*/ */
public $date_sync; public $date_sync;

View File

@ -4289,19 +4289,19 @@ class Product extends CommonObject
/** /**
* Adjust stock in a warehouse for product with batch number * Adjust stock in a warehouse for product with batch number
* *
* @param User $user user asking change * @param User $user user asking change
* @param int $id_entrepot id of warehouse * @param int $id_entrepot id of warehouse
* @param double $nbpiece nb of units * @param double $nbpiece nb of units
* @param int $movement 0 = add, 1 = remove * @param int $movement 0 = add, 1 = remove
* @param string $label Label of stock movement * @param string $label Label of stock movement
* @param double $price Price to use for stock eval * @param double $price Price to use for stock eval
* @param date $dlc eat-by date * @param integer $dlc eat-by date
* @param date $dluo sell-by date * @param integer $dluo sell-by date
* @param string $lot Lot number * @param string $lot Lot number
* @param string $inventorycode Inventory code * @param string $inventorycode Inventory code
* @param string $origin_element Origin element type * @param string $origin_element Origin element type
* @param int $origin_id Origin id of element * @param int $origin_id Origin id of element
* @return int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
*/ */
public function correct_stock_batch($user, $id_entrepot, $nbpiece, $movement, $label = '', $price = 0, $dlc = '', $dluo = '', $lot = '', $inventorycode = '', $origin_element = '', $origin_id = null) public function correct_stock_batch($user, $id_entrepot, $nbpiece, $movement, $label = '', $price = 0, $dlc = '', $dluo = '', $lot = '', $inventorycode = '', $origin_element = '', $origin_id = null)
{ {

View File

@ -416,14 +416,15 @@ class Productbatch extends CommonObject
* Find first detail record that match eather eat-by or sell-by or batch within given warehouse * Find first detail record that match eather eat-by or sell-by or batch within given warehouse
* *
* @param int $fk_product_stock id product_stock for objet * @param int $fk_product_stock id product_stock for objet
* @param date $eatby eat-by date for object - deprecated: a search must be done on batch number * @param integer $eatby eat-by date for object - deprecated: a search must be done on batch number
* @param date $sellby sell-by date for object - deprecated: a search must be done on batch number * @param integer $sellby sell-by date for object - deprecated: a search must be done on batch number
* @param string $batch_number batch number for object * @param string $batch_number batch number for object
* @return int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
*/ */
public function find($fk_product_stock = 0, $eatby = '', $sellby = '', $batch_number = '') public function find($fk_product_stock = 0, $eatby = '', $sellby = '', $batch_number = '')
{ {
global $langs; global $langs;
$where = array(); $where = array();
$sql = "SELECT"; $sql = "SELECT";
$sql.= " t.rowid,"; $sql.= " t.rowid,";

View File

@ -3,8 +3,8 @@
require '../../../main.inc.php'; require '../../../main.inc.php';
require_once DOL_DOCUMENT_ROOT.'/product/inventory/class/inventory.class.php'; require_once DOL_DOCUMENT_ROOT.'/product/inventory/class/inventory.class.php';
$get = GETPOST('get'); $get = GETPOST('get', 'alpha');
$put = GETPOST('put'); $put = GETPOST('put', 'alpha');
switch ($put) switch ($put)
{ {
@ -13,7 +13,7 @@ $put = GETPOST('put');
$fk_det_inventory = GETPOST('fk_det_inventory'); $fk_det_inventory = GETPOST('fk_det_inventory');
$det = new Inventorydet($db); $det = new InventoryLine($db);
if( $det->fetch($fk_det_inventory)) if( $det->fetch($fk_det_inventory))
{ {
$det->qty_view+=GETPOST('qty'); $det->qty_view+=GETPOST('qty');
@ -33,7 +33,7 @@ $put = GETPOST('put');
$fk_det_inventory = GETPOST('fk_det_inventory'); $fk_det_inventory = GETPOST('fk_det_inventory');
$det = new Inventorydet($db); $det = new InventoryLine($db);
if( $det->fetch($fk_det_inventory)) if( $det->fetch($fk_det_inventory))
{ {
$det->new_pmp=price2num(GETPOST('pmp')); $det->new_pmp=price2num(GETPOST('pmp'));

View File

@ -156,27 +156,27 @@ class Inventory extends CommonObject
/** /**
* @var int Name of subtable line * @var int Name of subtable line
*/ */
//public $table_element_line = 'inventorydet'; public $table_element_line = 'inventorydet';
/** /**
* @var int Field with ID of parent key if this field has a parent * @var int Field with ID of parent key if this field has a parent
*/ */
//public $fk_element = 'fk_inventory'; public $fk_element = 'fk_inventory';
/** /**
* @var int Name of subtable class that manage subtable lines * @var int Name of subtable class that manage subtable lines
*/ */
//public $class_element_line = 'Inventoryline'; public $class_element_line = 'Inventoryline';
/** /**
* @var array Array of child tables (child tables to delete before deleting a record) * @var array Array of child tables (child tables to delete before deleting a record)
*/ */
//protected $childtables=array('inventorydet'); protected $childtables=array('inventorydet');
/** /**
* @var InventoryLine[] Array of subtable lines * @var InventoryLine[] Array of subtable lines
*/ */
//public $lines = array(); public $lines = array();
@ -499,9 +499,9 @@ class Inventory extends CommonObject
} }
/** /**
* Class InventoryObjectLine * Class InventoryLine
*/ */
class InventoryObjectLine class InventoryLine
{ {
/** /**
* @var int ID * @var int ID

View File

@ -104,8 +104,8 @@ class MouvementStock extends CommonObject
* @param string $label Label of stock movement * @param string $label Label of stock movement
* @param string $inventorycode Inventory code * @param string $inventorycode Inventory code
* @param string $datem Force date of movement * @param string $datem Force date of movement
* @param date $eatby eat-by date. Will be used if lot does not exists yet and will be created. * @param integer $eatby eat-by date. Will be used if lot does not exists yet and will be created.
* @param date $sellby sell-by date. Will be used if lot does not exists yet and will be created. * @param integer $sellby sell-by date. Will be used if lot does not exists yet and will be created.
* @param string $batch batch number * @param string $batch batch number
* @param boolean $skip_batch If set to true, stock movement is done without impacting batch record * @param boolean $skip_batch If set to true, stock movement is done without impacting batch record
* @param int $id_product_batch Id product_batch (when skip_batch is false and we already know which record of product_batch to use) * @param int $id_product_batch Id product_batch (when skip_batch is false and we already know which record of product_batch to use)
@ -707,8 +707,8 @@ class MouvementStock extends CommonObject
* @param int $price Price * @param int $price Price
* @param string $label Label of stock movement * @param string $label Label of stock movement
* @param string $datem Force date of movement * @param string $datem Force date of movement
* @param date $eatby eat-by date * @param integer $eatby eat-by date
* @param date $sellby sell-by date * @param integer $sellby sell-by date
* @param string $batch batch number * @param string $batch batch number
* @param int $id_product_batch Id product_batch * @param int $id_product_batch Id product_batch
* @param string $inventorycode Inventory code * @param string $inventorycode Inventory code
@ -732,8 +732,8 @@ class MouvementStock extends CommonObject
* @param int $qty Quantity * @param int $qty Quantity
* @param int $price Price * @param int $price Price
* @param string $label Label of stock movement * @param string $label Label of stock movement
* @param date $eatby eat-by date * @param integer $eatby eat-by date
* @param date $sellby sell-by date * @param integer $sellby sell-by date
* @param string $batch batch number * @param string $batch batch number
* @param string $datem Force date of movement * @param string $datem Force date of movement
* @param int $id_product_batch Id product_batch * @param int $id_product_batch Id product_batch
@ -776,7 +776,7 @@ class MouvementStock extends CommonObject
* Count number of product in stock before a specific date * Count number of product in stock before a specific date
* *
* @param int $productidselected Id of product to count * @param int $productidselected Id of product to count
* @param timestamp $datebefore Date limit * @param integer $datebefore Date limit
* @return int Number * @return int Number
*/ */
public function calculateBalanceForProductBefore($productidselected, $datebefore) public function calculateBalanceForProductBefore($productidselected, $datebefore)

View File

@ -53,11 +53,6 @@ class Productlot extends CommonObject
*/ */
public $ismultientitymanaged = 1; public $ismultientitymanaged = 1;
/**
* @var ProductlotLine[] Lines
*/
public $lines = array();
/** /**
* @var int Entity * @var int Entity
*/ */

View File

@ -707,8 +707,8 @@ class Reception extends CommonObject
* @param int $qty Quantity * @param int $qty Quantity
* @param array $array_options extrafields array * @param array $array_options extrafields array
* @param string $comment Comment for stock movement * @param string $comment Comment for stock movement
* @param date $eatby eat-by date * @param integer $eatby eat-by date
* @param date $sellby sell-by date * @param integer $sellby sell-by date
* @param string $batch Lot number * @param string $batch Lot number
* @return int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
*/ */
@ -1256,7 +1256,7 @@ class Reception extends CommonObject
* Set the planned delivery date * Set the planned delivery date
* *
* @param User $user Objet utilisateur qui modifie * @param User $user Objet utilisateur qui modifie
* @param timestamp $date_livraison Date de livraison * @param integer $date_livraison Date de livraison
* @return int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
*/ */
public function set_date_livraison($user, $date_livraison) public function set_date_livraison($user, $date_livraison)

View File

@ -58,7 +58,7 @@ abstract class ActionsCardCommon
* Get object from id or ref and save it into this->object * Get object from id or ref and save it into this->object
* *
* @param int $id Object id * @param int $id Object id
* @param ref $ref Object ref * @param string $ref Object ref
* @return object Object loaded * @return object Object loaded
*/ */
protected function getObject($id, $ref = '') protected function getObject($id, $ref = '')

View File

@ -1582,9 +1582,9 @@ $reshook = $hookmanager->executeHooks('replaceThirdparty', array(
* @param int $id ID of thirdparty * @param int $id ID of thirdparty
* *
* @return void * @return void
* @throws 401 Unauthorized: User does not have permission to delete thirdparties gateways * @throws RestException(401) Unauthorized: User does not have permission to delete thirdparties gateways
* @throws 404 Not Found: Specified thirdparty ID does not belongs to an existing thirdparty * @throws RestException(404) Not Found: Specified thirdparty ID does not belongs to an existing thirdparty
* @throws 500 Internal Server Error: Error deleting SocieteAccount entity * @throws RestException(500) Internal Server Error: Error deleting SocieteAccount entity
* *
* @url DELETE {id}/gateways * @url DELETE {id}/gateways
*/ */

View File

@ -89,7 +89,7 @@ class SupplierProposal extends CommonObject
/** /**
* @deprecated * @deprecated
* @see user_author_id * @see $user_author_id
*/ */
public $author; public $author;
@ -101,7 +101,7 @@ class SupplierProposal extends CommonObject
/** /**
* @deprecated * @deprecated
* @see date_creation * @see $date_creation
*/ */
public $datec; public $datec;
@ -113,7 +113,7 @@ class SupplierProposal extends CommonObject
/** /**
* @deprecated * @deprecated
* @see date_validation * @see $date_validation
*/ */
public $datev; public $datev;
@ -130,19 +130,19 @@ class SupplierProposal extends CommonObject
/** /**
* @deprecated * @deprecated
* @see price_ht * @see $price_ht
*/ */
public $price; public $price;
/** /**
* @deprecated * @deprecated
* @see total_tva * @see $total_tva
*/ */
public $tva; public $tva;
/** /**
* @deprecated * @deprecated
* @see total_ttc * @see $total_ttc
*/ */
public $total; public $total;
@ -393,7 +393,7 @@ class SupplierProposal extends CommonObject
* @param double $pu_ht_devise Amount in currency * @param double $pu_ht_devise Amount in currency
* @return int >0 if OK, <0 if KO * @return int >0 if OK, <0 if KO
* *
* @see add_product * @see add_product()
*/ */
public function addline($desc, $pu_ht, $qty, $txtva, $txlocaltax1 = 0, $txlocaltax2 = 0, $fk_product = 0, $remise_percent = 0, $price_base_type = 'HT', $pu_ttc = 0, $info_bits = 0, $type = 0, $rang = -1, $special_code = 0, $fk_parent_line = 0, $fk_fournprice = 0, $pa_ht = 0, $label = '', $array_option = 0, $ref_supplier = '', $fk_unit = '', $origin = '', $origin_id = 0, $pu_ht_devise = 0) public function addline($desc, $pu_ht, $qty, $txtva, $txlocaltax1 = 0, $txlocaltax2 = 0, $fk_product = 0, $remise_percent = 0, $price_base_type = 'HT', $pu_ttc = 0, $info_bits = 0, $type = 0, $rang = -1, $special_code = 0, $fk_parent_line = 0, $fk_fournprice = 0, $pa_ht = 0, $label = '', $array_option = 0, $ref_supplier = '', $fk_unit = '', $origin = '', $origin_id = 0, $pu_ht_devise = 0)
{ {
@ -1104,7 +1104,7 @@ class SupplierProposal extends CommonObject
* *
* @param User $user User that create * @param User $user User that create
* @return int Id of the new object if ok, <0 if ko * @return int Id of the new object if ok, <0 if ko
* @see create * @see create()
*/ */
public function create_from($user) public function create_from($user)
{ {
@ -2760,7 +2760,7 @@ class SupplierProposalLine extends CommonObjectLine
/** /**
* @deprecated * @deprecated
* @see product_type * @see $product_type
*/ */
public $fk_product_type; public $fk_product_type;
/** /**
@ -2831,7 +2831,7 @@ class SupplierProposalLine extends CommonObjectLine
/** /**
* @deprecated * @deprecated
* @see product_label * @see $product_label
*/ */
public $libelle; public $libelle;

View File

@ -125,12 +125,12 @@ class User extends CommonObject
//! If this is defined, it is an external user //! If this is defined, it is an external user
/** /**
* @deprecated * @deprecated
* @see socid * @see $socid
*/ */
public $societe_id; public $societe_id;
/** /**
* @deprecated * @deprecated
* @see contactid * @see $contactid
*/ */
public $contact_id; public $contact_id;
public $socid; public $socid;
@ -643,7 +643,7 @@ class User extends CommonObject
* @param int $entity Entity to use * @param int $entity Entity to use
* @param int $notrigger 1=Does not execute triggers, 0=Execute triggers * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers
* @return int > 0 if OK, < 0 if OK * @return int > 0 if OK, < 0 if OK
* @see clearrights, addrights, getrights * @see clearrights(), addrights(), getrights()
*/ */
public function delrights($rid, $allmodule = '', $allperms = '', $entity = 0, $notrigger = 0) public function delrights($rid, $allmodule = '', $allperms = '', $entity = 0, $notrigger = 0)
{ {
@ -2799,8 +2799,7 @@ class User extends CommonObject
/** /**
* Update user using data from the LDAP * Update user using data from the LDAP
* *
* @param ldapuser $ldapuser Ladp User * @param Object $ldapuser Ladp User
*
* @return int <0 if KO, >0 if OK * @return int <0 if KO, >0 if OK
*/ */
public function update_ldap2dolibarr(&$ldapuser) public function update_ldap2dolibarr(&$ldapuser)
@ -2841,7 +2840,7 @@ class User extends CommonObject
* Return and array with all instanciated first level children users of current user * Return and array with all instanciated first level children users of current user
* *
* @return void * @return void
* @see getAllChildIds * @see getAllChildIds()
*/ */
public function get_children() public function get_children()
{ {

View File

@ -61,7 +61,7 @@ class UserGroup extends CommonObject
/** /**
* @var string * @var string
* @deprecated * @deprecated
* @see name * @see $name
*/ */
public $nom; public $nom;