diff --git a/htdocs/accountancy/class/accountancycategory.class.php b/htdocs/accountancy/class/accountancycategory.class.php index 40354b297b2..6babd94e7bc 100644 --- a/htdocs/accountancy/class/accountancycategory.class.php +++ b/htdocs/accountancy/class/accountancycategory.class.php @@ -626,7 +626,7 @@ class AccountancyCategory // extends CommonObject * @param string $thirdparty_code Thirdparty code * @param int $month Specifig month - Can be empty * @param int $year Specifig year - Can be empty - * @return integer <0 if KO, >= 0 if OK + * @return integer Return integer <0 if KO, >= 0 if OK */ public function getSumDebitCredit($cpt, $date_start, $date_end, $sens, $thirdparty_code = 'nofilter', $month = 0, $year = 0) { diff --git a/htdocs/accountancy/class/accountancyexport.class.php b/htdocs/accountancy/class/accountancyexport.class.php index 1b08cc85ed6..737573ef21e 100644 --- a/htdocs/accountancy/class/accountancyexport.class.php +++ b/htdocs/accountancy/class/accountancyexport.class.php @@ -325,7 +325,7 @@ class AccountancyExport * @param int $outputMode [=0] Print on screen * or 1 to write in file and uses a temp directory - Forced by default when use withAttachment = 1 * or 2 to write in file a default export directory (accounting/export/) - * @return int <0 if KO, >0 OK + * @return int Return integer <0 if KO, >0 OK */ public function export(&$TData, $formatexportset, $withAttachment = 0, $downloadMode = 0, $outputMode = 0) { diff --git a/htdocs/accountancy/class/accountancysystem.class.php b/htdocs/accountancy/class/accountancysystem.class.php index ddfa39c6309..0858179253f 100644 --- a/htdocs/accountancy/class/accountancysystem.class.php +++ b/htdocs/accountancy/class/accountancysystem.class.php @@ -117,7 +117,7 @@ class AccountancySystem * * @param int $rowid Id * @param string $ref ref - * @return int <0 if KO, Id of record if OK and found + * @return int Return integer <0 if KO, Id of record if OK and found */ public function fetch($rowid = 0, $ref = '') { diff --git a/htdocs/accountancy/class/accountingaccount.class.php b/htdocs/accountancy/class/accountingaccount.class.php index fd6ca803e11..637e2bc8f68 100644 --- a/htdocs/accountancy/class/accountingaccount.class.php +++ b/htdocs/accountancy/class/accountingaccount.class.php @@ -179,7 +179,7 @@ class AccountingAccount extends CommonObject * @param string $account_number Account number * @param int|boolean $limittocurrentchart 1 or true=Load record only if it is into current active chart of account * @param string $limittoachartaccount 'ABC'=Load record only if it is into chart account with code 'ABC' (better and faster than previous parameter if you have chart of account code). - * @return int <0 if KO, 0 if not found, Id of record if OK and found + * @return int Return integer <0 if KO, 0 if not found, Id of record if OK and found */ public function fetch($rowid = null, $account_number = null, $limittocurrentchart = 0, $limittoachartaccount = '') { @@ -350,7 +350,7 @@ class AccountingAccount extends CommonObject * Update record * * @param User $user User making update - * @return int <0 if KO (-2 = duplicate), >0 if OK + * @return int Return integer <0 if KO (-2 = duplicate), >0 if OK */ public function update($user) { diff --git a/htdocs/accountancy/class/accountingjournal.class.php b/htdocs/accountancy/class/accountingjournal.class.php index 797b9e909f7..8456732a2a1 100644 --- a/htdocs/accountancy/class/accountingjournal.class.php +++ b/htdocs/accountancy/class/accountingjournal.class.php @@ -114,7 +114,7 @@ class AccountingJournal extends CommonObject * * @param int $rowid Id of record to load * @param string $journal_code Journal code - * @return int <0 if KO, Id of record if OK and found + * @return int Return integer <0 if KO, Id of record if OK and found */ public function fetch($rowid = null, $journal_code = null) { diff --git a/htdocs/accountancy/class/bookkeeping.class.php b/htdocs/accountancy/class/bookkeeping.class.php index b9bd1b75780..8759890a020 100644 --- a/htdocs/accountancy/class/bookkeeping.class.php +++ b/htdocs/accountancy/class/bookkeeping.class.php @@ -869,7 +869,7 @@ class BookKeeping extends CommonObject * @param string $filtermode filter mode (AND or OR) * @param int $option option (0: general account or 1: subaccount) * @param int $countonly Do not fill the $object->lines, return only the count. - * @return int <0 if KO, Number of lines if OK + * @return int Return integer <0 if KO, Number of lines if OK */ public function fetchAllByAccount($sortorder = '', $sortfield = '', $limit = 0, $offset = 0, array $filter = array(), $filtermode = 'AND', $option = 0, $countonly = 0) { @@ -2303,7 +2303,7 @@ class BookKeeping extends CommonObject * Is the bookkeeping can be modified or deleted ? * * @param int $id Bookkeeping ID - * @return int <0 if KO, == 0 if No, == 1 if Yes + * @return int Return integer <0 if KO, == 0 if No, == 1 if Yes */ public function canModifyBookkeeping($id) { @@ -2359,7 +2359,7 @@ class BookKeeping extends CommonObject * Is the bookkeeping date valid (on an open period or not on a closed period) ? * * @param int $date Bookkeeping date - * @return int <0 if KO, == 0 if No, == 1 if date is valid for a transfer + * @return int Return integer <0 if KO, == 0 if No, == 1 if date is valid for a transfer */ public function validBookkeepingDate($date) { @@ -2464,7 +2464,7 @@ class BookKeeping extends CommonObject * Get list of fiscal period * * @param string $filter Filter - * @return array|int <0 if KO, Fiscal periods : [[id, date_start, date_end, label], ...] + * @return array|int Return integer <0 if KO, Fiscal periods : [[id, date_start, date_end, label], ...] */ public function getFiscalPeriods($filter = '') { @@ -2503,7 +2503,7 @@ class BookKeeping extends CommonObject * * @param int $date_start Date start * @param int $date_end Date end - * @return array|int <0 if KO, Fiscal periods : [[id, date_start, date_end, label], ...] + * @return array|int Return integer <0 if KO, Fiscal periods : [[id, date_start, date_end, label], ...] */ public function getCountByMonthForFiscalPeriod($date_start, $date_end) { diff --git a/htdocs/accountancy/class/lettering.class.php b/htdocs/accountancy/class/lettering.class.php index e31b6e803e7..38a5e7c3c72 100644 --- a/htdocs/accountancy/class/lettering.class.php +++ b/htdocs/accountancy/class/lettering.class.php @@ -400,7 +400,7 @@ class Lettering extends BookKeeping * * @param array $bookkeeping_ids Lettering specific list of bookkeeping id * @param bool $unlettering Do unlettering - * @return int <0 if error (nb lettered = result -1), 0 if noting to lettering, >0 if OK (nb lettered) + * @return int Return integer <0 if error (nb lettered = result -1), 0 if noting to lettering, >0 if OK (nb lettered) */ public function bookkeepingLetteringAll($bookkeeping_ids, $unlettering = false) { @@ -432,7 +432,7 @@ class Lettering extends BookKeeping * * @param array $bookkeeping_ids Lettering specific list of bookkeeping id * @param bool $unlettering Do unlettering - * @return int <0 if error (nb lettered = result -1), 0 if noting to lettering, >0 if OK (nb lettered) + * @return int Return integer <0 if error (nb lettered = result -1), 0 if noting to lettering, >0 if OK (nb lettered) */ public function bookkeepingLettering($bookkeeping_ids, $unlettering = false) { @@ -518,7 +518,7 @@ class Lettering extends BookKeeping * * @param array $bookkeeping_ids Lettering specific list of bookkeeping id * @param bool $only_has_subledger_account Get only lines who have subledger account - * @return array|int <0 if error otherwise all linked lines by block + * @return array|int Return integer <0 if error otherwise all linked lines by block */ public function getLinkedLines($bookkeeping_ids, $only_has_subledger_account = true) { @@ -655,7 +655,7 @@ class Lettering extends BookKeeping * Get all fk_doc by doc_type from list of bank ids * * @param array $bank_ids List of bank ids - * @return array|int <0 if error otherwise all fk_doc by doc_type + * @return array|int Return integer <0 if error otherwise all fk_doc by doc_type */ public function getDocTypeAndFkDocFromBankLines($bank_ids) { @@ -698,7 +698,7 @@ class Lettering extends BookKeeping * * @param array $document_ids List of document id * @param string $doc_type Type of document ('customer_invoice' or 'supplier_invoice', ...) - * @return array|int <0 if error otherwise all all bank ids from list of document ids of a type + * @return array|int Return integer <0 if error otherwise all all bank ids from list of document ids of a type */ public function getBankLinesFromFkDocAndDocType($document_ids, $doc_type) { @@ -752,7 +752,7 @@ class Lettering extends BookKeeping * * @param array $document_ids List of document id * @param string $doc_type Type of document ('customer_invoice' or 'supplier_invoice', ...) - * @return array|int <0 if error otherwise all linked document ids by group and type [ [ 'doc_type' => [ doc_id, ... ], ... ], ... ] + * @return array|int Return integer <0 if error otherwise all linked document ids by group and type [ [ 'doc_type' => [ doc_id, ... ], ... ], ... ] */ public function getLinkedDocumentByGroup($document_ids, $doc_type) { diff --git a/htdocs/adherents/class/adherent.class.php b/htdocs/adherents/class/adherent.class.php index 6a86ba3018d..294e0c4689d 100644 --- a/htdocs/adherents/class/adherent.class.php +++ b/htdocs/adherents/class/adherent.class.php @@ -1026,7 +1026,7 @@ class Adherent extends CommonObject * @param int $rowid Id of member to delete * @param User $user User object * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <0 if KO, 0=nothing to do, >0 if OK + * @return int Return integer <0 if KO, 0=nothing to do, >0 if OK */ public function delete($rowid, $user, $notrigger = 0) { @@ -1939,7 +1939,7 @@ class Adherent extends CommonObject * Function that validate a member * * @param User $user user adherent qui valide - * @return int <0 if KO, 0 if nothing done, >0 if OK + * @return int Return integer <0 if KO, 0 if nothing done, >0 if OK */ public function validate($user) { @@ -2503,7 +2503,7 @@ class Adherent extends CommonObject * * @param User $user Objet user * @param string $mode "expired" for membership to renew, "shift" for member to validate - * @return WorkboardResponse|int <0 if KO, WorkboardResponse if OK + * @return WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK */ public function load_board($user, $mode) { diff --git a/htdocs/adherents/class/subscription.class.php b/htdocs/adherents/class/subscription.class.php index 6753f8a8714..08f8ea83399 100644 --- a/htdocs/adherents/class/subscription.class.php +++ b/htdocs/adherents/class/subscription.class.php @@ -135,7 +135,7 @@ class Subscription extends CommonObject * * @param User $user User that create * @param bool $notrigger false=launch triggers after, true=disable triggers - * @return int <0 if KO, Id subscription created if OK + * @return int Return integer <0 if KO, Id subscription created if OK */ public function create($user, $notrigger = false) { @@ -209,7 +209,7 @@ class Subscription extends CommonObject * Method to load a subscription * * @param int $rowid Id subscription - * @return int <0 if KO, =0 if not found, >0 if OK + * @return int Return integer <0 if KO, =0 if not found, >0 if OK */ public function fetch($rowid) { diff --git a/htdocs/asset/class/asset.class.php b/htdocs/asset/class/asset.class.php index 01184bf45b0..c777ca13a3d 100644 --- a/htdocs/asset/class/asset.class.php +++ b/htdocs/asset/class/asset.class.php @@ -700,7 +700,7 @@ class Asset extends CommonObject /** * If has depreciation lines in bookkeeping * - * @return int <0 if KO, 0 if NO, 1 if Yes + * @return int Return integer <0 if KO, 0 if NO, 1 if Yes */ public function hasDepreciationLinesInBookkeeping() { @@ -763,7 +763,7 @@ class Asset extends CommonObject * @param double $cumulative_depreciation_ht Depreciation cumulative amount HT * @param string $accountancy_code_debit Accountancy code Debit * @param string $accountancy_code_credit Accountancy code Credit - * @return int <0 if KO, Id of created line if OK + * @return int Return integer <0 if KO, Id of created line if OK */ public function addDepreciationLine($mode, $ref, $depreciation_date, $depreciation_ht, $cumulative_depreciation_ht, $accountancy_code_debit, $accountancy_code_credit) { @@ -1171,7 +1171,7 @@ class Asset extends CommonObject * @param User $user Object user that dispose * @param int $disposal_invoice_id Disposal invoice ID * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function dispose($user, $disposal_invoice_id, $notrigger = 0) { @@ -1239,7 +1239,7 @@ class Asset extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { diff --git a/htdocs/asset/class/assetdepreciationoptions.class.php b/htdocs/asset/class/assetdepreciationoptions.class.php index 64f088a3b04..2c572d89a8f 100644 --- a/htdocs/asset/class/assetdepreciationoptions.class.php +++ b/htdocs/asset/class/assetdepreciationoptions.class.php @@ -377,7 +377,7 @@ class AssetDepreciationOptions extends CommonObject * get general depreciation info for a mode (used in depreciation card) * * @param string $mode Depreciation mode (economic, accelerated_depreciation, ...) - * @return array|int <0 if KO otherwise array with general depreciation info + * @return array|int Return integer <0 if KO otherwise array with general depreciation info */ public function getGeneralDepreciationInfoForMode($mode) { diff --git a/htdocs/asset/class/assetmodel.class.php b/htdocs/asset/class/assetmodel.class.php index 26068c00b59..b8eead48384 100644 --- a/htdocs/asset/class/assetmodel.class.php +++ b/htdocs/asset/class/assetmodel.class.php @@ -436,7 +436,7 @@ class AssetModel extends CommonObject * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function validate($user, $notrigger = 0) { @@ -519,7 +519,7 @@ class AssetModel extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancel($user, $notrigger = 0) { @@ -536,7 +536,7 @@ class AssetModel extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { diff --git a/htdocs/bom/class/bom.class.php b/htdocs/bom/class/bom.class.php index cf7f98c4884..0dccb4b74e0 100644 --- a/htdocs/bom/class/bom.class.php +++ b/htdocs/bom/class/bom.class.php @@ -708,7 +708,7 @@ class BOM extends CommonObject * @param int $fk_unit Unit of line * @param array $array_options extrafields array * @param int $fk_default_workstation Default workstation - * @return int <0 if KO, Id of updated BOM-Line if OK + * @return int Return integer <0 if KO, Id of updated BOM-Line if OK */ public function updateLine($rowid, $qty, $qty_frozen = 0, $disable_stock_change = 0, $efficiency = 1.0, $position = -1, $import_key = null, $fk_unit = 0, $array_options = 0, $fk_default_workstation = null) { @@ -915,7 +915,7 @@ class BOM extends CommonObject * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function validate($user, $notrigger = 0) { @@ -1066,7 +1066,7 @@ class BOM extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancel($user, $notrigger = 0) { @@ -1090,7 +1090,7 @@ class BOM extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { diff --git a/htdocs/bookcal/class/availabilities.class.php b/htdocs/bookcal/class/availabilities.class.php index b98ef83c639..e94eb3f0990 100644 --- a/htdocs/bookcal/class/availabilities.class.php +++ b/htdocs/bookcal/class/availabilities.class.php @@ -509,7 +509,7 @@ class Availabilities extends CommonObject * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function validate($user, $notrigger = 0) { @@ -666,7 +666,7 @@ class Availabilities extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancel($user, $notrigger = 0) { @@ -690,7 +690,7 @@ class Availabilities extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { diff --git a/htdocs/bookcal/class/calendar.class.php b/htdocs/bookcal/class/calendar.class.php index 5d97dbb825f..2b1cf06d779 100644 --- a/htdocs/bookcal/class/calendar.class.php +++ b/htdocs/bookcal/class/calendar.class.php @@ -466,7 +466,7 @@ class Calendar extends CommonObject * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function validate($user, $notrigger = 0) { @@ -623,7 +623,7 @@ class Calendar extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancel($user, $notrigger = 0) { @@ -647,7 +647,7 @@ class Calendar extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { diff --git a/htdocs/bookmarks/class/bookmark.class.php b/htdocs/bookmarks/class/bookmark.class.php index 06aa4105a9d..aa3f163fe23 100644 --- a/htdocs/bookmarks/class/bookmark.class.php +++ b/htdocs/bookmarks/class/bookmark.class.php @@ -148,7 +148,7 @@ class Bookmark extends CommonObject /** * Insert bookmark into database * - * @return int <0 si ko, rowid du bookmark cree si ok + * @return int Return integer <0 si ko, rowid du bookmark cree si ok */ public function create() { @@ -201,7 +201,7 @@ class Bookmark extends CommonObject /** * Update bookmark record * - * @return int <0 if KO, > if OK + * @return int Return integer <0 if KO, > if OK */ public function update() { diff --git a/htdocs/categories/class/categorie.class.php b/htdocs/categories/class/categorie.class.php index 0885d0369e9..7142574dac2 100644 --- a/htdocs/categories/class/categorie.class.php +++ b/htdocs/categories/class/categorie.class.php @@ -612,7 +612,7 @@ class Categorie extends CommonObject * * @param User $user Object user that ask to delete * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <0 KO >0 OK + * @return int Return integer <0 KO >0 OK */ public function delete($user, $notrigger = 0) { @@ -1055,7 +1055,7 @@ class Categorie extends CommonObject /** * Return direct childs id of a category into an array * - * @return array|int <0 KO, array ok + * @return array|int Return integer <0 KO, array ok */ public function get_filles() { @@ -1437,7 +1437,7 @@ class Categorie extends CommonObject /** * Returns an array containing the list of parent categories * - * @return int|array <0 KO, array OK + * @return int|array Return integer <0 KO, array OK */ public function get_meres() { diff --git a/htdocs/comm/action/class/actioncomm.class.php b/htdocs/comm/action/class/actioncomm.class.php index 59c3d12c689..8f13709a1e0 100644 --- a/htdocs/comm/action/class/actioncomm.class.php +++ b/htdocs/comm/action/class/actioncomm.class.php @@ -1408,7 +1408,7 @@ class ActionComm extends CommonObject * * @param User $user Objet user * @param int $load_state_board Load indicator array this->nb - * @return WorkboardResponse|int <0 if KO, WorkboardResponse if OK + * @return WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK */ public function load_board($user, $load_state_board = 0) { diff --git a/htdocs/comm/action/index.php b/htdocs/comm/action/index.php index 76e33a7af1f..9a5d6305301 100644 --- a/htdocs/comm/action/index.php +++ b/htdocs/comm/action/index.php @@ -2278,7 +2278,7 @@ function dol_color_minus($color, $minus, $minusunit = 16) * * @param object $a Event A * @param object $b Event B - * @return int < 0 if event A should be before event B, > 0 otherwise, 0 if they have the exact same time slot + * @return int Return integer < 0 if event A should be before event B, > 0 otherwise, 0 if they have the exact same time slot */ function sort_events_by_date($a, $b) { @@ -2317,7 +2317,7 @@ function sort_events_by_date($a, $b) * * @param object $a Event A * @param object $b Event B - * @return int < 0 if event A should be before event B, > 0 otherwise, 0 if they have the exact same percentage + * @return int Return integer < 0 if event A should be before event B, > 0 otherwise, 0 if they have the exact same percentage */ function sort_events_by_percentage($a, $b) { diff --git a/htdocs/comm/mailing/class/mailing.class.php b/htdocs/comm/mailing/class/mailing.class.php index 3eb58a0a182..ca218ba9173 100644 --- a/htdocs/comm/mailing/class/mailing.class.php +++ b/htdocs/comm/mailing/class/mailing.class.php @@ -308,7 +308,7 @@ class Mailing extends CommonObject * * @param User $user Object of user making change * @param int $notrigger Disable triggers - * @return int < 0 if KO, > 0 if OK + * @return int Return integer < 0 if KO, > 0 if OK */ public function update($user, $notrigger = 0) { diff --git a/htdocs/comm/propal/class/propal.class.php b/htdocs/comm/propal/class/propal.class.php index e1334aad4e2..7ff7de223bf 100644 --- a/htdocs/comm/propal/class/propal.class.php +++ b/htdocs/comm/propal/class/propal.class.php @@ -1058,7 +1058,7 @@ class Propal extends CommonObject * * @param User $user User that create * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function create($user, $notrigger = 0) { @@ -1970,7 +1970,7 @@ class Propal extends CommonObject * * @param User $user Object user that validate * @param int $notrigger 1=Does not execute triggers, 0=execute triggers - * @return int <0 if KO, 0=Nothing done, >=0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >=0 if OK */ public function valid($user, $notrigger = 0) { @@ -2220,7 +2220,7 @@ class Propal extends CommonObject * @param User $user Object user that modify * @param int $delivery_date Delivery date * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok * @deprecated Use setDeliveryDate */ public function set_date_livraison($user, $delivery_date, $notrigger = 0) @@ -2235,7 +2235,7 @@ class Propal extends CommonObject * @param User $user Object user that modify * @param int $delivery_date Delivery date * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok */ public function setDeliveryDate($user, $delivery_date, $notrigger = 0) { @@ -2420,7 +2420,7 @@ class Propal extends CommonObject * @param User $user Object user that modify * @param string $ref_client Customer reference * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok */ public function set_ref_client($user, $ref_client, $notrigger = 0) { @@ -2477,7 +2477,7 @@ class Propal extends CommonObject * @param User $user Object user that modify * @param double $remise Amount discount * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok * @deprecated remise_percent is a deprecated field for object parent */ /* @@ -2542,7 +2542,7 @@ class Propal extends CommonObject * @param User $user Object user that modify * @param double $remise Amount discount * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok */ /* public function set_remise_absolue($user, $remise, $notrigger = 0) @@ -2780,7 +2780,7 @@ class Propal extends CommonObject * @param User $user Object user * @param int $notrigger 1=Does not execute triggers, 0= execute triggers * @param string $note Complete private note with this note - * @return int <0 if KO, 0 = nothing done, >0 if OK + * @return int Return integer <0 if KO, 0 = nothing done, >0 if OK */ public function classifyBilled(User $user, $notrigger = 0, $note = '') { @@ -3447,7 +3447,7 @@ class Propal extends CommonObject * * @param User $user Object user * @param string $mode "opened" for proposal to close, "signed" for proposal to invoice - * @return WorkboardResponse|int <0 if KO, WorkboardResponse if OK + * @return WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK */ public function load_board($user, $mode) { @@ -3622,7 +3622,7 @@ class Propal extends CommonObject /** * Charge indicateurs this->nb de tableau de bord * - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok */ public function load_state_board() { @@ -4442,7 +4442,7 @@ class PropaleLigne extends CommonObjectLine * * @param User $user Object user * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok */ public function delete(User $user, $notrigger = 0) { @@ -4492,7 +4492,7 @@ class PropaleLigne extends CommonObjectLine * Update propal line object into DB * * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok */ public function update($notrigger = 0) { diff --git a/htdocs/commande/class/commande.class.php b/htdocs/commande/class/commande.class.php index be6de480d53..99024dca83f 100644 --- a/htdocs/commande/class/commande.class.php +++ b/htdocs/commande/class/commande.class.php @@ -463,7 +463,7 @@ class Commande extends CommonOrder * @param User $user User making status change * @param int $idwarehouse Id of warehouse to use for stock decrease * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function valid($user, $idwarehouse = 0, $notrigger = 0) { @@ -713,7 +713,7 @@ class Commande extends CommonOrder * Function used when order is reopend after being closed. * * @param User $user Object user that change status - * @return int <0 if KO, 0 if nothing is done, >0 if OK + * @return int Return integer <0 if KO, 0 if nothing is done, >0 if OK */ public function set_reopen($user) { @@ -1313,7 +1313,7 @@ class Commande extends CommonOrder * * @param Object $object Object source * @param User $user User making creation - * @return int <0 if KO, 0 if nothing done, 1 if OK + * @return int Return integer <0 if KO, 0 if nothing done, 1 if OK */ public function createFromProposal($object, User $user) { @@ -2205,7 +2205,7 @@ class Commande extends CommonOrder /** * Return number of line with type product. * - * @return int <0 if KO, Nbr of product lines if OK + * @return int Return integer <0 if KO, Nbr of product lines if OK */ public function getNbOfProductsLines() { @@ -2221,7 +2221,7 @@ class Commande extends CommonOrder /** * Return number of line with type service. * - * @return int <0 if KO, Nbr of service lines if OK + * @return int Return integer <0 if KO, Nbr of service lines if OK */ public function getNbOfServicesLines() { @@ -2237,7 +2237,7 @@ class Commande extends CommonOrder /** * Count number of shipments for this order * - * @return int <0 if KO, Nb of shipment found if OK + * @return int Return integer <0 if KO, Nb of shipment found if OK */ public function getNbOfShipments() { @@ -2273,7 +2273,7 @@ class Commande extends CommonOrder * * @param int $filtre_statut Filter on shipment status * @param int $fk_product Add a filter on a product - * @return int <0 if KO, Nb of lines found if OK + * @return int Return integer <0 if KO, Nb of lines found if OK */ public function loadExpeditions($filtre_statut = -1, $fk_product = 0) { @@ -2649,7 +2649,7 @@ class Commande extends CommonOrder * @param User $user Object user that modify * @param int $delivery_date Delivery date * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok * @deprecated Use setDeliveryDate */ public function set_date_livraison($user, $delivery_date, $notrigger = 0) @@ -2664,7 +2664,7 @@ class Commande extends CommonOrder * @param User $user Objet utilisateur qui modifie * @param int $delivery_date Delivery date * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <0 si ko, >0 si ok + * @return int Return integer <0 si ko, >0 si ok */ public function setDeliveryDate($user, $delivery_date, $notrigger = 0) { @@ -2977,7 +2977,7 @@ class Commande extends CommonOrder * * @param User $user Object user making the change * @param int $notrigger 1=Does not execute triggers, 0=execute triggers - * @return int <0 if KO, 0 if already billed, >0 if OK + * @return int Return integer <0 if KO, 0 if already billed, >0 if OK */ public function classifyBilled(User $user, $notrigger = 0) { @@ -3031,7 +3031,7 @@ class Commande extends CommonOrder * * @param User $user Object user making the change * @param int $notrigger 1=Does not execute triggers, 0=execute triggers - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok */ public function classifyUnBilled(User $user, $notrigger = 0) { @@ -3107,7 +3107,7 @@ class Commande extends CommonOrder * @param int $notrigger disable line update trigger * @param string $ref_ext external reference * @param integer $rang line rank - * @return int < 0 if KO, > 0 if OK + * @return int Return integer < 0 if KO, > 0 if OK */ public function updateline($rowid, $desc, $pu, $qty, $remise_percent, $txtva, $txlocaltax1 = 0.0, $txlocaltax2 = 0.0, $price_base_type = 'HT', $info_bits = 0, $date_start = '', $date_end = '', $type = 0, $fk_parent_line = 0, $skip_update_total = 0, $fk_fournprice = null, $pa_ht = 0, $label = '', $special_code = 0, $array_options = 0, $fk_unit = null, $pu_ht_devise = 0, $notrigger = 0, $ref_ext = '', $rang = 0) { @@ -3430,7 +3430,7 @@ class Commande extends CommonOrder * * @param User $user User object * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if KO, >0 if OK + * @return int Return integer <=0 if KO, >0 if OK */ public function delete($user, $notrigger = 0) { @@ -3562,7 +3562,7 @@ class Commande extends CommonOrder * * @param User $user Object user * @param string $mode Mode ('toship', 'tobill', 'shippedtobill') - * @return WorkboardResponse|int <0 if KO, WorkboardResponse if OK + * @return WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK */ public function load_board($user, $mode) { @@ -4064,7 +4064,7 @@ class Commande extends CommonOrder /** * Charge indicateurs this->nb de tableau de bord * - * @return int <0 si ko, >0 si ok + * @return int Return integer <0 si ko, >0 si ok */ public function load_state_board() { @@ -4387,7 +4387,7 @@ class OrderLine extends CommonOrderLine * * @param User $user User that modify * @param int $notrigger 0=launch triggers after, 1=disable triggers - * @return int <0 si ko, >0 si ok + * @return int Return integer <0 si ko, >0 si ok */ public function delete(User $user, $notrigger = 0) { @@ -4638,7 +4638,7 @@ class OrderLine extends CommonOrderLine * * @param User $user User that modify * @param int $notrigger 1 = disable triggers - * @return int <0 si ko, >0 si ok + * @return int Return integer <0 si ko, >0 si ok */ public function update(User $user, $notrigger = 0) { diff --git a/htdocs/compta/bank/class/account.class.php b/htdocs/compta/bank/class/account.class.php index b56bdad7eb2..eb82d04a190 100644 --- a/htdocs/compta/bank/class/account.class.php +++ b/htdocs/compta/bank/class/account.class.php @@ -452,7 +452,7 @@ class Account extends CommonObject * @param string $url Url (deprecated, we use now 'url_id' and 'type' instead) * @param string $label Link label * @param string $type Type of link ('payment', 'company', 'member', ...) - * @return int <0 if KO, id line if OK + * @return int Return integer <0 if KO, id line if OK */ public function add_url_line($line_id, $url_id, $url, $label, $type) { @@ -667,7 +667,7 @@ class Account extends CommonObject * * @param User $user Object user making creation * @param int $notrigger 1=Disable triggers - * @return int < 0 if KO, > 0 if OK + * @return int Return integer < 0 if KO, > 0 if OK */ public function create(User $user, $notrigger = 0) { @@ -1285,7 +1285,7 @@ class Account extends CommonObject * * @param User $user Objet user * @param int $filteraccountid To get info for a particular account id - * @return WorkboardResponse|int <0 if KO, WorkboardResponse if OK + * @return WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK */ public function load_board(User $user, $filteraccountid = 0) { @@ -2035,7 +2035,7 @@ class AccountLine extends CommonObjectLine * @param int $rowid Id of bank transaction to load * @param string $ref Ref of bank transaction to load * @param string $num External num to load (ex: num of transaction for paypal fee) - * @return int <0 if KO, 0 if OK but not found, >0 if OK and found + * @return int Return integer <0 if KO, 0 if OK but not found, >0 if OK and found */ public function fetch($rowid, $ref = '', $num = '') { @@ -2110,7 +2110,7 @@ class AccountLine extends CommonObjectLine /** * Inserts a transaction to a bank account * - * @return int <0 if KO, rowid of the line if OK + * @return int Return integer <0 if KO, rowid of the line if OK */ public function insert() { @@ -2677,7 +2677,7 @@ class AccountLine extends CommonObjectLine /** * Return if a bank line was dispatched into bookkeeping * - * @return int <0 if KO, 0=no, 1=yes + * @return int Return integer <0 if KO, 0=no, 1=yes */ public function getVentilExportCompta() { diff --git a/htdocs/compta/bank/class/paymentvarious.class.php b/htdocs/compta/bank/class/paymentvarious.class.php index 612aef730d3..6332f517b8d 100644 --- a/htdocs/compta/bank/class/paymentvarious.class.php +++ b/htdocs/compta/bank/class/paymentvarious.class.php @@ -760,7 +760,7 @@ class PaymentVarious extends CommonObject /** * Return if a various payment linked to a bank line id was dispatched into bookkeeping * - * @return int <0 if KO, 0=no, 1=yes + * @return int Return integer <0 if KO, 0=no, 1=yes */ public function getVentilExportCompta() { diff --git a/htdocs/compta/facture/class/facture-rec.class.php b/htdocs/compta/facture/class/facture-rec.class.php index f932f4aa822..1410c86b0dd 100644 --- a/htdocs/compta/facture/class/facture-rec.class.php +++ b/htdocs/compta/facture/class/facture-rec.class.php @@ -235,7 +235,7 @@ class FactureRec extends CommonInvoice * @param int $facid Id of source invoice * @param int $notrigger No trigger * @param array $onlylines Only the lines of the array - * @return int <0 if KO, id of invoice created if OK + * @return int Return integer <0 if KO, id of invoice created if OK */ public function create($user, $facid, $notrigger = 0, $onlylines = array()) { @@ -484,7 +484,7 @@ class FactureRec extends CommonInvoice * * @param User $user User * @param int $notrigger No trigger - * @return int <0 if KO, Id of line if OK + * @return int Return integer <0 if KO, Id of line if OK */ public function update(User $user, $notrigger = 0) { @@ -871,7 +871,7 @@ class FactureRec extends CommonInvoice * @param int $fk_fournprice Supplier price id (to calculate margin) or '' * @param int $pa_ht Buying price of line (to calculate margin) or '' * @param int $fk_parent_line Id of parent line - * @return int <0 if KO, Id of line if OK + * @return int Return integer <0 if KO, Id of line if OK */ public function addline($desc, $pu_ht, $qty, $txtva, $txlocaltax1 = 0, $txlocaltax2 = 0, $fk_product = 0, $remise_percent = 0, $price_base_type = 'HT', $info_bits = 0, $fk_remise_except = '', $pu_ttc = 0, $type = 0, $rang = -1, $special_code = 0, $label = '', $fk_unit = null, $pu_ht_devise = 0, $date_start_fill = 0, $date_end_fill = 0, $fk_fournprice = null, $pa_ht = 0, $fk_parent_line = 0) { @@ -1078,7 +1078,7 @@ class FactureRec extends CommonInvoice * @param int $fk_fournprice Id of origin supplier price * @param int $pa_ht Price (without tax) of product for margin calculation * @param int $fk_parent_line Id of parent line - * @return int <0 if KO, Id of line if OK + * @return int Return integer <0 if KO, Id of line if OK */ public function updateline($rowid, $desc, $pu_ht, $qty, $txtva, $txlocaltax1 = 0, $txlocaltax2 = 0, $fk_product = 0, $remise_percent = 0, $price_base_type = 'HT', $info_bits = 0, $fk_remise_except = '', $pu_ttc = 0, $type = 0, $rang = -1, $special_code = 0, $label = '', $fk_unit = null, $pu_ht_devise = 0, $notrigger = 0, $date_start_fill = 0, $date_end_fill = 0, $fk_fournprice = null, $pa_ht = 0, $fk_parent_line = 0) { @@ -2309,7 +2309,7 @@ class FactureLigneRec extends CommonInvoiceLine * * @param User $user User * @param int $notrigger No trigger - * @return int <0 if KO, Id of line if OK + * @return int Return integer <0 if KO, Id of line if OK */ public function update(User $user, $notrigger = 0) { diff --git a/htdocs/compta/facture/class/facture.class.php b/htdocs/compta/facture/class/facture.class.php index 5aa24e95e9f..9bc9d68220f 100644 --- a/htdocs/compta/facture/class/facture.class.php +++ b/htdocs/compta/facture/class/facture.class.php @@ -1360,7 +1360,7 @@ class Facture extends CommonInvoice * * @param Object $object Object source * @param User $user Object user - * @return int <0 if KO, 0 if nothing done, 1 if OK + * @return int Return integer <0 if KO, 0 if nothing done, 1 if OK */ public function createFromOrder($object, User $user) { @@ -1490,7 +1490,7 @@ class Facture extends CommonInvoice * @param Object $object Object source * @param User $user Object user * @param array $lines Ids of lines to use for invoice. If empty, all lines will be used. - * @return int <0 if KO, 0 if nothing done, 1 if OK + * @return int Return integer <0 if KO, 0 if nothing done, 1 if OK */ public function createFromContract($object, User $user, $lines = array()) { @@ -2742,7 +2742,7 @@ class Facture extends CommonInvoice * @param User $user User making the deletion. * @param int $notrigger 1=Does not execute triggers, 0= execute triggers * @param int $idwarehouse Id warehouse to use for stock change. - * @return int <0 if KO, 0=Refused, >0 if OK + * @return int Return integer <0 if KO, 0=Refused, >0 if OK */ public function delete($user, $notrigger = 0, $idwarehouse = -1) { @@ -3160,7 +3160,7 @@ class Facture extends CommonInvoice * @param int $idwarehouse Id of warehouse to use for stock decrease if option to decreasenon stock is on (0=no decrease) * @param int $notrigger 1=Does not execute triggers, 0= execute triggers * @param int $batch_rule 0=do not decrement batch, else batch rule to use, 1=take in batches ordered by sellby and eatby dates - * @return int <0 if KO, 0=Nothing done because invoice is not a draft, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done because invoice is not a draft, >0 if OK */ public function validate($user, $force_number = '', $idwarehouse = 0, $notrigger = 0, $batch_rule = 0) { @@ -3772,7 +3772,7 @@ class Facture extends CommonInvoice * @param double $pu_ht_devise Unit price in foreign currency * @param string $ref_ext External reference of the line * @param int $noupdateafterinsertline No update after insert of line - * @return int <0 if KO, Id of line if OK + * @return int Return integer <0 if KO, Id of line if OK */ public function addline( $desc, @@ -4068,7 +4068,7 @@ class Facture extends CommonInvoice * @param int $notrigger disable line update trigger * @param string $ref_ext External reference of the line * @param integer $rang rank of line - * @return int < 0 if KO, > 0 if OK + * @return int Return integer < 0 if KO, > 0 if OK */ public function updateline($rowid, $desc, $pu, $qty, $remise_percent, $date_start, $date_end, $txtva, $txlocaltax1 = 0, $txlocaltax2 = 0, $price_base_type = 'HT', $info_bits = 0, $type = self::TYPE_STANDARD, $fk_parent_line = 0, $skip_update_total = 0, $fk_fournprice = null, $pa_ht = 0, $label = '', $special_code = 0, $array_options = 0, $situation_percent = 100, $fk_unit = null, $pu_ht_devise = 0, $notrigger = 0, $ref_ext = '', $rang = 0) { @@ -4908,7 +4908,7 @@ class Facture extends CommonInvoice * Load indicators for dashboard (this->nbtodo and this->nbtodolate) * * @param User $user Object user - * @return WorkboardResponse|int <0 if KO, WorkboardResponse if OK + * @return WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK */ public function load_board($user) { diff --git a/htdocs/compta/localtax/class/localtax.class.php b/htdocs/compta/localtax/class/localtax.class.php index 01c254206eb..26570d6b836 100644 --- a/htdocs/compta/localtax/class/localtax.class.php +++ b/htdocs/compta/localtax/class/localtax.class.php @@ -467,7 +467,7 @@ class Localtax extends CommonObject * Add a payment of localtax * * @param User $user Object user that insert - * @return int <0 if KO, rowid in localtax table if OK + * @return int Return integer <0 if KO, rowid in localtax table if OK */ public function addPayment($user) { diff --git a/htdocs/compta/paiement/cheque/class/remisecheque.class.php b/htdocs/compta/paiement/cheque/class/remisecheque.class.php index 17cd817c5bc..562d9da587f 100644 --- a/htdocs/compta/paiement/cheque/class/remisecheque.class.php +++ b/htdocs/compta/paiement/cheque/class/remisecheque.class.php @@ -86,7 +86,7 @@ class RemiseCheque extends CommonObject * * @param int $id Id record * @param string $ref Ref record - * @return int <0 if KO, > 0 if OK + * @return int Return integer <0 if KO, > 0 if OK */ public function fetch($id, $ref = '') { @@ -475,7 +475,7 @@ class RemiseCheque extends CommonObject * * @param User $user Objet user * @param string $type Type of payment mode deposit ('CHQ', 'TRA', ...) - * @return WorkboardResponse|int <0 if KO, WorkboardResponse if OK + * @return WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK */ public function load_board($user, $type = 'CHQ') { @@ -529,7 +529,7 @@ class RemiseCheque extends CommonObject * Charge indicateurs this->nb de tableau de bord * * @param string $type Type of payment mode deposit ('CHQ', 'TRA', ...) - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok */ public function load_state_board($type = 'CHQ') { diff --git a/htdocs/compta/paiement/class/paiement.class.php b/htdocs/compta/paiement/class/paiement.class.php index ccc2dfd666e..ffb3f5083b8 100644 --- a/htdocs/compta/paiement/class/paiement.class.php +++ b/htdocs/compta/paiement/class/paiement.class.php @@ -649,7 +649,7 @@ class Paiement extends CommonObject * @param int $notrigger No trigger * @param string $accountancycode When we record a free bank entry, we must provide accounting account if accountancy module is on. * @param string $addbankurl 'direct-debit' or 'credit-transfer': Add another entry into bank_url. - * @return int <0 if KO, bank_line_id if OK + * @return int Return integer <0 if KO, bank_line_id if OK */ public function addPaymentToBank($user, $mode, $label, $accountid, $emetteur_nom, $emetteur_banque, $notrigger = 0, $accountancycode = '', $addbankurl = '') { @@ -867,7 +867,7 @@ class Paiement extends CommonObject * Updates the payment date * * @param int $date New date - * @return int <0 if KO, 0 if OK + * @return int Return integer <0 if KO, 0 if OK */ public function update_date($date) { @@ -924,7 +924,7 @@ class Paiement extends CommonObject * Updates the payment number * * @param string $num_payment New num - * @return int <0 if KO, 0 if OK + * @return int Return integer <0 if KO, 0 if OK */ public function update_num($num_payment) { @@ -1037,7 +1037,7 @@ class Paiement extends CommonObject * Return list of invoices the payment is related to. * * @param string $filter Filter - * @return int|array <0 if KO or array of invoice id + * @return int|array Return integer <0 if KO or array of invoice id * @see getAmountsArray() */ public function getBillsArray($filter = '') diff --git a/htdocs/compta/prelevement/class/bonprelevement.class.php b/htdocs/compta/prelevement/class/bonprelevement.class.php index e22575d5fec..765431e15b6 100644 --- a/htdocs/compta/prelevement/class/bonprelevement.class.php +++ b/htdocs/compta/prelevement/class/bonprelevement.class.php @@ -744,7 +744,7 @@ class BonPrelevement extends CommonObject * * @param string $mode 'direct-debit' or 'bank-transfer' * @param string $type for type=salary - * @return double =0 if OK + * @return integer Return integer <0 if KO, >=0 if OK */ public function fetch($rowid) { diff --git a/htdocs/compta/sociales/class/chargesociales.class.php b/htdocs/compta/sociales/class/chargesociales.class.php index 909072fb459..fbe33d056c8 100644 --- a/htdocs/compta/sociales/class/chargesociales.class.php +++ b/htdocs/compta/sociales/class/chargesociales.class.php @@ -144,7 +144,7 @@ class ChargeSociales extends CommonObject * * @param int $id Id * @param string $ref Ref - * @return int <0 KO >0 OK + * @return int Return integer <0 KO >0 OK */ public function fetch($id, $ref = '') { @@ -222,7 +222,7 @@ class ChargeSociales extends CommonObject * Create a social contribution into database * * @param User $user User making creation - * @return int <0 if KO, id if OK + * @return int Return integer <0 if KO, id if OK */ public function create($user) { diff --git a/htdocs/compta/sociales/class/paymentsocialcontribution.class.php b/htdocs/compta/sociales/class/paymentsocialcontribution.class.php index 75800e434ca..5b0782a6598 100644 --- a/htdocs/compta/sociales/class/paymentsocialcontribution.class.php +++ b/htdocs/compta/sociales/class/paymentsocialcontribution.class.php @@ -153,7 +153,7 @@ class PaymentSocialContribution extends CommonObject * * @param User $user User making payment * @param int $closepaidcontrib 1=Also close paid contributions to paid, 0=Do nothing more - * @return int <0 if KO, id of payment if OK + * @return int Return integer <0 if KO, id of payment if OK */ public function create($user, $closepaidcontrib = 0) { @@ -802,7 +802,7 @@ class PaymentSocialContribution extends CommonObject /** * Return if object was dispatched into bookkeeping * - * @return int <0 if KO, 0=no, 1=yes + * @return int Return integer <0 if KO, 0=no, 1=yes */ public function getVentilExportCompta() { diff --git a/htdocs/compta/tva/class/paymentvat.class.php b/htdocs/compta/tva/class/paymentvat.class.php index 8fa529f410b..3d0d51bebf8 100644 --- a/htdocs/compta/tva/class/paymentvat.class.php +++ b/htdocs/compta/tva/class/paymentvat.class.php @@ -154,7 +154,7 @@ class PaymentVAT extends CommonObject * * @param User $user User making payment * @param int $closepaidvat 1=Also close paid contributions to paid, 0=Do nothing more - * @return int <0 if KO, id of payment if OK + * @return int Return integer <0 if KO, id of payment if OK */ public function create($user, $closepaidvat = 0) { diff --git a/htdocs/compta/tva/class/tva.class.php b/htdocs/compta/tva/class/tva.class.php index 281c44d4574..e160abfc3b8 100644 --- a/htdocs/compta/tva/class/tva.class.php +++ b/htdocs/compta/tva/class/tva.class.php @@ -559,7 +559,7 @@ class Tva extends CommonObject * Create in database * * @param User $user Object user that insert - * @return int <0 if KO, rowid in tva table if OK + * @return int Return integer <0 if KO, rowid in tva table if OK */ public function addPayment($user) { diff --git a/htdocs/contact/class/contact.class.php b/htdocs/contact/class/contact.class.php index 03dc1d964d6..25ca192e6fa 100644 --- a/htdocs/contact/class/contact.class.php +++ b/htdocs/contact/class/contact.class.php @@ -883,7 +883,7 @@ class Contact extends CommonObject * @param int $id Id of contact * @param User $user User asking to change alert or birthday * @param int $notrigger 0=no, 1=yes - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function update_perso($id, $user = null, $notrigger = 0) { @@ -1178,7 +1178,7 @@ class Contact extends CommonObject * ref_commande (for order and/or shipments) * ref_propale * - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function load_ref_elements() { @@ -1678,7 +1678,7 @@ class Contact extends CommonObject * Change status of a user * * @param int $status Status to set - * @return int <0 if KO, 0 if nothing is done, >0 if OK + * @return int Return integer <0 if KO, 0 if nothing is done, >0 if OK */ public function setstatus($status) { @@ -1758,7 +1758,7 @@ class Contact extends CommonObject * Fetch roles (default contact of some companies) for the current contact. * This load the array ->roles. * - * @return int <0 if KO, Nb of roles found if OK + * @return int Return integer <0 if KO, Nb of roles found if OK * @see updateRoles() */ public function fetchRoles() diff --git a/htdocs/contrat/class/contrat.class.php b/htdocs/contrat/class/contrat.class.php index c0237c56693..08bb4caa932 100644 --- a/htdocs/contrat/class/contrat.class.php +++ b/htdocs/contrat/class/contrat.class.php @@ -680,7 +680,7 @@ class Contrat extends CommonObject * @param string $ref_supplier Supplier ref * @param int $noextrafields 0=Default to load extrafields, 1=No extrafields * @param int $nolines 0=Default to load lines, 1=No lines - * @return int <0 if KO, 0 if not found or if two records found for same ref, Id of contract if OK + * @return int Return integer <0 if KO, 0 if not found or if two records found for same ref, Id of contract if OK */ public function fetch($id, $ref = '', $ref_customer = '', $ref_supplier = '', $noextrafields = 0, $nolines = 0) { @@ -976,7 +976,7 @@ class Contrat extends CommonObject * Create a contract into database * * @param User $user User that create - * @return int <0 if KO, id of contract if OK + * @return int Return integer <0 if KO, id of contract if OK */ public function create($user) { @@ -1168,7 +1168,7 @@ class Contrat extends CommonObject * Delete object * * @param User $user User that deletes - * @return int < 0 if KO, > 0 if OK + * @return int Return integer < 0 if KO, > 0 if OK */ public function delete($user) { @@ -2282,7 +2282,7 @@ class Contrat extends CommonObject * * @param User $user Objet user * @param string $mode "inactive" pour services a activer, "expired" pour services expires - * @return WorkboardResponse|int <0 if KO, WorkboardResponse if OK + * @return WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK */ public function load_board($user, $mode) { @@ -2378,7 +2378,7 @@ class Contrat extends CommonObject /** * Charge indicateurs this->nb de tableau de bord * - * @return int <0 si ko, >0 si ok + * @return int Return integer <0 si ko, >0 si ok */ public function load_state_board() { @@ -2543,7 +2543,7 @@ class Contrat extends CommonObject * @param int $hidedesc Hide description * @param int $hideref Hide ref * @param null|array $moreparams Array to provide more information - * @return int < 0 if KO, 0 = no doc generated, > 0 if OK + * @return int Return integer < 0 if KO, 0 = no doc generated, > 0 if OK */ public function generateDocument($modele, $outputlangs, $hidedetails = 0, $hidedesc = 0, $hideref = 0, $moreparams = null) { diff --git a/htdocs/core/class/CMailFile.class.php b/htdocs/core/class/CMailFile.class.php index 78c987a0905..f7aae90d6af 100644 --- a/htdocs/core/class/CMailFile.class.php +++ b/htdocs/core/class/CMailFile.class.php @@ -1242,7 +1242,7 @@ class CMailFile * Read a file on disk and return encoded content for emails (mode = 'mail') * * @param string $sourcefile Path to file to encode - * @return int|string <0 if KO, encoded string if OK + * @return int|string Return integer <0 if KO, encoded string if OK */ private function _encode_file($sourcefile) { diff --git a/htdocs/core/class/antivir.class.php b/htdocs/core/class/antivir.class.php index f8391c7a512..5e81ef2cfec 100644 --- a/htdocs/core/class/antivir.class.php +++ b/htdocs/core/class/antivir.class.php @@ -66,7 +66,7 @@ class AntiVir * Return also true (virus found) if file end with '.virus' (so we can make test safely). * * @param string $file File to scan - * @return int <0 if KO (-98 if error, -99 if virus), 0 if OK + * @return int Return integer <0 if KO (-98 if error, -99 if virus), 0 if OK */ public function dol_avscan_file($file) { diff --git a/htdocs/core/class/comment.class.php b/htdocs/core/class/comment.class.php index 4443e04dd38..3bae32d81e3 100644 --- a/htdocs/core/class/comment.class.php +++ b/htdocs/core/class/comment.class.php @@ -237,7 +237,7 @@ class Comment extends CommonObject * * @param User $user User that modify * @param int $notrigger 0=launch triggers after, 1=disable triggers - * @return int <=0 if KO, >0 if OK + * @return int Return integer <=0 if KO, >0 if OK */ public function update(User $user, $notrigger = 0) { diff --git a/htdocs/core/class/commondocgenerator.class.php b/htdocs/core/class/commondocgenerator.class.php index da836b0f883..8603e78e95f 100644 --- a/htdocs/core/class/commondocgenerator.class.php +++ b/htdocs/core/class/commondocgenerator.class.php @@ -1232,7 +1232,7 @@ abstract class CommonDocGenerator * @param float $curY curent Y position * @param string $colKey the column key * @param string $columnText column text - * @return int <0 if KO, >= if OK + * @return int Return integer <0 if KO, >= if OK */ public function printStdColumnContent($pdf, &$curY, $colKey, $columnText = '') { @@ -1658,7 +1658,7 @@ abstract class CommonDocGenerator * @param object $object common object det * @param Translate $outputlangs langs * @param int $hidedetails Do not show line details - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function defineColumnExtrafield($object, $outputlangs, $hidedetails = 0) { diff --git a/htdocs/core/class/commoninvoice.class.php b/htdocs/core/class/commoninvoice.class.php index 33e46d0a15e..0f3b8628122 100644 --- a/htdocs/core/class/commoninvoice.class.php +++ b/htdocs/core/class/commoninvoice.class.php @@ -280,7 +280,7 @@ abstract class CommonInvoice extends CommonObject * of FACTURE_SUPPLIER_DEPOSITS_ARE_JUST_PAYMENTS is on for purchase invoices (not recommended). * * @param int $multicurrency Return multicurrency_amount instead of amount - * @return float <0 and set ->error if KO, Sum of deposits amount otherwise + * @return float Return integer <0 and set ->error if KO, Sum of deposits amount otherwise * @see getSommePaiement(), getSumCreditNotesUsed() */ public function getSumDepositsUsed($multicurrency = 0) @@ -313,7 +313,7 @@ abstract class CommonInvoice extends CommonObject * Return amount (with tax) of all credit notes invoices + excess received used by invoice * * @param int $multicurrency Return multicurrency_amount instead of amount - * @return float <0 and set ->error if KO, Sum of credit notes and deposits amount otherwise + * @return float Return integer <0 and set ->error if KO, Sum of credit notes and deposits amount otherwise * @see getSommePaiement(), getSumDepositsUsed() */ public function getSumCreditNotesUsed($multicurrency = 0) @@ -340,7 +340,7 @@ abstract class CommonInvoice extends CommonObject * Return amount (with tax) of all converted amount for this credit note * * @param int $multicurrency Return multicurrency_amount instead of amount - * @return float <0 if KO, Sum of credit notes and deposits amount otherwise + * @return float Return integer <0 if KO, Sum of credit notes and deposits amount otherwise */ public function getSumFromThisCreditNotesNotUsed($multicurrency = 0) { @@ -388,7 +388,7 @@ abstract class CommonInvoice extends CommonObject * Returns the id of the invoice that replaces it * * @param string $option status filter ('', 'validated', ...) - * @return int <0 si KO, 0 if no invoice replaces it, id of invoice otherwise + * @return int Return integer <0 si KO, 0 if no invoice replaces it, id of invoice otherwise */ public function getIdReplacingInvoice($option = '') { @@ -534,7 +534,7 @@ abstract class CommonInvoice extends CommonObject * If there is payment -> no (-4) * Otherwise -> yes (2) * - * @return int <=0 if no, >0 if yes + * @return int Return integer <=0 if no, >0 if yes */ public function is_erasable() { @@ -595,7 +595,7 @@ abstract class CommonInvoice extends CommonObject /** * Return if an invoice was dispatched into bookkeeping * - * @return int <0 if KO, 0=no, 1=yes + * @return int Return integer <0 if KO, 0=no, 1=yes */ public function getVentilExportCompta() { @@ -954,7 +954,7 @@ abstract class CommonInvoice extends CommonObject * @param string $type 'direct-debit' or 'bank-transfer' * @param string $sourcetype Source ('facture' or 'supplier_invoice') * @param int $checkduplicateamongall 0=Default (check among open requests only to find if request already exists). 1=Check also among requests completely processed and cancel if at least 1 request exists whatever is its status. - * @return int <0 if KO, 0 if a request already exists, >0 if OK + * @return int Return integer <0 if KO, 0 if a request already exists, >0 if OK */ public function demande_prelevement($fuser, $amount = 0, $type = 'direct-debit', $sourcetype = 'facture', $checkduplicateamongall = 0) { @@ -1613,7 +1613,7 @@ abstract class CommonInvoice extends CommonObject * * @param User $fuser User making delete * @param int $did ID of request to delete - * @return int <0 if OK, >0 if KO + * @return int Return integer <0 if OK, >0 if KO */ public function demande_prelevement_delete($fuser, $did) { diff --git a/htdocs/core/class/commonobject.class.php b/htdocs/core/class/commonobject.class.php index f517cb73cb6..fdc1fc4bf6a 100644 --- a/htdocs/core/class/commonobject.class.php +++ b/htdocs/core/class/commonobject.class.php @@ -769,7 +769,7 @@ abstract class CommonObject * @param int $id Id of object * @param string $ref Ref of object to check * @param string $ref_ext Ref ext of object to check - * @return int <0 if KO, 0 if OK but not found, >0 if OK and exists + * @return int Return integer <0 if KO, 0 if OK but not found, >0 if OK and exists */ public static function isExistingObject($element, $id, $ref = '', $ref_ext = '') { @@ -1091,7 +1091,7 @@ abstract class CommonObject * @param int|string $type_contact Type of contact (code or id). Must be id or code found into table llx_c_type_contact. For example: SALESREPFOLL * @param string $source external=Contact extern (llx_socpeople), internal=Contact intern (llx_user) * @param int $notrigger Disable all triggers - * @return int <0 if KO, 0 if already added or code not valid, >0 if OK + * @return int Return integer <0 if KO, 0 if already added or code not valid, >0 if OK */ public function add_contact($fk_socpeople, $type_contact, $source = 'external', $notrigger = 0) { @@ -1221,7 +1221,7 @@ abstract class CommonObject * @param int $statut New status of link * @param int $type_contact_id Id of contact type (not modified if 0) * @param int $fk_socpeople Id of soc_people to update (not modified if 0) - * @return int <0 if KO, >= 0 if OK + * @return int Return integer <0 if KO, >= 0 if OK */ public function update_contact($rowid, $statut, $type_contact_id = 0, $fk_socpeople = 0) { @@ -1301,7 +1301,7 @@ abstract class CommonObject * * @param string $source '' or 'internal' or 'external' * @param string $code Type of contact (code or id) - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function delete_linked_contact($source = '', $code = '') { @@ -1446,7 +1446,7 @@ abstract class CommonObject * Update status of a contact linked to object * * @param int $rowid Id of link between object and contact - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function swapContactStatus($rowid) { @@ -1804,7 +1804,7 @@ abstract class CommonObject * Properties ->barcode_type that is id of barcode. Type is used to find other properties, but * if it is not defined, ->element must be defined to know default barcode type. * - * @return int <0 if KO, 0 if can't guess type of barcode (ISBN, EAN13...), >0 if OK (all barcode properties loaded) + * @return int Return integer <0 if KO, 0 if can't guess type of barcode (ISBN, EAN13...), >0 if OK (all barcode properties loaded) */ public function fetch_barcode() { @@ -1851,7 +1851,7 @@ abstract class CommonObject /** * Load the project with id $this->fk_project into this->project * - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function fetch_project() { @@ -1863,7 +1863,7 @@ abstract class CommonObject /** * Load the project with id $this->fk_project into this->project * - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function fetch_projet() { @@ -1889,7 +1889,7 @@ abstract class CommonObject /** * Load the product with id $this->fk_product into this->product * - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function fetch_product() { @@ -2893,7 +2893,7 @@ abstract class CommonObject * @deprecated * * @param int $id Address id - * @return int <0 si ko, >0 si ok + * @return int Return integer <0 si ko, >0 si ok */ public function setDeliveryAddress($id) { @@ -3912,7 +3912,7 @@ abstract class CommonObject * @param int $origin_id Linked element id * @param User $f_user User that create * @param int $notrigger 1=Does not execute triggers, 0=execute triggers - * @return int <=0 if KO, >0 if OK + * @return int Return integer <=0 if KO, >0 if OK * @see fetchObjectLinked(), updateObjectLinked(), deleteObjectLinked() */ public function add_object_linked($origin = null, $origin_id = null, $f_user = null, $notrigger = 0) @@ -4474,7 +4474,7 @@ abstract class CommonObject * @param int $fk_object_where id of object we need to remove linked items * @param string $field_where name of field of object we need to delete linked items * @param string $table_element name of association table - * @return int <0 if KO, 0 if nothing done, >0 if OK and something done + * @return int Return integer <0 if KO, 0 if nothing done, >0 if OK and something done */ public static function deleteAllItemsLinkedByObjectID($fk_object_where, $field_where, $table_element) { @@ -4629,7 +4629,7 @@ abstract class CommonObject * * @param int $id Record id * @param string $ref Record ref - * @return int <0 if KO, 0 if nothing done, >0 if OK + * @return int Return integer <0 if KO, 0 if nothing done, >0 if OK */ public function getCanvas($id = 0, $ref = '') { @@ -4696,7 +4696,7 @@ abstract class CommonObject * * @param int $id Force id of object * @param int $entity Force entity to check - * @return int <0 if KO, 0 if not used, >0 if already used + * @return int Return integer <0 if KO, 0 if not used, >0 if already used */ public function isObjectUsed($id = 0, $entity = 0) { @@ -4781,7 +4781,7 @@ abstract class CommonObject * Function to say how many lines object contains * * @param int $predefined -1=All, 0=Count free product/service only, 1=Count predefined product/service only, 2=Count predefined product, 3=Count predefined service - * @return int <0 if KO, 0 if no predefined products, nb of lines with predefined products if found + * @return int Return integer <0 if KO, 0 if no predefined products, nb of lines with predefined products if found */ public function hasProductsOrServices($predefined = -1) { @@ -5461,7 +5461,7 @@ abstract class CommonObject * @param string $resource_type 'resource' * @param int $busy Busy or not * @param int $mandatory Mandatory or not - * @return int <=0 if KO, >0 if OK + * @return int Return integer <=0 if KO, >0 if OK */ public function add_element_resource($resource_id, $resource_type, $busy = 0, $mandatory = 0) { @@ -6017,7 +6017,7 @@ abstract class CommonObject * Function to get alternative languages of a data into $this->array_languages * This method is NOT called by method fetch of objects but must be called separately. * - * @return int <0 if error, 0 if no values of alternative languages to find nor found, 1 if a value was found and loaded + * @return int Return integer <0 if error, 0 if no values of alternative languages to find nor found, 1 if a value was found and loaded * @see fetch_optionnals() */ public function fetchValuesForExtraLanguages() @@ -6195,7 +6195,7 @@ abstract class CommonObject * * @param int $rowid Id of line. Use the id of object if not defined. Deprecated. Function must be called without parameters. * @param array $optionsArray Array resulting of call of extrafields->fetch_name_optionals_label(). Deprecated. Function must be called without parameters. - * @return int <0 if error, 0 if no values of extrafield to find nor found, 1 if an attribute is found and value loaded + * @return int Return integer <0 if error, 0 if no values of extrafield to find nor found, 1 if an attribute is found and value loaded * @see fetchValuesForExtraLanguages() */ public function fetch_optionals($rowid = null, $optionsArray = null) @@ -8926,7 +8926,7 @@ abstract class CommonObject * @param float $unitPrice Product unit price * @param float $discountPercent Line discount percent * @param int $fk_product Product id - * @return float <0 if KO, buyprice if OK + * @return float Return integer <0 if KO, buyprice if OK */ public function defineBuyPrice($unitPrice = 0.0, $discountPercent = 0.0, $fk_product = 0) { @@ -9975,7 +9975,7 @@ abstract class CommonObject * @param User $user User that deletes * @param bool $notrigger false=launch triggers after, true=disable triggers * @param int $forcechilddeletion 0=no, 1=Force deletion of children - * @return int <0 if KO, 0=Nothing done because object has child, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done because object has child, >0 if OK */ public function deleteCommon(User $user, $notrigger = false, $forcechilddeletion = 0) { @@ -10500,7 +10500,7 @@ abstract class CommonObject * @param int $fromId Id object source * @param int $toId Id object cible * @param string $type Type of category ('product', ...) - * @return int < 0 if error, > 0 if ok + * @return int Return integer < 0 if error, > 0 if ok */ public function cloneCategories($fromId, $toId, $type = '') { diff --git a/htdocs/core/class/commonobjectline.class.php b/htdocs/core/class/commonobjectline.class.php index 91c3800432a..9f53c4ada61 100644 --- a/htdocs/core/class/commonobjectline.class.php +++ b/htdocs/core/class/commonobjectline.class.php @@ -154,7 +154,7 @@ abstract class CommonObjectLine extends CommonObject * A langs->trans() must be called on result to get translated value. * * @param string $type Label type ('long', 'short' or 'code'). This can be a translation key. - * @return string|int <0 if KO, label if OK (Example: 'long', 'short' or 'unitCODE') + * @return string|int Return integer <0 if KO, label if OK (Example: 'long', 'short' or 'unitCODE') */ public function getLabelOfUnit($type = 'long') { diff --git a/htdocs/core/class/conf.class.php b/htdocs/core/class/conf.class.php index e266288b528..92afb54af52 100644 --- a/htdocs/core/class/conf.class.php +++ b/htdocs/core/class/conf.class.php @@ -235,7 +235,7 @@ class Conf extends stdClass * * @param DoliDB $db Database handler * @param int $entity Entity to get - * @return int < 0 if KO, >= 0 if OK + * @return int Return integer < 0 if KO, >= 0 if OK */ public function setEntityValues($db, $entity) { @@ -253,7 +253,7 @@ class Conf extends stdClass * Note that this->db->xxx, this->file->xxx have been already set when setValues is called. * * @param DoliDB $db Database handler - * @return int < 0 if KO, >= 0 if OK + * @return int Return integer < 0 if KO, >= 0 if OK */ public function setValues($db) { diff --git a/htdocs/core/class/cproductnature.class.php b/htdocs/core/class/cproductnature.class.php index 28645210a19..7022de50ba1 100644 --- a/htdocs/core/class/cproductnature.class.php +++ b/htdocs/core/class/cproductnature.class.php @@ -294,7 +294,7 @@ class CProductNature extends CommonDict * Get unit from code * @param int $code code of unit * @param string $mode 0= id , short_label=Use short label as value, code=use code - * @return int <0 if KO, Id of code if OK + * @return int Return integer <0 if KO, Id of code if OK */ public function getProductNatureFromCode($code, $mode = 'code') { diff --git a/htdocs/core/class/cunits.class.php b/htdocs/core/class/cunits.class.php index 8bd7baac30b..4c7f1246587 100644 --- a/htdocs/core/class/cunits.class.php +++ b/htdocs/core/class/cunits.class.php @@ -402,7 +402,7 @@ class CUnits extends CommonDict * @param string $code code of unit * @param string $mode 0= id , short_label=Use short label as value, code=use code * @param string $unit_type weight,size,surface,volume,qty,time... - * @return int <0 if KO, Id of code if OK + * @return int Return integer <0 if KO, Id of code if OK */ public function getUnitFromCode($code, $mode = 'code', $unit_type = '') { diff --git a/htdocs/core/class/discount.class.php b/htdocs/core/class/discount.class.php index 1a960c5c3eb..f92ce30e087 100644 --- a/htdocs/core/class/discount.class.php +++ b/htdocs/core/class/discount.class.php @@ -148,7 +148,7 @@ class DiscountAbsolute * @param int $rowid id discount to load * @param int $fk_facture_source fk_facture_source * @param int $fk_invoice_supplier_source fk_invoice_supplier_source - * @return int <0 if KO, =0 if not found, >0 if OK + * @return int Return integer <0 if KO, =0 if not found, >0 if OK */ public function fetch($rowid, $fk_facture_source = 0, $fk_invoice_supplier_source = 0) { @@ -530,7 +530,7 @@ class DiscountAbsolute * @param int $maxvalue Filter on max value for discount * @param int $discount_type 0 => customer discount, 1 => supplier discount * @param int $multicurrency Return multicurrency_amount instead of amount - * @return int <0 if KO, amount otherwise + * @return int Return integer <0 if KO, amount otherwise */ public function getAvailableDiscounts($company = '', $user = '', $filter = '', $maxvalue = 0, $discount_type = 0, $multicurrency = 0) { @@ -584,7 +584,7 @@ class DiscountAbsolute * * @param CommonInvoice $invoice Object invoice (customer of supplier) * @param int $multicurrency 1=Return multicurrency_amount instead of amount. TODO Add a mode multicurrency = -1 to return array with amount + multicurrency amount - * @return int <0 if KO, Sum of credit notes and deposits amount otherwise + * @return int Return integer <0 if KO, Sum of credit notes and deposits amount otherwise */ public function getSumDepositsUsed($invoice, $multicurrency = 0) { @@ -625,7 +625,7 @@ class DiscountAbsolute * * @param CommonInvoice $invoice Object invoice * @param int $multicurrency 1=Return multicurrency_amount instead of amount. TODO Add a mode multicurrency = -1 to return array with amount + multicurrency amount - * @return int <0 if KO, Sum of credit notes and excess received amount otherwise + * @return int Return integer <0 if KO, Sum of credit notes and excess received amount otherwise */ public function getSumCreditNotesUsed($invoice, $multicurrency = 0) { @@ -665,7 +665,7 @@ class DiscountAbsolute * * @param CommonInvoice $invoice Object invoice * @param int $multicurrency Return multicurrency_amount instead of amount. TODO Add a mode multicurrency = -1 to return array with amount + multicurrency amount - * @return int <0 if KO, Sum of credit notes and deposits amount otherwise + * @return int Return integer <0 if KO, Sum of credit notes and deposits amount otherwise */ public function getSumFromThisCreditNotesNotUsed($invoice, $multicurrency = 0) { diff --git a/htdocs/core/class/extrafields.class.php b/htdocs/core/class/extrafields.class.php index 883d8e296ce..ec4f72027be 100644 --- a/htdocs/core/class/extrafields.class.php +++ b/htdocs/core/class/extrafields.class.php @@ -135,7 +135,7 @@ class ExtraFields * @param int $totalizable Is a measure. Must show a total on lists * @param int $printable Is extrafield displayed on PDF * @param array $moreparams More parameters. Example: array('css'=>, 'csslist'=>Css on list, 'cssview'=>...) - * @return int <=0 if KO, >0 if OK + * @return int Return integer <=0 if KO, >0 if OK */ public function addExtraField($attrname, $label, $type, $pos, $size, $elementtype, $unique = 0, $required = 0, $default_value = '', $param = '', $alwayseditable = 0, $perms = '', $list = '-1', $help = '', $computed = '', $entity = '', $langfile = '', $enabled = '1', $totalizable = 0, $printable = 0, $moreparams = array()) { @@ -197,7 +197,7 @@ class ExtraFields * @param string $computed Computed value * @param string $help Help on tooltip * @param array $moreparams More parameters. Example: array('css'=>, 'csslist'=>, 'cssview'=>...) - * @return int <=0 if KO, >0 if OK + * @return int Return integer <=0 if KO, >0 if OK */ private function create($attrname, $type = 'varchar', $length = 255, $elementtype = 'member', $unique = 0, $required = 0, $default_value = '', $param = '', $perms = '', $list = '0', $computed = '', $help = '', $moreparams = array()) { @@ -300,7 +300,7 @@ class ExtraFields * @param int $totalizable Is a measure. Must show a total on lists * @param int $printable Is extrafield displayed on PDF * @param array $moreparams More parameters. Example: array('css'=>, 'csslist'=>, 'cssview'=>...) - * @return int <=0 if KO, >0 if OK + * @return int Return integer <=0 if KO, >0 if OK * @throws Exception */ private function create_label($attrname, $label = '', $type = '', $pos = 0, $size = 0, $elementtype = 'member', $unique = 0, $required = 0, $param = '', $alwayseditable = 0, $perms = '', $list = '-1', $help = '', $default = '', $computed = '', $entity = '', $langfile = '', $enabled = '1', $totalizable = 0, $printable = 0, $moreparams = array()) @@ -433,7 +433,7 @@ class ExtraFields * * @param string $attrname Code of attribute to delete * @param string $elementtype Element type ('member', 'product', 'thirdparty', 'contact', ...) - * @return int < 0 if KO, 0 if nothing is done, 1 if OK + * @return int Return integer < 0 if KO, 0 if nothing is done, 1 if OK */ public function delete($attrname, $elementtype = 'member') { @@ -491,7 +491,7 @@ class ExtraFields * * @param string $attrname Code of attribute to delete * @param string $elementtype Element type ('member', 'product', 'thirdparty', ...) - * @return int < 0 if KO, 0 if nothing is done, 1 if OK + * @return int Return integer < 0 if KO, 0 if nothing is done, 1 if OK */ private function delete_label($attrname, $elementtype = 'member') { @@ -673,7 +673,7 @@ class ExtraFields * @param int $totalizable Is extrafield totalizable on list * @param int $printable Is extrafield displayed on PDF * @param array $moreparams More parameters. Example: array('css'=>, 'csslist'=>, 'cssview'=>...) - * @return int <=0 if KO, >0 if OK + * @return int Return integer <=0 if KO, >0 if OK * @throws Exception */ private function update_label($attrname, $label, $type, $size, $elementtype, $unique = 0, $required = 0, $pos = 0, $param = '', $alwayseditable = 0, $perms = '', $list = '0', $help = '', $default = '', $computed = '', $entity = '', $langfile = '', $enabled = '1', $totalizable = 0, $printable = 0, $moreparams = array()) diff --git a/htdocs/core/class/html.form.class.php b/htdocs/core/class/html.form.class.php index 2860d2c2bfe..1686336db60 100644 --- a/htdocs/core/class/html.form.class.php +++ b/htdocs/core/class/html.form.class.php @@ -1730,7 +1730,7 @@ class Form * @param bool $options_only Return options only (for ajax treatment) * @param string $moreparam Add more parameters onto the select tag. For example 'style="width: 95%"' to avoid select2 component to go over parent container * @param string $htmlid Html id to use instead of htmlname - * @return int <0 if KO, Nb of contact in list if OK + * @return int Return integer <0 if KO, Nb of contact in list if OK * @deprecated You can use selectcontacts directly (warning order of param was changed) */ public function select_contacts($socid, $selected = '', $htmlname = 'contactid', $showempty = 0, $exclude = '', $limitto = '', $showfunction = 0, $morecss = '', $showsoc = 0, $forcecombo = 0, $events = array(), $options_only = false, $moreparam = '', $htmlid = '') @@ -1762,7 +1762,7 @@ class Form * @param string $htmlid Html id to use instead of htmlname * @param bool $multiple add [] in the name of element and add 'multiple' attribut * @param integer $disableifempty Set tag 'disabled' on select if there is no choice - * @return int|string <0 if KO, HTML with select string if OK. + * @return int|string Return integer <0 if KO, HTML with select string if OK. */ public function selectcontacts($socid, $selected = '', $htmlname = 'contactid', $showempty = 0, $exclude = '', $limitto = '', $showfunction = 0, $morecss = '', $options_only = false, $showsoc = 0, $forcecombo = 0, $events = array(), $moreparam = '', $htmlid = '', $multiple = false, $disableifempty = 0) { @@ -4880,7 +4880,7 @@ class Form * @param int $showcurrency Show currency in label * @param string $morecss More CSS * @param int $nooutput 1=Return string, do not send to output - * @return int <0 if error, Num of bank account found if OK (0, 1, 2, ...) + * @return int Return integer <0 if error, Num of bank account found if OK (0, 1, 2, ...) */ public function select_comptes($selected = '', $htmlname = 'accountid', $status = 0, $filtre = '', $useempty = 0, $moreattrib = '', $showcurrency = 0, $morecss = '', $nooutput = 0) { @@ -4963,7 +4963,7 @@ class Form * @param string $filtre To filter list. This parameter must not come from input of users * @param int $useempty 1=Add an empty value in list, 2=Add an empty value in list only if there is more than 2 entries. * @param string $moreattrib To add more attribute on select - * @return int <0 if error, Num of establishment found if OK (0, 1, 2, ...) + * @return int Return integer <0 if error, Num of establishment found if OK (0, 1, 2, ...) */ public function selectEstablishments($selected = '', $htmlname = 'entity', $status = 0, $filtre = '', $useempty = 0, $moreattrib = '') { @@ -8995,7 +8995,7 @@ class Form * @param string $morehtmlright More html to show on right of title * @param array $compatibleImportElementsList Array of compatibles elements object for "import from" action * @param string $title Title - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function showLinkedObjectBlock($object, $morehtmlright = '', $compatibleImportElementsList = false, $title = 'RelatedObjects') { diff --git a/htdocs/core/class/html.formactions.class.php b/htdocs/core/class/html.formactions.class.php index b4d37581ab2..52e4e3fba31 100644 --- a/htdocs/core/class/html.formactions.class.php +++ b/htdocs/core/class/html.formactions.class.php @@ -167,7 +167,7 @@ class FormActions * @param string $moreparambacktopage More param for the backtopage * @param string $morehtmlcenter More html text on center of title line * @param int $assignedtouser Assign event by default to this user id (will be ignored if not enough permissions) - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function showactions($object, $typeelement, $socid = 0, $forceshowtitle = 0, $morecss = 'listactions', $max = 0, $moreparambacktopage = '', $morehtmlcenter = '', $assignedtouser = 0) { diff --git a/htdocs/core/class/html.formfile.class.php b/htdocs/core/class/html.formfile.class.php index 12489481a43..3f5172c3e91 100644 --- a/htdocs/core/class/html.formfile.class.php +++ b/htdocs/core/class/html.formfile.class.php @@ -296,7 +296,7 @@ class FormFile * @param string $title Title to show on top of form * @param string $buttonlabel Label on submit button * @param string $codelang Default language code to use on lang combo box if multilang is enabled - * @return int <0 if KO, number of shown files if OK + * @return int Return integer <0 if KO, number of shown files if OK * @deprecated Use print xxx->showdocuments() instead. */ public function show_documents($modulepart, $modulesubdir, $filedir, $urlsource, $genallowed, $delallowed = 0, $modelselected = '', $allowgenifempty = 1, $forcenomultilang = 0, $iconPDF = 0, $notused = 0, $noform = 0, $param = '', $title = '', $buttonlabel = '', $codelang = '') @@ -1185,7 +1185,7 @@ class FormFile * @param int $addfilterfields Add the line with filters * @param int $disablecrop Disable crop feature on images (-1 = auto, prefer to set it explicitely to 0 or 1) * @param string $moreattrondiv More attributes on the div for responsive. Example 'style="height:280px; overflow: auto;"' - * @return int <0 if KO, nb of files shown if OK + * @return int Return integer <0 if KO, nb of files shown if OK * @see list_of_autoecmfiles() */ public function list_of_documents($filearray, $object, $modulepart, $param = '', $forcedownload = 0, $relativepath = '', $permonobject = 1, $useinecm = 0, $textifempty = '', $maxlength = 0, $title = '', $url = '', $showrelpart = 0, $permtoeditline = -1, $upload_dir = '', $sortfield = '', $sortorder = 'ASC', $disablemove = 1, $addfilterfields = 0, $disablecrop = -1, $moreattrondiv = '') @@ -1643,7 +1643,7 @@ class FormFile * @param int $maxlength Maximum length of file name shown * @param string $url Full url to use for click links ('' = autodetect) * @param int $addfilterfields Add line with filters - * @return int <0 if KO, nb of files shown if OK + * @return int Return integer <0 if KO, nb of files shown if OK * @see list_of_documents() */ public function list_of_autoecmfiles($upload_dir, $filearray, $modulepart, $param, $forcedownload = 0, $relativepath = '', $permissiontodelete = 1, $useinecm = 0, $textifempty = '', $maxlength = 0, $url = '', $addfilterfields = 0) diff --git a/htdocs/core/class/html.formmail.class.php b/htdocs/core/class/html.formmail.class.php index de2086b3b2d..59effb1deac 100644 --- a/htdocs/core/class/html.formmail.class.php +++ b/htdocs/core/class/html.formmail.class.php @@ -1521,7 +1521,7 @@ class FormMail extends Form * @param string $type_template Get message for key module * @param User $user Use template public or limited to this user * @param Translate $outputlangs Output lang object - * @return int <0 if KO, + * @return int Return integer <0 if KO, */ public function isEMailTemplate($type_template, $user, $outputlangs) { @@ -1555,7 +1555,7 @@ class FormMail extends Form * @param User $user Use template public or limited to this user * @param Translate $outputlangs Output lang object * @param int $active 1=Only active template, 0=Only disabled, -1=All - * @return int <0 if KO, nb of records found if OK + * @return int Return integer <0 if KO, nb of records found if OK */ public function fetchAllEMailTemplate($type_template, $user, $outputlangs, $active = 1) { diff --git a/htdocs/core/class/infobox.class.php b/htdocs/core/class/infobox.class.php index 606a6640995..ce35998f647 100644 --- a/htdocs/core/class/infobox.class.php +++ b/htdocs/core/class/infobox.class.php @@ -219,7 +219,7 @@ class InfoBox * @param int $zone Name of area (0 for Homepage, ...) * @param string $boxorder List of boxes with correct order 'A:123,456,...-B:789,321...' * @param int $userid Id of user - * @return int <0 if KO, 0=Nothing done, > 0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, > 0 if OK */ public static function saveboxorder($dbs, $zone, $boxorder, $userid = 0) { diff --git a/htdocs/core/class/ldap.class.php b/htdocs/core/class/ldap.class.php index 1bcb9f9d935..6616e5df5ea 100644 --- a/htdocs/core/class/ldap.class.php +++ b/htdocs/core/class/ldap.class.php @@ -260,7 +260,7 @@ class Ldap * Use this->server, this->serverPort, this->ldapProtocolVersion, this->serverType, this->searchUser, this->searchPassword * After return, this->connection and $this->bind are defined * - * @return int <0 if KO, 1 if bind anonymous, 2 if bind auth + * @return int Return integer <0 if KO, 1 if bind anonymous, 2 if bind auth */ public function connect_bind() { @@ -1007,7 +1007,7 @@ class Ldap * * @param string $dn DN entry key * @param string $filter Filter - * @return int|array <0 or false if KO, array if OK + * @return int|array Return integer <0 or false if KO, array if OK */ public function getAttribute($dn, $filter) { diff --git a/htdocs/core/class/link.class.php b/htdocs/core/class/link.class.php index 239c527ec53..bcf8d437fae 100644 --- a/htdocs/core/class/link.class.php +++ b/htdocs/core/class/link.class.php @@ -147,7 +147,7 @@ class Link extends CommonObject * * @param User $user User executing update * @param int $call_trigger 0=no, 1=yes - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function update($user = '', $call_trigger = 1) { @@ -346,7 +346,7 @@ class Link extends CommonObject * Delete a link from database * * @param User $user Object suer - * @return int <0 if KO, 0 if nothing done, >0 if OK + * @return int Return integer <0 if KO, 0 if nothing done, >0 if OK */ public function delete($user) { diff --git a/htdocs/core/class/menubase.class.php b/htdocs/core/class/menubase.class.php index fd010ed944e..08d110637cd 100644 --- a/htdocs/core/class/menubase.class.php +++ b/htdocs/core/class/menubase.class.php @@ -179,7 +179,7 @@ class Menubase * Create menu entry into database * * @param User $user User that create - * @return int <0 if KO, Id of record if OK + * @return int Return integer <0 if KO, Id of record if OK */ public function create($user = null) { diff --git a/htdocs/core/class/notify.class.php b/htdocs/core/class/notify.class.php index 1223c4c60c2..e60bd5919ff 100644 --- a/htdocs/core/class/notify.class.php +++ b/htdocs/core/class/notify.class.php @@ -188,7 +188,7 @@ class Notify * @param Object $object Object the notification is about (need it to check threshold value of some notifications) * @param int $userid Id of user or 0 for all users or -1 for no users * @param array $scope Scope where to search - * @return array|int <0 if KO, array of notifications to send if OK + * @return array|int Return integer <0 if KO, array of notifications to send if OK */ public function getNotificationsArray($notifcode, $socid = 0, $object = null, $userid = 0, $scope = array('thirdparty', 'user', 'global')) { @@ -352,7 +352,7 @@ class Notify * @param array $filename_list List of files to attach (full path of filename on file system) * @param array $mimetype_list List of MIME type of attached files * @param array $mimefilename_list List of attached file name in message - * @return int <0 if KO, or number of changes if OK + * @return int Return integer <0 if KO, or number of changes if OK */ public function send($notifcode, $object, $filename_list = array(), $mimetype_list = array(), $mimefilename_list = array()) { diff --git a/htdocs/core/class/timespent.class.php b/htdocs/core/class/timespent.class.php index 325ef75f14c..a820be9e668 100644 --- a/htdocs/core/class/timespent.class.php +++ b/htdocs/core/class/timespent.class.php @@ -448,7 +448,7 @@ class TimeSpent extends CommonObject * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function validate($user, $notrigger = 0) { @@ -605,7 +605,7 @@ class TimeSpent extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancel($user, $notrigger = 0) { @@ -629,7 +629,7 @@ class TimeSpent extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { diff --git a/htdocs/core/class/translate.class.php b/htdocs/core/class/translate.class.php index 3104dddcfbf..3a3849f296f 100644 --- a/htdocs/core/class/translate.class.php +++ b/htdocs/core/class/translate.class.php @@ -166,7 +166,7 @@ class Translate * Load translation files. * * @param array $domains Array of lang files to load - * @return int <0 if KO, 0 if already loaded or loading not required, >0 if OK + * @return int Return integer <0 if KO, 0 if already loaded or loading not required, >0 if OK */ public function loadLangs($domains) { @@ -200,7 +200,7 @@ class Translate * @param int $forcelangdir To force a different lang directory * @param int $loadfromfileonly 1=Do not load overwritten translation from file or old conf. * @param int $forceloadifalreadynotfound Force attempt to reload lang file if it was previously not found - * @return int <0 if KO, 0 if already loaded or loading not required, >0 if OK + * @return int Return integer <0 if KO, 0 if already loaded or loading not required, >0 if OK * @see loadLangs() */ public function load($domain, $alt = 0, $stopafterdirection = 0, $forcelangdir = '', $loadfromfileonly = 0, $forceloadifalreadynotfound = 0) @@ -432,7 +432,7 @@ class Translate * Value for hash are: 1:Loaded from disk, 2:Not found, 3:Loaded from cache * * @param DoliDB $db Database handler - * @return int <0 if KO, 0 if already loaded or loading not required, >0 if OK + * @return int Return integer <0 if KO, 0 if already loaded or loading not required, >0 if OK */ public function loadFromDatabase($db) { diff --git a/htdocs/core/db/Database.interface.php b/htdocs/core/db/Database.interface.php index 8e320c0e6eb..646e9ed4457 100644 --- a/htdocs/core/db/Database.interface.php +++ b/htdocs/core/db/Database.interface.php @@ -332,7 +332,7 @@ interface Database * @param array $unique_keys Associative array Name of fields that will be unique key => value * @param array $fulltext_keys Field name table that will be indexed in fulltext * @param array $keys Table of key fields names => value - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function DDLCreateTable($table, $fields, $primary_key, $type, $unique_keys = null, $fulltext_keys = null, $keys = null); // phpcs:enable @@ -342,7 +342,7 @@ interface Database * Drop a table into database * * @param string $table Name of table - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function DDLDropTable($table); // phpcs:enable @@ -430,7 +430,7 @@ interface Database * @param string $dolibarr_main_db_user Username to create * @param string $dolibarr_main_db_pass User password to create * @param string $dolibarr_main_db_name Database name where user must be granted - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function DDLCreateUser( $dolibarr_main_db_host, diff --git a/htdocs/core/db/mysqli.class.php b/htdocs/core/db/mysqli.class.php index d7e3e352b03..6d1a43c7908 100644 --- a/htdocs/core/db/mysqli.class.php +++ b/htdocs/core/db/mysqli.class.php @@ -802,7 +802,7 @@ class DoliDBMysqli extends DoliDB * @param array $unique_keys Tableau associatifs Nom de champs qui seront clef unique => valeur * @param array $fulltext_keys Tableau des Nom de champs qui seront indexes en fulltext * @param array $keys Tableau des champs cles noms => valeur - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function DDLCreateTable($table, $fields, $primary_key, $type, $unique_keys = null, $fulltext_keys = null, $keys = null) { @@ -883,7 +883,7 @@ class DoliDBMysqli extends DoliDB * Drop a table into database * * @param string $table Name of table - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function DDLDropTable($table) { @@ -1040,7 +1040,7 @@ class DoliDBMysqli extends DoliDB * @param string $dolibarr_main_db_user Nom user a creer * @param string $dolibarr_main_db_pass Mot de passe user a creer * @param string $dolibarr_main_db_name Database name where user must be granted - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function DDLCreateUser($dolibarr_main_db_host, $dolibarr_main_db_user, $dolibarr_main_db_pass, $dolibarr_main_db_name) { diff --git a/htdocs/core/db/pgsql.class.php b/htdocs/core/db/pgsql.class.php index 828e06d391a..cce8d21610a 100644 --- a/htdocs/core/db/pgsql.class.php +++ b/htdocs/core/db/pgsql.class.php @@ -1062,7 +1062,7 @@ class DoliDBPgsql extends DoliDB * @param array $unique_keys Tableau associatifs Nom de champs qui seront clef unique => valeur * @param array $fulltext_keys Tableau des Nom de champs qui seront indexes en fulltext * @param array $keys Tableau des champs cles noms => valeur - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function DDLCreateTable($table, $fields, $primary_key, $type, $unique_keys = null, $fulltext_keys = null, $keys = null) { @@ -1136,7 +1136,7 @@ class DoliDBPgsql extends DoliDB * Drop a table into database * * @param string $table Name of table - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function DDLDropTable($table) { @@ -1160,7 +1160,7 @@ class DoliDBPgsql extends DoliDB * @param string $dolibarr_main_db_user Name of user to create * @param string $dolibarr_main_db_pass Password of user to create * @param string $dolibarr_main_db_name Database name where user must be granted - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function DDLCreateUser($dolibarr_main_db_host, $dolibarr_main_db_user, $dolibarr_main_db_pass, $dolibarr_main_db_name) { diff --git a/htdocs/core/db/sqlite3.class.php b/htdocs/core/db/sqlite3.class.php index 8d7d8e2f37a..41c1c021525 100644 --- a/htdocs/core/db/sqlite3.class.php +++ b/htdocs/core/db/sqlite3.class.php @@ -964,7 +964,7 @@ class DoliDBSqlite3 extends DoliDB * @param array $unique_keys Tableau associatifs Nom de champs qui seront clef unique => valeur * @param array $fulltext_keys Tableau des Nom de champs qui seront indexes en fulltext * @param array $keys Tableau des champs cles noms => valeur - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function DDLCreateTable($table, $fields, $primary_key, $type, $unique_keys = null, $fulltext_keys = null, $keys = null) { @@ -1037,7 +1037,7 @@ class DoliDBSqlite3 extends DoliDB * Drop a table into database * * @param string $table Name of table - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function DDLDropTable($table) { @@ -1173,7 +1173,7 @@ class DoliDBSqlite3 extends DoliDB * @param string $dolibarr_main_db_user Nom user a creer * @param string $dolibarr_main_db_pass Mot de passe user a creer * @param string $dolibarr_main_db_name Database name where user must be granted - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function DDLCreateUser($dolibarr_main_db_host, $dolibarr_main_db_user, $dolibarr_main_db_pass, $dolibarr_main_db_name) { diff --git a/htdocs/core/lib/admin.lib.php b/htdocs/core/lib/admin.lib.php index 861f5208f5e..d8d1b8428f6 100644 --- a/htdocs/core/lib/admin.lib.php +++ b/htdocs/core/lib/admin.lib.php @@ -164,7 +164,7 @@ function versiondolibarrarray() * @param int $colspan 2=Add a colspan=2 on td * @param int $onlysqltoimportwebsite Only sql resquests used to import a website template are allowed * @param string $database Database (replace __DATABASE__ with this value) - * @return int <=0 if KO, >0 if OK + * @return int Return integer <=0 if KO, >0 if OK */ function run_sql($sqlfile, $silent = 1, $entity = 0, $usesavepoint = 1, $handler = '', $okerror = 'default', $linelengthlimit = 32768, $nocommentremoval = 0, $offsetforchartofaccount = 0, $colspan = 0, $onlysqltoimportwebsite = 0, $database = '') { diff --git a/htdocs/core/lib/files.lib.php b/htdocs/core/lib/files.lib.php index aff76b1ac9e..84ee2d029c1 100644 --- a/htdocs/core/lib/files.lib.php +++ b/htdocs/core/lib/files.lib.php @@ -550,7 +550,7 @@ function dol_dir_is_emtpy($folder) * Count number of lines in a file * * @param string $file Filename - * @return int <0 if KO, Number of lines in files if OK + * @return int Return integer <0 if KO, Number of lines in files if OK * @see dol_nboflines() */ function dol_count_nb_of_line($file) @@ -623,7 +623,7 @@ function dol_fileperm($pathoffile) * @param int $newmask Mask for new file (0 by default means $conf->global->MAIN_UMASK). Example: '0666' * @param int $indexdatabase 1=index new file into database. * @param int $arrayreplacementisregex 1=Array of replacement is regex - * @return int <0 if error, 0 if nothing done (dest file already exists), >0 if OK + * @return int Return integer <0 if error, 0 if nothing done (dest file already exists), >0 if OK * @see dol_copy() */ function dolReplaceInFile($srcfile, $arrayreplacement, $destfile = '', $newmask = 0, $indexdatabase = 0, $arrayreplacementisregex = 0) @@ -711,7 +711,7 @@ function dolReplaceInFile($srcfile, $arrayreplacement, $destfile = '', $newmask * @param int $overwriteifexists Overwrite file if exists (1 by default) * @param int $testvirus Do an antivirus test. Move is canceled if a virus is found. * @param int $indexdatabase Index new file into database. - * @return int <0 if error, 0 if nothing done (dest file already exists and overwriteifexists=0), >0 if OK + * @return int Return integer <0 if error, 0 if nothing done (dest file already exists and overwriteifexists=0), >0 if OK * @see dol_delete_file() dolCopyDir() */ function dol_copy($srcfile, $destfile, $newmask = 0, $overwriteifexists = 1, $testvirus = 0, $indexdatabase = 0) @@ -839,7 +839,7 @@ function dol_copy($srcfile, $destfile, $newmask = 0, $overwriteifexists = 1, $te * @param array $arrayreplacement Array to use to replace filenames with another one during the copy (works only on file names, not on directory names). * @param int $excludesubdir 0=Do not exclude subdirectories, 1=Exclude subdirectories, 2=Exclude subdirectories if name is not a 2 chars (used for country codes subdirectories). * @param array $excludefileext Exclude some file extensions - * @return int <0 if error, 0 if nothing done (all files already exists and overwriteifexists=0), >0 if OK + * @return int Return integer <0 if error, 0 if nothing done (all files already exists and overwriteifexists=0), >0 if OK * @see dol_copy() */ function dolCopyDir($srcfile, $destfile, $newmask, $overwriteifexists, $arrayreplacement = null, $excludesubdir = 0, $excludefileext = null) @@ -1755,7 +1755,7 @@ function dol_init_file_process($pathtoscan = '', $trackid = '') * @param string $trackid Track id (used to prefix name of session vars to avoid conflict) * @param int $generatethumbs 1=Generate also thumbs for uploaded image files * @param Object $object Object used to set 'src_object_*' fields - * @return int <=0 if KO, >0 if OK + * @return int Return integer <=0 if KO, >0 if OK * @see dol_remove_file_process() */ function dol_add_file_process($upload_dir, $allowoverwrite = 0, $donotupdatesession = 0, $varfiles = 'addedfile', $savingdocmask = '', $link = null, $trackid = '', $generatethumbs = 1, $object = null) @@ -1991,7 +1991,7 @@ function dol_remove_file_process($filenb, $donotupdatesession = 0, $donotdeletef * @param string $mode How file was created ('uploaded', 'generated', ...) * @param int $setsharekey Set also the share key * @param Object $object Object used to set 'src_object_*' fields - * @return int <0 if KO, 0 if nothing done, >0 if OK + * @return int Return integer <0 if KO, 0 if nothing done, >0 if OK */ function addFileIntoDatabaseIndex($dir, $file, $fullpathorig = '', $mode = 'uploaded', $setsharekey = 0, $object = null) { @@ -2056,7 +2056,7 @@ function addFileIntoDatabaseIndex($dir, $file, $fullpathorig = '', $mode = 'uplo * @param string $dir Directory name (full real path without ending /) * @param string $file File name * @param string $mode How file was created ('uploaded', 'generated', ...) - * @return int <0 if KO, 0 if nothing done, >0 if OK + * @return int Return integer <0 if KO, 0 if nothing done, >0 if OK */ function deleteFilesIntoDatabaseIndex($dir, $file, $mode = 'uploaded') { @@ -2114,7 +2114,7 @@ function deleteFilesIntoDatabaseIndex($dir, $file, $mode = 'uploaded') * @param string $ext Format of target file (It is also extension added to file if fileoutput is not provided). * @param string $fileoutput Output filename * @param string $page Page number if we convert a PDF into png - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK * @see dol_imageResizeOrCrop() */ function dol_convert_file($fileinput, $ext = 'png', $fileoutput = '', $page = '') diff --git a/htdocs/core/lib/functions.lib.php b/htdocs/core/lib/functions.lib.php index a5f519375b3..b7a9e15516d 100644 --- a/htdocs/core/lib/functions.lib.php +++ b/htdocs/core/lib/functions.lib.php @@ -6753,7 +6753,7 @@ function get_product_vat_for_country($idprod, $thirdpartytouse, $idprodfournpric * @param int $idprod Id of product * @param int $local 1 for localtax1, 2 for localtax 2 * @param Societe $thirdpartytouse Thirdparty with a ->country_code defined (FR, US, IT, ...) - * @return int <0 if KO, Vat rate if OK + * @return int Return integer <0 if KO, Vat rate if OK * @see get_product_vat_for_country() */ function get_product_localtax_for_country($idprod, $local, $thirdpartytouse) @@ -7138,7 +7138,7 @@ function get_exdir($num, $level, $alpha, $withoutslash, $object, $modulepart = ' * @param string $dir Directory to create (Separator must be '/'. Example: '/mydir/mysubdir') * @param string $dataroot Data root directory (To avoid having the data root in the loop. Using this will also lost the warning, on first dir, saying PHP has no permission when open_basedir is used) * @param string $newmask Mask for new file (Defaults to $conf->global->MAIN_UMASK or 0755 if unavailable). Example: '0444' - * @return int < 0 if KO, 0 = already exists, > 0 if OK + * @return int Return integer < 0 if KO, 0 = already exists, > 0 if OK */ function dol_mkdir($dir, $dataroot = '', $newmask = '') { @@ -9441,7 +9441,7 @@ function dol_osencode($str) * @param string $fieldid Field to get * @param int $entityfilter Filter by entity * @param string $filters Filters to add. WARNING: string must be escaped for SQL and not coming from user input. - * @return int <0 if KO, Id of code if OK + * @return int Return integer <0 if KO, Id of code if OK * @see $langs->getLabelFromKey */ function dol_getIdFromCode($db, $key, $tablename, $fieldkey = 'code', $fieldid = 'id', $entityfilter = 0, $filters = '') diff --git a/htdocs/core/lib/functions2.lib.php b/htdocs/core/lib/functions2.lib.php index f102ecdd14b..6f990d893dd 100644 --- a/htdocs/core/lib/functions2.lib.php +++ b/htdocs/core/lib/functions2.lib.php @@ -1503,7 +1503,7 @@ function get_string_between($string, $start, $end) * * @param string $mask Mask to use * @param string $value Value - * @return int|string <0 or error string if KO, 0 if OK + * @return int|string Return integer <0 or error string if KO, 0 if OK */ function check_value($mask, $value) { diff --git a/htdocs/core/lib/memory.lib.php b/htdocs/core/lib/memory.lib.php index 379fb844077..4ea746feb26 100644 --- a/htdocs/core/lib/memory.lib.php +++ b/htdocs/core/lib/memory.lib.php @@ -62,7 +62,7 @@ $shmoffset = 1000; // Max number of entries found into a language file. If too l * @param string $memoryid Memory id of shared area * @param mixed $data Data to save. It must not be a null value. * @param int $expire ttl in seconds, 0 never expire - * @return int <0 if KO, 0 if nothing is done, Nb of bytes written if OK + * @return int Return integer <0 if KO, 0 if nothing is done, Nb of bytes written if OK * @see dol_getcache() */ function dol_setcache($memoryid, $data, $expire = 0) @@ -134,7 +134,7 @@ function dol_setcache($memoryid, $data, $expire = 0) * Read a memory area shared by all users, all sessions on server * * @param string $memoryid Memory id of shared area - * @return int|mixed <0 if KO, data if OK, null if not found into cache or no caching feature enabled + * @return int|mixed Return integer <0 if KO, data if OK, null if not found into cache or no caching feature enabled * @see dol_setcache() */ function dol_getcache($memoryid) @@ -214,7 +214,7 @@ function dol_getcache($memoryid) * Return shared memory address used to store dataset with key memoryid * * @param string $memoryid Memory id of shared area ('main', 'agenda', ...) - * @return int <0 if KO, Memoy address of shared memory for key + * @return int Return integer <0 if KO, Memoy address of shared memory for key */ function dol_getshmopaddress($memoryid) { @@ -250,7 +250,7 @@ function dol_listshmop() * @param int $memoryid Memory id of shared area ('main', 'agenda', ...) * @param string $data Data to save. Must be a not null value. * @param int $expire ttl in seconds, 0 never expire - * @return int <0 if KO, 0=Caching not available, Nb of bytes written if OK + * @return int Return integer <0 if KO, 0=Caching not available, Nb of bytes written if OK */ function dol_setshmop($memoryid, $data, $expire) { @@ -287,7 +287,7 @@ function dol_setshmop($memoryid, $data, $expire) * Read a memory area shared by all users, all sessions on server * * @param string $memoryid Memory id of shared area ('main', 'agenda', ...) - * @return int <0 if KO, data if OK, Null if no cache enabled or not found + * @return int Return integer <0 if KO, data if OK, Null if no cache enabled or not found */ function dol_getshmop($memoryid) { diff --git a/htdocs/core/lib/modulebuilder.lib.php b/htdocs/core/lib/modulebuilder.lib.php index bd07f0d745a..47ff2aa6f74 100644 --- a/htdocs/core/lib/modulebuilder.lib.php +++ b/htdocs/core/lib/modulebuilder.lib.php @@ -32,7 +32,7 @@ * @param string $readdir Directory source (use $destdir when not defined) * @param string $addfieldentry Array of 1 field entry to add array('key'=>,'type'=>,''label'=>,'visible'=>,'enabled'=>,'position'=>,'notnull'=>','index'=>,'searchall'=>,'comment'=>,'help'=>,'isameasure') * @param string $delfieldentry Id of field to remove - * @return int|object <=0 if KO, Object if OK + * @return int|object Return integer <=0 if KO, Object if OK * @see rebuildObjectSql() */ function rebuildObjectClass($destdir, $module, $objectname, $newmask, $readdir = '', $addfieldentry = array(), $delfieldentry = '') @@ -250,7 +250,7 @@ function rebuildObjectClass($destdir, $module, $objectname, $newmask, $readdir = * @param string $readdir Directory source (use $destdir when not defined) * @param Object $object If object was already loaded/known, it is pass to avoid another include and new. * @param string $moduletype 'external' or 'internal' - * @return int <=0 if KO, >0 if OK + * @return int Return integer <=0 if KO, >0 if OK * @see rebuildObjectClass() */ function rebuildObjectSql($destdir, $module, $objectname, $newmask, $readdir = '', $object = null, $moduletype = 'external') @@ -429,7 +429,7 @@ function rebuildObjectSql($destdir, $module, $objectname, $newmask, $readdir = ' * Get list of existing objects from directory * * @param string $destdir Directory - * @return array|int <=0 if KO, array if OK + * @return array|int Return integer <=0 if KO, array if OK */ function dolGetListOfObjectClasses($destdir) { diff --git a/htdocs/core/lib/xcal.lib.php b/htdocs/core/lib/xcal.lib.php index bddcce12d72..4ea8fffb327 100644 --- a/htdocs/core/lib/xcal.lib.php +++ b/htdocs/core/lib/xcal.lib.php @@ -30,7 +30,7 @@ * @param string $desc Description of export * @param array $events_array Array of events ("uid","startdate","duration","enddate","title","summary","category","email","url","desc","author") * @param string $outputfile Output file - * @return int < 0 if KO, Nb of events in file if OK + * @return int Return integer < 0 if KO, Nb of events in file if OK */ function build_calfile($format, $title, $desc, $events_array, $outputfile) { @@ -320,7 +320,7 @@ function build_calfile($format, $title, $desc, $events_array, $outputfile) * @param string $filter (optional) Filter * @param string $url Url (If empty, forge URL for agenda RSS export) * @param string $langcode Language code to show in header - * @return int < 0 if KO, Nb of events in file if OK + * @return int Return integer < 0 if KO, Nb of events in file if OK */ function build_rssfile($format, $title, $desc, $events_array, $outputfile, $filter = '', $url = '', $langcode = '') { diff --git a/htdocs/core/modules/DolibarrModules.class.php b/htdocs/core/modules/DolibarrModules.class.php index 2104cd7d5d4..13ff885a2d0 100644 --- a/htdocs/core/modules/DolibarrModules.class.php +++ b/htdocs/core/modules/DolibarrModules.class.php @@ -1121,7 +1121,7 @@ class DolibarrModules // Can not be abstract, because we need to instantiate it * * @param string $reldir Relative directory where to scan files. Example: '/install/mysql/' or '/module/sql/' * @param string $onlywithsuffix Only with the defined suffix - * @return int <=0 if KO, >0 if OK + * @return int Return integer <=0 if KO, >0 if OK */ protected function _load_tables($reldir, $onlywithsuffix = '') { @@ -1801,7 +1801,7 @@ class DolibarrModules // Can not be abstract, because we need to instantiate it /** * Removes constants tagged 'deleteonunactive' * - * @return int <0 if KO, 0 if OK + * @return int Return integer <0 if KO, 0 if OK */ public function delete_const() { @@ -2506,7 +2506,7 @@ class DolibarrModules // Can not be abstract, because we need to instantiate it * TODO : store results for $this->url_last_version and $this->needUpdate * Add a cron task to monitor for updates * - * @return int <0 if Error, 0 == no update needed, >0 if need update + * @return int Return integer <0 if Error, 0 == no update needed, >0 if need update */ public function checkForUpdate() { diff --git a/htdocs/core/modules/expedition/doc/pdf_espadon.modules.php b/htdocs/core/modules/expedition/doc/pdf_espadon.modules.php index dfbbea1039b..51426d677f3 100644 --- a/htdocs/core/modules/expedition/doc/pdf_espadon.modules.php +++ b/htdocs/core/modules/expedition/doc/pdf_espadon.modules.php @@ -934,7 +934,7 @@ class pdf_espadon extends ModelePdfExpedition * @param Expedition $object Object to show * @param int $showaddress 0=no, 1=yes * @param Translate $outputlangs Object lang for output - * @return int <0 if KO, > if OK + * @return int Return integer <0 if KO, > if OK */ protected function _pagehead(&$pdf, $object, $showaddress, $outputlangs) { diff --git a/htdocs/core/modules/expedition/doc/pdf_merou.modules.php b/htdocs/core/modules/expedition/doc/pdf_merou.modules.php index eab2e6cc05e..a4d790f2285 100644 --- a/htdocs/core/modules/expedition/doc/pdf_merou.modules.php +++ b/htdocs/core/modules/expedition/doc/pdf_merou.modules.php @@ -475,7 +475,7 @@ class pdf_merou extends ModelePdfExpedition * @param Expedition $object Object to show * @param int $showaddress 0=no, 1=yes * @param Translate $outputlangs Object lang for output - * @return int <0 if KO, > if OK + * @return int Return integer <0 if KO, > if OK */ protected function _pagehead(&$pdf, $object, $showaddress, $outputlangs) { diff --git a/htdocs/core/modules/expedition/doc/pdf_rouget.modules.php b/htdocs/core/modules/expedition/doc/pdf_rouget.modules.php index 6fad9c974d8..9258a1fb58c 100644 --- a/htdocs/core/modules/expedition/doc/pdf_rouget.modules.php +++ b/htdocs/core/modules/expedition/doc/pdf_rouget.modules.php @@ -844,7 +844,7 @@ class pdf_rouget extends ModelePdfExpedition * @param Expedition $object Object to show * @param int $showaddress 0=no, 1=yes * @param Translate $outputlangs Object lang for output - * @return int <0 if KO, > if OK + * @return int Return integer <0 if KO, > if OK */ protected function _pagehead(&$pdf, $object, $showaddress, $outputlangs) { diff --git a/htdocs/core/modules/export/export_excel2007.modules.php b/htdocs/core/modules/export/export_excel2007.modules.php index 8540334123e..e1a71e312a8 100644 --- a/htdocs/core/modules/export/export_excel2007.modules.php +++ b/htdocs/core/modules/export/export_excel2007.modules.php @@ -175,7 +175,7 @@ class ExportExcel2007 extends ModeleExports * * @param string $file File name to generate * @param Translate $outputlangs Output language object - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function open_file($file, $outputlangs) { diff --git a/htdocs/core/modules/export/export_tsv.modules.php b/htdocs/core/modules/export/export_tsv.modules.php index e0338d44d32..fa90f362c06 100644 --- a/htdocs/core/modules/export/export_tsv.modules.php +++ b/htdocs/core/modules/export/export_tsv.modules.php @@ -156,7 +156,7 @@ class ExportTsv extends ModeleExports * * @param string $file Path of filename to generate * @param Translate $outputlangs Output language object - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function open_file($file, $outputlangs) { diff --git a/htdocs/core/modules/export/exportcsv.class.php b/htdocs/core/modules/export/exportcsv.class.php index 794c9ac0391..75add987729 100644 --- a/htdocs/core/modules/export/exportcsv.class.php +++ b/htdocs/core/modules/export/exportcsv.class.php @@ -134,7 +134,7 @@ class ExportCsv extends ModeleExports * * @param string $file Path of filename to generate * @param Translate $outputlangs Output language object - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function open_file($file, $outputlangs) { diff --git a/htdocs/core/modules/import/import_csv.modules.php b/htdocs/core/modules/import/import_csv.modules.php index 19433eee66e..13cef0093b4 100644 --- a/htdocs/core/modules/import/import_csv.modules.php +++ b/htdocs/core/modules/import/import_csv.modules.php @@ -176,7 +176,7 @@ class ImportCsv extends ModeleImports * Open input file * * @param string $file Path of filename - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function import_open_file($file) { @@ -206,7 +206,7 @@ class ImportCsv extends ModeleImports * Return nb of records. File must be closed. * * @param string $file Path of filename - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function import_get_nb_of_lines($file) { @@ -219,7 +219,7 @@ class ImportCsv extends ModeleImports /** * Input header line from file * - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function import_read_header() { diff --git a/htdocs/core/modules/import/import_xlsx.modules.php b/htdocs/core/modules/import/import_xlsx.modules.php index e67c37992ab..14e4b561eae 100644 --- a/htdocs/core/modules/import/import_xlsx.modules.php +++ b/htdocs/core/modules/import/import_xlsx.modules.php @@ -228,7 +228,7 @@ class ImportXlsx extends ModeleImports * Open input file * * @param string $file Path of filename - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function import_open_file($file) { @@ -252,7 +252,7 @@ class ImportXlsx extends ModeleImports * Return nb of records. File must be closed. * * @param string $file Path of filename - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function import_get_nb_of_lines($file) { @@ -273,7 +273,7 @@ class ImportXlsx extends ModeleImports /** * Input header line from file * - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function import_read_header() { diff --git a/htdocs/core/modules/mailings/advthirdparties.modules.php b/htdocs/core/modules/mailings/advthirdparties.modules.php index 7a40e1cdbda..9017e81aa14 100644 --- a/htdocs/core/modules/mailings/advthirdparties.modules.php +++ b/htdocs/core/modules/mailings/advthirdparties.modules.php @@ -59,7 +59,7 @@ class mailing_advthirdparties extends MailingTargets * @param array $socid Array of id soc to add * @param int $type_of_target Defined in advtargetemailing.class.php * @param array $contactid Array of contact id to add - * @return int <0 if error, number of emails added if ok + * @return int Return integer <0 if error, number of emails added if ok */ public function add_to_target_spec($mailing_id, $socid, $type_of_target, $contactid) { diff --git a/htdocs/core/modules/mailings/contacts1.modules.php b/htdocs/core/modules/mailings/contacts1.modules.php index 958a6e10eda..83059884b80 100644 --- a/htdocs/core/modules/mailings/contacts1.modules.php +++ b/htdocs/core/modules/mailings/contacts1.modules.php @@ -333,7 +333,7 @@ class mailing_contacts1 extends MailingTargets * Add some recipients into target table * * @param int $mailing_id Id of emailing - * @return int <0 si erreur, nb ajout si ok + * @return int Return integer <0 si erreur, nb ajout si ok */ public function add_to_target($mailing_id) { diff --git a/htdocs/core/modules/mailings/eventorganization.modules.php b/htdocs/core/modules/mailings/eventorganization.modules.php index cf63d029d8d..c2a2c0d3c8d 100644 --- a/htdocs/core/modules/mailings/eventorganization.modules.php +++ b/htdocs/core/modules/mailings/eventorganization.modules.php @@ -61,7 +61,7 @@ class mailing_eventorganization extends MailingTargets * This is the main function that returns the array of emails * * @param int $mailing_id Id of mailing. No need to use it. - * @return int <0 if error, number of emails added if ok + * @return int Return integer <0 if error, number of emails added if ok */ public function add_to_target($mailing_id) { diff --git a/htdocs/core/modules/mailings/fraise.modules.php b/htdocs/core/modules/mailings/fraise.modules.php index aa8f0f5859a..1ffd718a44f 100644 --- a/htdocs/core/modules/mailings/fraise.modules.php +++ b/htdocs/core/modules/mailings/fraise.modules.php @@ -228,7 +228,7 @@ class mailing_fraise extends MailingTargets * Ajoute destinataires dans table des cibles * * @param int $mailing_id Id of emailing - * @return int < 0 si erreur, nb ajout si ok + * @return int Return integer < 0 si erreur, nb ajout si ok */ public function add_to_target($mailing_id) { diff --git a/htdocs/core/modules/mailings/modules_mailings.php b/htdocs/core/modules/mailings/modules_mailings.php index 632e228ad69..c4e96bbf7ba 100644 --- a/htdocs/core/modules/mailings/modules_mailings.php +++ b/htdocs/core/modules/mailings/modules_mailings.php @@ -159,7 +159,7 @@ class MailingTargets // This can't be abstract as it is used for some method * Met a jour nombre de destinataires * * @param int $mailing_id Id of emailing - * @return int < 0 si erreur, nb destinataires si ok + * @return int Return integer < 0 si erreur, nb destinataires si ok */ public function update_nb($mailing_id) { @@ -190,7 +190,7 @@ class MailingTargets // This can't be abstract as it is used for some method * * @param int $mailing_id Id of emailing * @param array $cibles Array with targets - * @return int < 0 if error, nb added if OK + * @return int Return integer < 0 if error, nb added if OK */ public function addTargetsToDatabase($mailing_id, $cibles) { diff --git a/htdocs/core/modules/mailings/partnership.modules.php b/htdocs/core/modules/mailings/partnership.modules.php index 48fabd3b0fe..03d6a59dba8 100644 --- a/htdocs/core/modules/mailings/partnership.modules.php +++ b/htdocs/core/modules/mailings/partnership.modules.php @@ -61,7 +61,7 @@ class mailing_partnership extends MailingTargets * This is the main function that returns the array of emails * * @param int $mailing_id Id of mailing. No need to use it. - * @return int <0 if error, number of emails added if ok + * @return int Return integer <0 if error, number of emails added if ok */ public function add_to_target($mailing_id) { diff --git a/htdocs/core/modules/mailings/pomme.modules.php b/htdocs/core/modules/mailings/pomme.modules.php index cd93813cf68..25d4d8a4192 100644 --- a/htdocs/core/modules/mailings/pomme.modules.php +++ b/htdocs/core/modules/mailings/pomme.modules.php @@ -153,7 +153,7 @@ class mailing_pomme extends MailingTargets * Ajoute destinataires dans table des cibles * * @param int $mailing_id Id of emailing - * @return int < 0 si erreur, nb ajout si ok + * @return int Return integer < 0 si erreur, nb ajout si ok */ public function add_to_target($mailing_id) { diff --git a/htdocs/core/modules/mailings/thirdparties.modules.php b/htdocs/core/modules/mailings/thirdparties.modules.php index 54775dee58d..dcda0f2b0aa 100644 --- a/htdocs/core/modules/mailings/thirdparties.modules.php +++ b/htdocs/core/modules/mailings/thirdparties.modules.php @@ -58,7 +58,7 @@ class mailing_thirdparties extends MailingTargets * This is the main function that returns the array of emails * * @param int $mailing_id Id of mailing. No need to use it. - * @return int <0 if error, number of emails added if ok + * @return int Return integer <0 if error, number of emails added if ok */ public function add_to_target($mailing_id) { diff --git a/htdocs/core/modules/mailings/thirdparties_services_expired.modules.php b/htdocs/core/modules/mailings/thirdparties_services_expired.modules.php index 2484537d063..4d0ac4ea0bb 100644 --- a/htdocs/core/modules/mailings/thirdparties_services_expired.modules.php +++ b/htdocs/core/modules/mailings/thirdparties_services_expired.modules.php @@ -81,7 +81,7 @@ class mailing_thirdparties_services_expired extends MailingTargets * This is the main function that returns the array of emails * * @param int $mailing_id Id of mailing. No need to use it. - * @return int <0 if error, number of emails added if ok + * @return int Return integer <0 if error, number of emails added if ok */ public function add_to_target($mailing_id) { diff --git a/htdocs/core/modules/mailings/xinputfile.modules.php b/htdocs/core/modules/mailings/xinputfile.modules.php index 765a2d300f7..3fcbace468b 100644 --- a/htdocs/core/modules/mailings/xinputfile.modules.php +++ b/htdocs/core/modules/mailings/xinputfile.modules.php @@ -124,7 +124,7 @@ class mailing_xinputfile extends MailingTargets * Ajoute destinataires dans table des cibles * * @param int $mailing_id Id of emailing - * @return int < 0 si erreur, nb ajout si ok + * @return int Return integer < 0 si erreur, nb ajout si ok */ public function add_to_target($mailing_id) { diff --git a/htdocs/core/modules/mailings/xinputuser.modules.php b/htdocs/core/modules/mailings/xinputuser.modules.php index 74ed18ba91f..a141cb7881e 100644 --- a/htdocs/core/modules/mailings/xinputuser.modules.php +++ b/htdocs/core/modules/mailings/xinputuser.modules.php @@ -117,7 +117,7 @@ class mailing_xinputuser extends MailingTargets * Ajoute destinataires dans table des cibles * * @param int $mailing_id Id of emailing - * @return int < 0 si erreur, nb ajout si ok + * @return int Return integer < 0 si erreur, nb ajout si ok */ public function add_to_target($mailing_id) { diff --git a/htdocs/core/triggers/dolibarrtriggers.class.php b/htdocs/core/triggers/dolibarrtriggers.class.php index f20e275f306..4bc62369a31 100644 --- a/htdocs/core/triggers/dolibarrtriggers.class.php +++ b/htdocs/core/triggers/dolibarrtriggers.class.php @@ -167,7 +167,7 @@ abstract class DolibarrTriggers * @param User $user Object user * @param Translate $langs Object langs * @param conf $conf Object conf - * @return int <0 if KO, 0 if no triggered ran, >0 if OK + * @return int Return integer <0 if KO, 0 if no triggered ran, >0 if OK */ abstract public function runTrigger($action, $object, User $user, Translate $langs, Conf $conf); } diff --git a/htdocs/core/triggers/interface_20_modWorkflow_WorkflowManager.class.php b/htdocs/core/triggers/interface_20_modWorkflow_WorkflowManager.class.php index 76288ed1124..2684c28a4e7 100644 --- a/htdocs/core/triggers/interface_20_modWorkflow_WorkflowManager.class.php +++ b/htdocs/core/triggers/interface_20_modWorkflow_WorkflowManager.class.php @@ -60,7 +60,7 @@ class InterfaceWorkflowManager extends DolibarrTriggers * @param User $user Object user * @param Translate $langs Object langs * @param conf $conf Object conf - * @return int <0 if KO, 0 if no triggered ran, >0 if OK + * @return int Return integer <0 if KO, 0 if no triggered ran, >0 if OK */ public function runTrigger($action, $object, User $user, Translate $langs, Conf $conf) { diff --git a/htdocs/core/triggers/interface_50_modAgenda_ActionsAuto.class.php b/htdocs/core/triggers/interface_50_modAgenda_ActionsAuto.class.php index 8916e99ec3d..7c11e252f4b 100644 --- a/htdocs/core/triggers/interface_50_modAgenda_ActionsAuto.class.php +++ b/htdocs/core/triggers/interface_50_modAgenda_ActionsAuto.class.php @@ -73,7 +73,7 @@ class InterfaceActionsAuto extends DolibarrTriggers * @param User $user Object user * @param Translate $langs Object langs * @param conf $conf Object conf - * @return int <0 if KO, 0 if no triggered ran, >0 if OK + * @return int Return integer <0 if KO, 0 if no triggered ran, >0 if OK */ public function runTrigger($action, $object, User $user, Translate $langs, Conf $conf) { diff --git a/htdocs/core/triggers/interface_50_modBlockedlog_ActionsBlockedLog.class.php b/htdocs/core/triggers/interface_50_modBlockedlog_ActionsBlockedLog.class.php index 8e9c3f7e2bb..70923143d18 100644 --- a/htdocs/core/triggers/interface_50_modBlockedlog_ActionsBlockedLog.class.php +++ b/htdocs/core/triggers/interface_50_modBlockedlog_ActionsBlockedLog.class.php @@ -55,7 +55,7 @@ class InterfaceActionsBlockedLog extends DolibarrTriggers * @param User $user Object user * @param Translate $langs Object langs * @param conf $conf Object conf - * @return int <0 if KO, 0 if no triggered ran, >0 if OK + * @return int Return integer <0 if KO, 0 if no triggered ran, >0 if OK */ public function runTrigger($action, $object, User $user, Translate $langs, Conf $conf) { diff --git a/htdocs/core/triggers/interface_50_modEventOrganization_EventOrganization.class.php b/htdocs/core/triggers/interface_50_modEventOrganization_EventOrganization.class.php index 93ca0acbc3c..1c869b2d75e 100644 --- a/htdocs/core/triggers/interface_50_modEventOrganization_EventOrganization.class.php +++ b/htdocs/core/triggers/interface_50_modEventOrganization_EventOrganization.class.php @@ -67,7 +67,7 @@ class InterfaceEventOrganization extends DolibarrTriggers * @param User $user Object user * @param Translate $langs Object langs * @param conf $conf Object conf - * @return int <0 if KO, 0 if no triggered ran, >0 if OK + * @return int Return integer <0 if KO, 0 if no triggered ran, >0 if OK */ public function runTrigger($action, $object, User $user, Translate $langs, Conf $conf) { diff --git a/htdocs/core/triggers/interface_50_modLdap_Ldapsynchro.class.php b/htdocs/core/triggers/interface_50_modLdap_Ldapsynchro.class.php index d948c77865b..da7b37c3acf 100644 --- a/htdocs/core/triggers/interface_50_modLdap_Ldapsynchro.class.php +++ b/htdocs/core/triggers/interface_50_modLdap_Ldapsynchro.class.php @@ -57,7 +57,7 @@ class InterfaceLdapsynchro extends DolibarrTriggers * @param User $user Object user * @param Translate $langs Object langs * @param conf $conf Object conf - * @return int <0 if KO, 0 if no triggered ran, >0 if OK + * @return int Return integer <0 if KO, 0 if no triggered ran, >0 if OK */ public function runTrigger($action, $object, User $user, Translate $langs, Conf $conf) { diff --git a/htdocs/core/triggers/interface_50_modMailmanspip_Mailmanspipsynchro.class.php b/htdocs/core/triggers/interface_50_modMailmanspip_Mailmanspipsynchro.class.php index f8abd2e3539..fb161a16dbd 100644 --- a/htdocs/core/triggers/interface_50_modMailmanspip_Mailmanspipsynchro.class.php +++ b/htdocs/core/triggers/interface_50_modMailmanspip_Mailmanspipsynchro.class.php @@ -55,7 +55,7 @@ class InterfaceMailmanSpipsynchro extends DolibarrTriggers * @param User $user Object user * @param Translate $langs Object langs * @param conf $conf Object conf - * @return int <0 if KO, 0 if no triggered ran, >0 if OK + * @return int Return integer <0 if KO, 0 if no triggered ran, >0 if OK */ public function runTrigger($action, $object, User $user, Translate $langs, Conf $conf) { diff --git a/htdocs/core/triggers/interface_50_modNotification_Notification.class.php b/htdocs/core/triggers/interface_50_modNotification_Notification.class.php index ee78895f99b..99c2ee84bf1 100644 --- a/htdocs/core/triggers/interface_50_modNotification_Notification.class.php +++ b/htdocs/core/triggers/interface_50_modNotification_Notification.class.php @@ -62,7 +62,7 @@ class InterfaceNotification extends DolibarrTriggers * @param User $user Object user * @param Translate $langs Object langs * @param conf $conf Object conf - * @return int <0 if KO, 0 if no triggered ran, >0 if OK + * @return int Return integer <0 if KO, 0 if no triggered ran, >0 if OK */ public function runTrigger($action, $object, User $user, Translate $langs, Conf $conf) { diff --git a/htdocs/core/triggers/interface_50_modTicket_TicketEmail.class.php b/htdocs/core/triggers/interface_50_modTicket_TicketEmail.class.php index 364c94101c1..e5efd4f6b47 100644 --- a/htdocs/core/triggers/interface_50_modTicket_TicketEmail.class.php +++ b/htdocs/core/triggers/interface_50_modTicket_TicketEmail.class.php @@ -56,7 +56,7 @@ class InterfaceTicketEmail extends DolibarrTriggers * @param User $user Object user * @param Translate $langs Object langs * @param conf $conf Object conf - * @return int <0 if KO, 0 if no triggered ran, >0 if OK + * @return int Return integer <0 if KO, 0 if no triggered ran, >0 if OK */ public function runTrigger($action, $object, User $user, Translate $langs, Conf $conf) { diff --git a/htdocs/core/triggers/interface_80_modStripe_Stripe.class.php b/htdocs/core/triggers/interface_80_modStripe_Stripe.class.php index 9a1f68a9ca9..8b992b79022 100644 --- a/htdocs/core/triggers/interface_80_modStripe_Stripe.class.php +++ b/htdocs/core/triggers/interface_80_modStripe_Stripe.class.php @@ -61,7 +61,7 @@ class InterfaceStripe extends DolibarrTriggers * @param User $user Object user * @param Translate $langs Object langs * @param Conf $conf Object conf - * @return int <0 if KO, 0 if no triggered ran, >0 if OK + * @return int Return integer <0 if KO, 0 if no triggered ran, >0 if OK */ public function runTrigger($action, $object, User $user, Translate $langs, Conf $conf) { diff --git a/htdocs/core/triggers/interface_90_modSociete_ContactRoles.class.php b/htdocs/core/triggers/interface_90_modSociete_ContactRoles.class.php index 9505196dd49..7017d5cd721 100644 --- a/htdocs/core/triggers/interface_90_modSociete_ContactRoles.class.php +++ b/htdocs/core/triggers/interface_90_modSociete_ContactRoles.class.php @@ -63,7 +63,7 @@ class InterfaceContactRoles extends DolibarrTriggers * @param User $user Object user * @param Translate $langs Object langs * @param conf $conf Object conf - * @return int <0 if KO, 0 if no triggered ran, >0 if OK + * @return int Return integer <0 if KO, 0 if no triggered ran, >0 if OK */ public function runTrigger($action, $object, User $user, Translate $langs, Conf $conf) { diff --git a/htdocs/core/triggers/interface_95_modWebhook_WebhookTriggers.class.php b/htdocs/core/triggers/interface_95_modWebhook_WebhookTriggers.class.php index 3eb8a2ce076..c8b97488b5d 100644 --- a/htdocs/core/triggers/interface_95_modWebhook_WebhookTriggers.class.php +++ b/htdocs/core/triggers/interface_95_modWebhook_WebhookTriggers.class.php @@ -86,7 +86,7 @@ class InterfaceWebhookTriggers extends DolibarrTriggers * @param User $user Object user * @param Translate $langs Object langs * @param Conf $conf Object conf - * @return int <0 if KO, 0 if no triggered ran, >0 if OK + * @return int Return integer <0 if KO, 0 if no triggered ran, >0 if OK */ public function runTrigger($action, $object, User $user, Translate $langs, Conf $conf) { diff --git a/htdocs/core/triggers/interface_95_modZapier_ZapierTriggers.class.php b/htdocs/core/triggers/interface_95_modZapier_ZapierTriggers.class.php index 2b6208c025d..ea846616096 100644 --- a/htdocs/core/triggers/interface_95_modZapier_ZapierTriggers.class.php +++ b/htdocs/core/triggers/interface_95_modZapier_ZapierTriggers.class.php @@ -56,7 +56,7 @@ class InterfaceZapierTriggers extends DolibarrTriggers * @param User $user Object user * @param Translate $langs Object langs * @param Conf $conf Object conf - * @return int <0 if KO, 0 if no triggered ran, >0 if OK + * @return int Return integer <0 if KO, 0 if no triggered ran, >0 if OK */ public function runTrigger($action, $object, User $user, Translate $langs, Conf $conf) { diff --git a/htdocs/datapolicy/class/actions_datapolicy.class.php b/htdocs/datapolicy/class/actions_datapolicy.class.php index 22e23b1c05e..481c3b08d09 100644 --- a/htdocs/datapolicy/class/actions_datapolicy.class.php +++ b/htdocs/datapolicy/class/actions_datapolicy.class.php @@ -69,7 +69,7 @@ class ActionsDatapolicy extends CommonHookActions * @param array $parameters Array of parameters * @param CommonObject $object The object to process (an invoice if you are in invoice module, a propale in propale's module, etc...) * @param string $action 'add', 'update', 'view' - * @return int <0 if KO, + * @return int Return integer <0 if KO, * =0 if OK but we want to process standard actions too, * >0 if OK and we want to replace standard actions. */ @@ -87,7 +87,7 @@ class ActionsDatapolicy extends CommonHookActions * @param Societe|CommonObject $object The object to process (an invoice if you are in invoice module, a propale in propale's module, etc...) * @param string $action Current action (if set). Generally create or edit or null * @param HookManager $hookmanager Hook manager propagated to allow calling another hook - * @return int < 0 on error, 0 on success, 1 to replace standard code + * @return int Return integer < 0 on error, 0 on success, 1 to replace standard code */ public function doActions($parameters, &$object, &$action, $hookmanager) { diff --git a/htdocs/debugbar/class/TraceableDB.php b/htdocs/debugbar/class/TraceableDB.php index 8c4872fce24..9b40abdb668 100644 --- a/htdocs/debugbar/class/TraceableDB.php +++ b/htdocs/debugbar/class/TraceableDB.php @@ -500,7 +500,7 @@ class TraceableDB extends DoliDB * @param array $unique_keys Tableau associatifs Nom de champs qui seront clef unique => valeur * @param array $fulltext_keys Tableau des Nom de champs qui seront indexes en fulltext * @param array $keys Tableau des champs cles noms => valeur - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function DDLCreateTable($table, $fields, $primary_key, $type, $unique_keys = null, $fulltext_keys = null, $keys = null) { @@ -511,7 +511,7 @@ class TraceableDB extends DoliDB * Drop a table into database * * @param string $table Name of table - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function DDLDropTable($table) { @@ -616,7 +616,7 @@ class TraceableDB extends DoliDB * @param string $dolibarr_main_db_user Nom user a creer * @param string $dolibarr_main_db_pass Mot de passe user a creer * @param string $dolibarr_main_db_name Database name where user must be granted - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function DDLCreateUser($dolibarr_main_db_host, $dolibarr_main_db_user, $dolibarr_main_db_pass, $dolibarr_main_db_name) { diff --git a/htdocs/delivery/class/delivery.class.php b/htdocs/delivery/class/delivery.class.php index 8ae8af24eef..ab081fbfe30 100644 --- a/htdocs/delivery/class/delivery.class.php +++ b/htdocs/delivery/class/delivery.class.php @@ -144,7 +144,7 @@ class Delivery extends CommonObject * Create delivery receipt in database * * @param User $user Objet du user qui cree - * @return int <0 si erreur, id delivery cree si ok + * @return int Return integer <0 si erreur, id delivery cree si ok */ public function create($user) { @@ -548,7 +548,7 @@ class Delivery extends CommonObject * * @param User $user User who creates * @param int $sending_id Id of the expedition that serves as a model - * @return integer <=0 if KO, >0 if OK + * @return integer Return integer <=0 if KO, >0 if OK */ public function create_from_sending($user, $sending_id) { @@ -655,7 +655,7 @@ class Delivery extends CommonObject * Delete line * * @param int $lineid Line id - * @return integer <0 if KO, 0 if nothing done, >0 if OK + * @return integer Return integer <0 if KO, 0 if nothing done, >0 if OK */ public function deleteline($lineid) { diff --git a/htdocs/don/class/don.class.php b/htdocs/don/class/don.class.php index 7751feb2ed4..483a53465ee 100644 --- a/htdocs/don/class/don.class.php +++ b/htdocs/don/class/don.class.php @@ -364,7 +364,7 @@ class Don extends CommonObject * * @param User $user User who created the donation * @param int $notrigger Disable triggers - * @return int <0 if KO, id of created donation if OK + * @return int Return integer <0 if KO, id of created donation if OK * TODO add numbering module for Ref */ public function create($user, $notrigger = 0) @@ -572,7 +572,7 @@ class Don extends CommonObject * * @param User $user User * @param int $notrigger Disable triggers - * @return int <0 if KO, 0 if not possible, >0 if OK + * @return int Return integer <0 if KO, 0 if not possible, >0 if OK */ public function delete($user, $notrigger = 0) { @@ -830,7 +830,7 @@ class Don extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { @@ -1125,7 +1125,7 @@ class Don extends CommonObject /** * Function to get reamain to pay for a donation * - * @return int <0 if KO, > reamain to pay if OK + * @return int Return integer <0 if KO, > reamain to pay if OK */ public function getRemainToPay() { diff --git a/htdocs/don/class/paymentdonation.class.php b/htdocs/don/class/paymentdonation.class.php index f697ec63b65..f72c5783721 100644 --- a/htdocs/don/class/paymentdonation.class.php +++ b/htdocs/don/class/paymentdonation.class.php @@ -123,7 +123,7 @@ class PaymentDonation extends CommonObject * * @param User $user User making payment * @param bool $notrigger false=launch triggers after, true=disable triggers - * @return int <0 if KO, id of payment if OK + * @return int Return integer <0 if KO, id of payment if OK */ public function create($user, $notrigger = false) { diff --git a/htdocs/eventorganization/class/conferenceorbooth.class.php b/htdocs/eventorganization/class/conferenceorbooth.class.php index 84c17a2e637..738c39a10d0 100644 --- a/htdocs/eventorganization/class/conferenceorbooth.class.php +++ b/htdocs/eventorganization/class/conferenceorbooth.class.php @@ -382,7 +382,7 @@ class ConferenceOrBooth extends ActionComm * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function validate($user, $notrigger = 0) { @@ -468,7 +468,7 @@ class ConferenceOrBooth extends ActionComm * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancel($user, $notrigger = 0) { @@ -492,7 +492,7 @@ class ConferenceOrBooth extends ActionComm * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { diff --git a/htdocs/eventorganization/class/conferenceorboothattendee.class.php b/htdocs/eventorganization/class/conferenceorboothattendee.class.php index 33fb6b00657..e7230f91755 100644 --- a/htdocs/eventorganization/class/conferenceorboothattendee.class.php +++ b/htdocs/eventorganization/class/conferenceorboothattendee.class.php @@ -529,7 +529,7 @@ class ConferenceOrBoothAttendee extends CommonObject * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function validate($user, $notrigger = 0) { @@ -660,7 +660,7 @@ class ConferenceOrBoothAttendee extends CommonObject /** * Load the project with id $this->fk_project into this->project * - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function fetch_projet() { @@ -711,7 +711,7 @@ class ConferenceOrBoothAttendee extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancel($user, $notrigger = 0) { @@ -735,7 +735,7 @@ class ConferenceOrBoothAttendee extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { diff --git a/htdocs/expedition/class/expedition.class.php b/htdocs/expedition/class/expedition.class.php index ba8c7b9290e..08aec707687 100644 --- a/htdocs/expedition/class/expedition.class.php +++ b/htdocs/expedition/class/expedition.class.php @@ -334,7 +334,7 @@ class Expedition extends CommonObject * * @param User $user Objet du user qui cree * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <0 si erreur, id expedition creee si ok + * @return int Return integer <0 si erreur, id expedition creee si ok */ public function create($user, $notrigger = 0) { @@ -495,7 +495,7 @@ class Expedition extends CommonObject * @param int $qty Quantity * @param int $rang Rang * @param array $array_options extrafields array - * @return int <0 if KO, line_id if OK + * @return int Return integer <0 if KO, line_id if OK */ public function create_line($entrepot_id, $origin_line_id, $qty, $rang = 0, $array_options = null) { @@ -709,7 +709,7 @@ class Expedition extends CommonObject * * @param User $user Object user that validate * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <0 if OK, >0 if KO + * @return int Return integer <0 if OK, >0 if KO */ public function valid($user, $notrigger = 0) { @@ -859,7 +859,7 @@ class Expedition extends CommonObject * Create a delivery receipt from a shipment * * @param User $user User - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function create_delivery($user) { @@ -2019,7 +2019,7 @@ class Expedition extends CommonObject * * @param User $user Object user that modify * @param int $delivery_date Delivery date - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok * @deprecated Use setDeliveryDate */ public function set_date_livraison($user, $delivery_date) @@ -2324,7 +2324,7 @@ class Expedition extends CommonObject /** * Classify the shipping as invoiced (used for exemple by trigger when WORKFLOW_SHIPPING_CLASSIFY_BILLED_INVOICE is on) * - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok */ public function setBilled() { @@ -2380,7 +2380,7 @@ class Expedition extends CommonObject /** * Classify the shipping as validated/opened * - * @return int <0 if KO, 0 if already open, >0 if OK + * @return int Return integer <0 if KO, 0 if already open, >0 if OK */ public function reOpen() { @@ -2781,7 +2781,7 @@ class ExpeditionLigne extends CommonObjectLine * * @param User $user User that modify * @param int $notrigger 1 = disable triggers - * @return int <0 if KO, line id >0 if OK + * @return int Return integer <0 if KO, line id >0 if OK */ public function insert($user, $notrigger = 0) { @@ -2928,7 +2928,7 @@ class ExpeditionLigne extends CommonObjectLine * * @param User $user User that modify * @param int $notrigger 1 = disable triggers - * @return int < 0 if KO, > 0 if OK + * @return int Return integer < 0 if KO, > 0 if OK */ public function update($user = null, $notrigger = 0) { diff --git a/htdocs/expedition/class/expeditionlinebatch.class.php b/htdocs/expedition/class/expeditionlinebatch.class.php index 658de632577..4c8ee08e5a1 100644 --- a/htdocs/expedition/class/expeditionlinebatch.class.php +++ b/htdocs/expedition/class/expeditionlinebatch.class.php @@ -105,7 +105,7 @@ class ExpeditionLineBatch extends CommonObject * @param int $id_line_expdet rowid of expedtiondet record * @param User $f_user User that create * @param int $notrigger 1 = disable triggers - * @return int <0 if KO, Id of record (>0) if OK + * @return int Return integer <0 if KO, Id of record (>0) if OK */ public function create($id_line_expdet, $f_user = null, $notrigger = 0) { diff --git a/htdocs/expensereport/class/expensereport.class.php b/htdocs/expensereport/class/expensereport.class.php index 90fa537313d..1740360148e 100644 --- a/htdocs/expensereport/class/expensereport.class.php +++ b/htdocs/expensereport/class/expensereport.class.php @@ -1039,7 +1039,7 @@ class ExpenseReport extends CommonObject /** * fetch_lines * - * @return int <0 if OK, >0 if KO + * @return int Return integer <0 if OK, >0 if KO */ public function fetch_lines() { @@ -1257,7 +1257,7 @@ class ExpenseReport extends CommonObject * * @param User $fuser User * @param int $notrigger Disable triggers - * @return int <0 if KO, 0 if nothing done, >0 if OK + * @return int Return integer <0 if KO, 0 if nothing done, >0 if OK */ public function setValidate($fuser, $notrigger = 0) { @@ -1421,7 +1421,7 @@ class ExpenseReport extends CommonObject * * @param User $fuser User * @param int $notrigger Disable triggers - * @return int <0 if KO, 0 if nothing done, >0 if OK + * @return int Return integer <0 if KO, 0 if nothing done, >0 if OK */ public function setApproved($fuser, $notrigger = 0) { @@ -2521,7 +2521,7 @@ class ExpenseReport extends CommonObject * * @param User $user Objet user * @param string $option 'topay' or 'toapprove' - * @return WorkboardResponse|int <0 if KO, WorkboardResponse if OK + * @return WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK */ public function load_board($user, $option = 'topay') { @@ -2617,7 +2617,7 @@ class ExpenseReport extends CommonObject /** * Return if object was dispatched into bookkeeping * - * @return int <0 if KO, 0=no, 1=yes + * @return int Return integer <0 if KO, 0=no, 1=yes */ public function getVentilExportCompta() { @@ -2675,7 +2675,7 @@ class ExpenseReport extends CommonObject * @param int $fk_cat Category of the vehicule used * @param float $qty Number of kilometers * @param float $tva VAT rate - * @return int <0 if KO, total ttc if OK + * @return int Return integer <0 if KO, total ttc if OK */ public function computeTotalKm($fk_cat, $qty, $tva) { diff --git a/htdocs/expensereport/class/paymentexpensereport.class.php b/htdocs/expensereport/class/paymentexpensereport.class.php index 403ead3d28a..9f197da98c3 100644 --- a/htdocs/expensereport/class/paymentexpensereport.class.php +++ b/htdocs/expensereport/class/paymentexpensereport.class.php @@ -117,7 +117,7 @@ class PaymentExpenseReport extends CommonObject * Use this->amounts to have list of lines for the payment * * @param User $user User making payment - * @return int <0 if KO, id of payment if OK + * @return int Return integer <0 if KO, id of payment if OK */ public function create($user) { diff --git a/htdocs/fichinter/class/fichinter.class.php b/htdocs/fichinter/class/fichinter.class.php index 0c9b1add075..b590bbfdc20 100644 --- a/htdocs/fichinter/class/fichinter.class.php +++ b/htdocs/fichinter/class/fichinter.class.php @@ -1509,7 +1509,7 @@ class Fichinter extends CommonObject * @param User $user Object user that modify * @param string $ref_client Customer reference * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok */ public function setRefClient($user, $ref_client, $notrigger = 0) { @@ -1707,7 +1707,7 @@ class FichinterLigne extends CommonObjectLine * * @param User $user Objet user that make creation * @param int $notrigger Disable all triggers - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok */ public function insert($user, $notrigger = 0) { @@ -1796,7 +1796,7 @@ class FichinterLigne extends CommonObjectLine * * @param User $user Objet user that make creation * @param int $notrigger Disable all triggers - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok */ public function update($user, $notrigger = 0) { @@ -1857,7 +1857,7 @@ class FichinterLigne extends CommonObjectLine /** * Update total duration into llx_fichinter * - * @return int <0 si ko, >0 si ok + * @return int Return integer <0 si ko, >0 si ok */ public function update_total() { diff --git a/htdocs/fichinter/class/fichinterrec.class.php b/htdocs/fichinter/class/fichinterrec.class.php index 34b814ade33..c983380b2fd 100644 --- a/htdocs/fichinter/class/fichinterrec.class.php +++ b/htdocs/fichinter/class/fichinterrec.class.php @@ -145,7 +145,7 @@ class FichinterRec extends Fichinter * * @param User $user User object * @param int $notrigger no trigger - * @return int <0 if KO, id of fichinter if OK + * @return int Return integer <0 if KO, id of fichinter if OK */ public function create($user, $notrigger = 0) { @@ -477,7 +477,7 @@ class FichinterRec extends Fichinter * @param int $special_code Special code * @param string $label Label of the line * @param string $fk_unit Unit - * @return int <0 if KO, Id of line if OK + * @return int Return integer <0 if KO, Id of line if OK */ public function addline($desc, $duration, $date, $rang = -1, $pu_ht = 0, $qty = 0, $txtva = 0, $fk_product = 0, $remise_percent = 0, $price_base_type = 'HT', $info_bits = 0, $fk_remise_except = '', $pu_ttc = 0, $type = 0, $special_code = 0, $label = '', $fk_unit = null) { diff --git a/htdocs/fourn/class/fournisseur.class.php b/htdocs/fourn/class/fournisseur.class.php index f2c6953aebc..8fcee66bcb2 100644 --- a/htdocs/fourn/class/fournisseur.class.php +++ b/htdocs/fourn/class/fournisseur.class.php @@ -147,7 +147,7 @@ class Fournisseur extends Societe * * @param User $user User asking creation * @param string $name Category name - * @return int <0 if KO, 0 if OK + * @return int Return integer <0 if KO, 0 if OK */ public function CreateCategory($user, $name) { diff --git a/htdocs/fourn/class/fournisseur.commande.class.php b/htdocs/fourn/class/fournisseur.commande.class.php index e38c2062f70..6df974c0b6a 100644 --- a/htdocs/fourn/class/fournisseur.commande.class.php +++ b/htdocs/fourn/class/fournisseur.commande.class.php @@ -1054,7 +1054,7 @@ class CommandeFournisseur extends CommonOrder * Class invoiced the supplier order * * @param User $user Object user making the change - * @return int <0 if KO, 0 if already billed, >0 if OK + * @return int Return integer <0 if KO, 0 if already billed, >0 if OK */ public function classifyBilled(User $user) { @@ -1406,7 +1406,7 @@ class CommandeFournisseur extends CommonOrder * * @param User $user User making creation * @param int $notrigger Disable all triggers - * @return int <0 if KO, Id of supplier order if OK + * @return int Return integer <0 if KO, Id of supplier order if OK */ public function create($user, $notrigger = 0) { @@ -1827,7 +1827,7 @@ class CommandeFournisseur extends CommonOrder * @param int $origin_id Id of origin object * @param int $rang Rank * @param int $special_code Special code - * @return int <=0 if KO, >0 if OK + * @return int Return integer <=0 if KO, >0 if OK */ public function addline($desc, $pu_ht, $qty, $txtva, $txlocaltax1 = 0.0, $txlocaltax2 = 0.0, $fk_product = 0, $fk_prod_fourn_price = 0, $ref_supplier = '', $remise_percent = 0.0, $price_base_type = 'HT', $pu_ttc = 0.0, $type = 0, $info_bits = 0, $notrigger = false, $date_start = null, $date_end = null, $array_options = 0, $fk_unit = null, $pu_ht_devise = 0, $origin = '', $origin_id = 0, $rang = -1, $special_code = 0) { @@ -2547,7 +2547,7 @@ class CommandeFournisseur extends CommonOrder * @param User $user Object user that modify * @param int $delivery_date Delivery date * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok * @deprecated Use setDeliveryDate */ public function set_date_livraison($user, $delivery_date, $notrigger = 0) @@ -2619,7 +2619,7 @@ class CommandeFournisseur extends CommonOrder * @param User $user Objet utilisateur qui modifie * @param int $id_projet Delivery date * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <0 si ko, >0 si ok + * @return int Return integer <0 si ko, >0 si ok */ public function set_id_projet($user, $id_projet, $notrigger = 0) { @@ -2788,7 +2788,7 @@ class CommandeFournisseur extends CommonOrder * @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 string $ref_supplier Supplier ref - * @return int < 0 if error, > 0 if ok + * @return int Return integer < 0 if error, > 0 if ok */ public function updateline($rowid, $desc, $pu, $qty, $remise_percent, $txtva, $txlocaltax1 = 0, $txlocaltax2 = 0, $price_base_type = 'HT', $info_bits = 0, $type = 0, $notrigger = 0, $date_start = '', $date_end = '', $array_options = 0, $fk_unit = null, $pu_ht_devise = 0, $ref_supplier = '') { @@ -3097,7 +3097,7 @@ class CommandeFournisseur extends CommonOrder /** * Charge indicateurs this->nb de tableau de bord * - * @return int <0 si ko, >0 si ok + * @return int Return integer <0 si ko, >0 si ok */ public function load_state_board() { @@ -3137,7 +3137,7 @@ class CommandeFournisseur extends CommonOrder * * @param User $user Objet user * @param int $mode "opened", "awaiting" for orders awaiting reception - * @return WorkboardResponse|int <0 if KO, WorkboardResponse if OK + * @return WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK */ public function load_board($user, $mode = 'opened') { @@ -3239,7 +3239,7 @@ class CommandeFournisseur extends CommonOrder * @param int $hidedesc Hide description * @param int $hideref Hide ref * @param null|array $moreparams Array to provide more information - * @return int < 0 if KO, 0 = no doc generated, > 0 if OK + * @return int Return integer < 0 if KO, 0 = no doc generated, > 0 if OK */ public function generateDocument($modele, $outputlangs, $hidedetails = 0, $hidedesc = 0, $hideref = 0, $moreparams = null) { @@ -3412,7 +3412,7 @@ class CommandeFournisseur extends CommonOrder * @param User $user User action * @param int $closeopenorder Close if received * @param string $comment Comment - * @return int <0 if KO, 0 if not applicable, >0 if OK + * @return int Return integer <0 if KO, 0 if not applicable, >0 if OK */ public function calcAndSetStatusDispatch(User $user, $closeopenorder = 1, $comment = '') { @@ -3542,7 +3542,7 @@ class CommandeFournisseur extends CommonOrder * Note: For a dedicated shipment, the fetch_lines can be used to load the qty_asked and qty_shipped. This function is use to return qty_shipped cumulated for the order * * @param int $filtre_statut Filter on shipment status - * @return int <0 if KO, Nb of lines found if OK + * @return int Return integer <0 if KO, Nb of lines found if OK */ public function loadReceptions($filtre_statut = -1) { @@ -3975,7 +3975,7 @@ class CommandeFournisseurLigne extends CommonOrderLine * Update the line object into db * * @param int $notrigger 1 = disable triggers - * @return int <0 si ko, >0 si ok + * @return int Return integer <0 si ko, >0 si ok */ public function update($notrigger = 0) { diff --git a/htdocs/fourn/class/fournisseur.facture-rec.class.php b/htdocs/fourn/class/fournisseur.facture-rec.class.php index ac232bd2eb1..a8757fc76a6 100644 --- a/htdocs/fourn/class/fournisseur.facture-rec.class.php +++ b/htdocs/fourn/class/fournisseur.facture-rec.class.php @@ -255,7 +255,7 @@ class FactureFournisseurRec extends CommonInvoice * @param User $user User object * @param int $facFournId Id invoice * @param int $notrigger No trigger - * @return int <0 if KO, id of invoice created if OK + * @return int Return integer <0 if KO, id of invoice created if OK */ public function create($user, $facFournId, $notrigger = 0) { @@ -481,7 +481,7 @@ class FactureFournisseurRec extends CommonInvoice * * @param User $user User * @param int $notrigger No trigger - * @return int <0 if KO, Id of line if OK + * @return int Return integer <0 if KO, Id of line if OK */ public function update(User $user, $notrigger = 0) { @@ -872,7 +872,7 @@ class FactureFournisseurRec extends CommonInvoice * @param int $rang Position of line * @param string $fk_unit Unit * @param int $pu_ht_devise Unit price in currency - * @return int <0 if KO, Id of line if OK + * @return int Return integer <0 if KO, Id of line if OK * @throws Exception */ public function addline($fk_product, $ref, $label, $desc, $pu_ht, $pu_ttc, $qty, $remise_percent, $txtva, $txlocaltax1 = 0, $txlocaltax2 = 0, $price_base_type = 'HT', $type = 0, $date_start = 0, $date_end = 0, $info_bits = 0, $special_code = 0, $rang = -1, $fk_unit = null, $pu_ht_devise = 0) @@ -1065,7 +1065,7 @@ class FactureFournisseurRec extends CommonInvoice * @param string $fk_unit Unit * @param double $pu_ht_devise Unit price in currency * @param double $pu_ttc Unit price TTC (> 0 even for credit note) - * @return int <0 if KO, Id of line if OK + * @return int Return integer <0 if KO, Id of line if OK * @throws Exception */ public function updateline($rowid, $fk_product, $ref, $label, $desc, $pu_ht, $qty, $remise_percent, $txtva, $txlocaltax1 = 0, $txlocaltax2 = 0, $price_base_type = 'HT', $type = 0, $date_start = 0, $date_end = 0, $info_bits = 0, $special_code = 0, $rang = -1, $fk_unit = null, $pu_ht_devise = 0, $pu_ttc = 0) @@ -2148,7 +2148,7 @@ class FactureFournisseurLigneRec extends CommonObjectLine * * @param User $user User * @param int $notrigger No trigger - * @return int <0 if KO, Id of line if OK + * @return int Return integer <0 if KO, Id of line if OK */ public function update(User $user, $notrigger = 0) { diff --git a/htdocs/fourn/class/fournisseur.facture.class.php b/htdocs/fourn/class/fournisseur.facture.class.php index 49aafcf9378..26a73d35472 100644 --- a/htdocs/fourn/class/fournisseur.facture.class.php +++ b/htdocs/fourn/class/fournisseur.facture.class.php @@ -1554,7 +1554,7 @@ class FactureFournisseur extends CommonInvoice * @param User $user Object user * @param string $close_code Code indicates whether the class has paid in full while payment is incomplete. Not implementd yet. * @param string $close_note Comment informs if the class has been paid while payment is incomplete. Not implementd yet. - * @return int <0 si ko, >0 si ok + * @return int Return integer <0 si ko, >0 si ok */ public function set_paid($user, $close_code = '', $close_note = '') { @@ -1569,7 +1569,7 @@ class FactureFournisseur extends CommonInvoice * @param User $user Object user * @param string $close_code Code indicates whether the class has paid in full while payment is incomplete. Not implementd yet. * @param string $close_note Comment informs if the class has been paid while payment is incomplete. Not implementd yet. - * @return int <0 si ko, >0 si ok + * @return int Return integer <0 si ko, >0 si ok */ public function setPaid($user, $close_code = '', $close_note = '') { @@ -1632,7 +1632,7 @@ class FactureFournisseur extends CommonInvoice * @deprecated * @see setUnpaid() * @param User $user Object user that change status - * @return int <0 si ok, >0 si ok + * @return int Return integer <0 si ok, >0 si ok */ public function set_unpaid($user) { @@ -1647,7 +1647,7 @@ class FactureFournisseur extends CommonInvoice * or when the invoice was canceled and reopened. * * @param User $user Object user that change status - * @return int <0 si ok, >0 si ok + * @return int Return integer <0 si ok, >0 si ok */ public function setUnpaid($user) { @@ -1750,7 +1750,7 @@ class FactureFournisseur extends CommonInvoice * @param string $force_number Reference to force on invoice * @param int $idwarehouse Id of warehouse for stock change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <0 if KO, =0 if nothing to do, >0 if OK + * @return int Return integer <0 if KO, =0 if nothing to do, >0 if OK */ public function validate($user, $force_number = '', $idwarehouse = 0, $notrigger = 0) { @@ -2679,7 +2679,7 @@ class FactureFournisseur extends CommonInvoice * Load indicators for dashboard (this->nbtodo and this->nbtodolate) * * @param User $user Object user - * @return WorkboardResponse|int <0 if KO, WorkboardResponse if OK + * @return WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK */ public function load_board($user) { @@ -3213,7 +3213,7 @@ class FactureFournisseur extends CommonInvoice * @param int $hidedesc Hide description * @param int $hideref Hide ref * @param null|array $moreparams Array to provide more information - * @return int <0 if KO, 0 if nothing done, >0 if OK + * @return int Return integer <0 if KO, 0 if nothing done, >0 if OK */ public function generateDocument($modele, $outputlangs, $hidedetails = 0, $hidedesc = 0, $hideref = 0, $moreparams = null) { @@ -3640,7 +3640,7 @@ class SupplierInvoiceLine extends CommonObjectLine * Retrieves a supplier invoice line * * @param int $rowid Line id - * @return int <0 KO; 0 NOT FOUND; 1 OK + * @return int Return integer <0 KO; 0 NOT FOUND; 1 OK */ public function fetch($rowid) { @@ -4125,7 +4125,7 @@ class SupplierInvoiceLine extends CommonObjectLine /** * Mise a jour de l'objet ligne de commande en base * - * @return int <0 si ko, >0 si ok + * @return int Return integer <0 si ko, >0 si ok */ public function update_total() { diff --git a/htdocs/fourn/class/fournisseur.product.class.php b/htdocs/fourn/class/fournisseur.product.class.php index 7c5fc258fa7..26751c291d7 100644 --- a/htdocs/fourn/class/fournisseur.product.class.php +++ b/htdocs/fourn/class/fournisseur.product.class.php @@ -164,7 +164,7 @@ class ProductFournisseur extends Product * Remove all prices for this couple supplier-product * * @param int $id_fourn Supplier Id - * @return int < 0 if error, > 0 if ok + * @return int Return integer < 0 if error, > 0 if ok */ public function remove_fournisseur($id_fourn) { @@ -266,7 +266,7 @@ class ProductFournisseur extends Product * @param string $barcode Barcode * @param int $fk_barcode_type Barcode type * @param array $options Extrafields of product fourn price - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function update_buyprice($qty, $buyprice, $user, $price_base_type, $fourn, $availability, $ref_fourn, $tva_tx, $charges = 0, $remise_percent = 0, $remise = 0, $newnpr = 0, $delivery_time_days = 0, $supplier_reputation = '', $localtaxes_array = array(), $newdefaultvatcode = '', $multicurrency_buyprice = 0, $multicurrency_price_base_type = 'HT', $multicurrency_tx = 1, $multicurrency_code = '', $desc_fourn = '', $barcode = '', $fk_barcode_type = '', $options = array()) { @@ -583,7 +583,7 @@ class ProductFournisseur extends Product * * @param int $rowid Line id * @param int $ignore_expression Ignores the math expression for calculating price and uses the db value instead - * @return int < 0 if KO, 0 if OK but not found, > 0 if OK + * @return int Return integer < 0 if KO, 0 if OK but not found, > 0 if OK */ public function fetch_product_fournisseur_price($rowid, $ignore_expression = 0) { @@ -794,7 +794,7 @@ class ProductFournisseur extends Product * @param int $prodid Product id * @param int $qty Minimum quantity * @param int $socid get min price for specific supplier - * @return int <0 if KO, 0=Not found of no product id provided, >0 if OK + * @return int Return integer <0 if KO, 0=Not found of no product id provided, >0 if OK * @see list_product_fournisseur_price() */ public function find_min_price_product_fournisseur($prodid, $qty = 0, $socid = 0) @@ -1367,7 +1367,7 @@ class ProductFournisseur extends Product * @param int $fk_multicurrency key multi currency * @param string $multicurrency_code Currency code * - * @return int < 0 NOK > 0 OK + * @return int Return integer < 0 NOK > 0 OK */ private function logPrice($user, $datec, $buyprice, $qty, $multicurrency_buyprice = null, $multicurrency_unitBuyPrice = null, $multicurrency_tx = null, $fk_multicurrency = null, $multicurrency_code = null) { diff --git a/htdocs/fourn/class/paiementfourn.class.php b/htdocs/fourn/class/paiementfourn.class.php index 83cba47fddb..37e937bbca0 100644 --- a/htdocs/fourn/class/paiementfourn.class.php +++ b/htdocs/fourn/class/paiementfourn.class.php @@ -96,7 +96,7 @@ class PaiementFourn extends Paiement * @param int $id Id if payment to get * @param string $ref Ref of payment to get * @param int $fk_bank Id of bank line associated to payment - * @return int <0 if KO, -2 if not found, >0 if OK + * @return int Return integer <0 if KO, -2 if not found, >0 if OK */ public function fetch($id, $ref = '', $fk_bank = '') { @@ -429,7 +429,7 @@ class PaiementFourn extends Paiement * @TODO Add User $user as first param * * @param int $notrigger No trigger - * @return int <0 si ko, >0 si ok + * @return int Return integer <0 si ko, >0 si ok */ public function delete($notrigger = 0) { @@ -833,7 +833,7 @@ class PaiementFourn extends Paiement * @param int $hidedesc Hide description * @param int $hideref Hide ref * @param null|array $moreparams Array to provide more information - * @return int <0 if KO, 0 if nothing done, >0 if OK + * @return int Return integer <0 if KO, 0 if nothing done, >0 if OK */ public function generateDocument($modele, $outputlangs, $hidedetails = 0, $hidedesc = 0, $hideref = 0, $moreparams = null) { diff --git a/htdocs/holiday/class/holiday.class.php b/htdocs/holiday/class/holiday.class.php index 9c460550e85..5e845cf951e 100644 --- a/htdocs/holiday/class/holiday.class.php +++ b/htdocs/holiday/class/holiday.class.php @@ -2404,7 +2404,7 @@ class Holiday extends CommonObject * Load indicators for dashboard (this->nbtodo and this->nbtodolate) * * @param User $user Objet user - * @return WorkboardResponse|int <0 if KO, WorkboardResponse if OK + * @return WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK */ public function load_board($user) { diff --git a/htdocs/hrm/class/establishment.class.php b/htdocs/hrm/class/establishment.class.php index 2594d26f26b..c9d03da8924 100644 --- a/htdocs/hrm/class/establishment.class.php +++ b/htdocs/hrm/class/establishment.class.php @@ -285,7 +285,7 @@ class Establishment extends CommonObject * Load an object from database * * @param int $id Id of record to load - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function fetch($id) { diff --git a/htdocs/hrm/class/evaluation.class.php b/htdocs/hrm/class/evaluation.class.php index f2bdfc2021c..0214c2f51f1 100644 --- a/htdocs/hrm/class/evaluation.class.php +++ b/htdocs/hrm/class/evaluation.class.php @@ -512,7 +512,7 @@ class Evaluation extends CommonObject * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function validate($user, $notrigger = 0) { @@ -686,7 +686,7 @@ class Evaluation extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancel($user, $notrigger = 0) { @@ -703,7 +703,7 @@ class Evaluation extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { diff --git a/htdocs/hrm/class/evaluationdet.class.php b/htdocs/hrm/class/evaluationdet.class.php index d20877abb4f..2778ac9e76c 100644 --- a/htdocs/hrm/class/evaluationdet.class.php +++ b/htdocs/hrm/class/evaluationdet.class.php @@ -483,7 +483,7 @@ class EvaluationLine extends CommonObjectLine * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function validate($user, $notrigger = 0) { @@ -640,7 +640,7 @@ class EvaluationLine extends CommonObjectLine * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancel($user, $notrigger = 0) { @@ -664,7 +664,7 @@ class EvaluationLine extends CommonObjectLine * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { diff --git a/htdocs/hrm/class/job.class.php b/htdocs/hrm/class/job.class.php index 67b513f745e..2a306d5b8be 100644 --- a/htdocs/hrm/class/job.class.php +++ b/htdocs/hrm/class/job.class.php @@ -481,7 +481,7 @@ class Job extends CommonObject * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function validate($user, $notrigger = 0) { @@ -675,7 +675,7 @@ class Job extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancel($user, $notrigger = 0) { @@ -699,7 +699,7 @@ class Job extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { diff --git a/htdocs/hrm/class/position.class.php b/htdocs/hrm/class/position.class.php index cdb8a18e1d8..a1bd5183cae 100644 --- a/htdocs/hrm/class/position.class.php +++ b/htdocs/hrm/class/position.class.php @@ -491,7 +491,7 @@ class Position extends CommonObject * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function validate($user, $notrigger = 0) { @@ -648,7 +648,7 @@ class Position extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancel($user, $notrigger = 0) { @@ -672,7 +672,7 @@ class Position extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { diff --git a/htdocs/hrm/class/skill.class.php b/htdocs/hrm/class/skill.class.php index e38a6c5915b..486e47f8b38 100644 --- a/htdocs/hrm/class/skill.class.php +++ b/htdocs/hrm/class/skill.class.php @@ -401,7 +401,7 @@ class Skill extends CommonObject /** * Load object lines in memory from the database * - * @return array|int <0 if KO, array of skill level found + * @return array|int Return integer <0 if KO, array of skill level found */ public function fetchLines() { @@ -549,7 +549,7 @@ class Skill extends CommonObject * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function validate($user, $notrigger = 0) { @@ -706,7 +706,7 @@ class Skill extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancel($user, $notrigger = 0) { @@ -730,7 +730,7 @@ class Skill extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { diff --git a/htdocs/hrm/class/skilldet.class.php b/htdocs/hrm/class/skilldet.class.php index 8aa70255356..e658e75b265 100644 --- a/htdocs/hrm/class/skilldet.class.php +++ b/htdocs/hrm/class/skilldet.class.php @@ -472,7 +472,7 @@ class Skilldet extends CommonObjectLine * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function validate($user, $notrigger = 0) { @@ -629,7 +629,7 @@ class Skilldet extends CommonObjectLine * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancel($user, $notrigger = 0) { @@ -653,7 +653,7 @@ class Skilldet extends CommonObjectLine * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { diff --git a/htdocs/hrm/class/skillrank.class.php b/htdocs/hrm/class/skillrank.class.php index 74a97d7c732..dffb5600e46 100644 --- a/htdocs/hrm/class/skillrank.class.php +++ b/htdocs/hrm/class/skillrank.class.php @@ -521,7 +521,7 @@ class SkillRank extends CommonObject * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function validate($user, $notrigger = 0) { @@ -678,7 +678,7 @@ class SkillRank extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancel($user, $notrigger = 0) { @@ -702,7 +702,7 @@ class SkillRank extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { diff --git a/htdocs/install/upgrade2.php b/htdocs/install/upgrade2.php index 982d46fa4aa..f96d7b8719e 100644 --- a/htdocs/install/upgrade2.php +++ b/htdocs/install/upgrade2.php @@ -2534,7 +2534,7 @@ function migrate_commande_deliveryaddress($db, $langs, $conf) * @param DoliDB $db Database handler * @param Translate $langs Object langs * @param Conf $conf Object conf - * @return integer <0 if KO, 0=Bad version, >0 if OK + * @return integer Return integer <0 if KO, 0=Bad version, >0 if OK */ function migrate_restore_missing_links($db, $langs, $conf) { diff --git a/htdocs/knowledgemanagement/class/knowledgerecord.class.php b/htdocs/knowledgemanagement/class/knowledgerecord.class.php index b140916d559..3fcc370b0dd 100644 --- a/htdocs/knowledgemanagement/class/knowledgerecord.class.php +++ b/htdocs/knowledgemanagement/class/knowledgerecord.class.php @@ -522,7 +522,7 @@ class KnowledgeRecord extends CommonObject * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function validate($user, $notrigger = 0) { @@ -679,7 +679,7 @@ class KnowledgeRecord extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancel($user, $notrigger = 0) { @@ -703,7 +703,7 @@ class KnowledgeRecord extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { diff --git a/htdocs/loan/class/loan.class.php b/htdocs/loan/class/loan.class.php index a799f20185d..4830cca6d2e 100644 --- a/htdocs/loan/class/loan.class.php +++ b/htdocs/loan/class/loan.class.php @@ -131,7 +131,7 @@ class Loan extends CommonObject * Load object in memory from database * * @param int $id id object - * @return int <0 error , >=0 no error + * @return int Return integer <0 error , >=0 no error */ public function fetch($id) { @@ -182,7 +182,7 @@ class Loan extends CommonObject * Create a loan into database * * @param User $user User making creation - * @return int <0 if KO, id if OK + * @return int Return integer <0 if KO, id if OK */ public function create($user) { @@ -348,7 +348,7 @@ class Loan extends CommonObject * Update loan * * @param User $user User who modified - * @return int <0 if error, >0 if ok + * @return int Return integer <0 if error, >0 if ok */ public function update($user) { diff --git a/htdocs/loan/class/loanschedule.class.php b/htdocs/loan/class/loanschedule.class.php index 069a798bdd6..4ec3e2908b8 100644 --- a/htdocs/loan/class/loanschedule.class.php +++ b/htdocs/loan/class/loanschedule.class.php @@ -124,7 +124,7 @@ class LoanSchedule extends CommonObject * Use this->amounts to have list of lines for the payment * * @param User $user User making payment - * @return int <0 if KO, id of payment if OK + * @return int Return integer <0 if KO, id of payment if OK */ public function create($user) { @@ -538,7 +538,7 @@ class LoanSchedule extends CommonObject * lastpayment * * @param int $loanid Loan id - * @return int < 0 if KO, Date > 0 if OK + * @return int Return integer < 0 if KO, Date > 0 if OK */ private function lastPayment($loanid) { diff --git a/htdocs/loan/class/paymentloan.class.php b/htdocs/loan/class/paymentloan.class.php index 6125e67afa2..08346ad502b 100644 --- a/htdocs/loan/class/paymentloan.class.php +++ b/htdocs/loan/class/paymentloan.class.php @@ -120,7 +120,7 @@ class PaymentLoan extends CommonObject * Use this->amounts to have list of lines for the payment * * @param User $user User making payment - * @return int <0 if KO, id of payment if OK + * @return int Return integer <0 if KO, id of payment if OK */ public function create($user) { diff --git a/htdocs/mailmanspip/class/mailmanspip.class.php b/htdocs/mailmanspip/class/mailmanspip.class.php index bf040d51673..9c70a6a9200 100644 --- a/htdocs/mailmanspip/class/mailmanspip.class.php +++ b/htdocs/mailmanspip/class/mailmanspip.class.php @@ -288,7 +288,7 @@ class MailmanSpip * * @param Adherent $object Object with data (->email, ->pass, ->element, ->type) * @param string $listes To force mailing-list (string separated with ,) - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function add_to_mailman($object, $listes = '') { @@ -358,7 +358,7 @@ class MailmanSpip * * @param Adherent $object Object with data (->email, ->pass, ->element, ->type) * @param string $listes To force mailing-list (string separated with ,) - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function del_to_mailman($object, $listes = '') { diff --git a/htdocs/modulebuilder/template/class/actions_mymodule.class.php b/htdocs/modulebuilder/template/class/actions_mymodule.class.php index de16b676c00..62b2e8ce3f6 100644 --- a/htdocs/modulebuilder/template/class/actions_mymodule.class.php +++ b/htdocs/modulebuilder/template/class/actions_mymodule.class.php @@ -79,7 +79,7 @@ class ActionsMyModule extends CommonHookActions * @param array $parameters Array of parameters * @param CommonObject $object The object to process (an invoice if you are in invoice module, a propale in propale's module, etc...) * @param string $action 'add', 'update', 'view' - * @return int <0 if KO, + * @return int Return integer <0 if KO, * =0 if OK but we want to process standard actions too, * >0 if OK and we want to replace standard actions. */ @@ -97,7 +97,7 @@ class ActionsMyModule extends CommonHookActions * @param CommonObject $object The object to process (an invoice if you are in invoice module, a propale in propale's module, etc...) * @param string $action Current action (if set). Generally create or edit or null * @param HookManager $hookmanager Hook manager propagated to allow calling another hook - * @return int < 0 on error, 0 on success, 1 to replace standard code + * @return int Return integer < 0 on error, 0 on success, 1 to replace standard code */ public function doActions($parameters, &$object, &$action, $hookmanager) { @@ -129,7 +129,7 @@ class ActionsMyModule extends CommonHookActions * @param CommonObject $object The object to process (an invoice if you are in invoice module, a propale in propale's module, etc...) * @param string $action Current action (if set). Generally create or edit or null * @param HookManager $hookmanager Hook manager propagated to allow calling another hook - * @return int < 0 on error, 0 on success, 1 to replace standard code + * @return int Return integer < 0 on error, 0 on success, 1 to replace standard code */ public function doMassActions($parameters, &$object, &$action, $hookmanager) { @@ -162,7 +162,7 @@ class ActionsMyModule extends CommonHookActions * @param CommonObject $object The object to process (an invoice if you are in invoice module, a propale in propale's module, etc...) * @param string $action Current action (if set). Generally create or edit or null * @param HookManager $hookmanager Hook manager propagated to allow calling another hook - * @return int < 0 on error, 0 on success, 1 to replace standard code + * @return int Return integer < 0 on error, 0 on success, 1 to replace standard code */ public function addMoreMassActions($parameters, &$object, &$action, $hookmanager) { @@ -192,7 +192,7 @@ class ActionsMyModule extends CommonHookActions * @param array $parameters Array of parameters * @param Object $object Object output on PDF * @param string $action 'add', 'update', 'view' - * @return int <0 if KO, + * @return int Return integer <0 if KO, * =0 if OK but we want to process standard actions too, * >0 if OK and we want to replace standard actions. */ @@ -220,7 +220,7 @@ class ActionsMyModule extends CommonHookActions * @param array $parameters Array of parameters * @param Object $pdfhandler PDF builder handler * @param string $action 'add', 'update', 'view' - * @return int <0 if KO, + * @return int Return integer <0 if KO, * =0 if OK but we want to process standard actions too, * >0 if OK and we want to replace standard actions. */ @@ -251,7 +251,7 @@ class ActionsMyModule extends CommonHookActions * @param array $parameters Hook metadatas (context, etc...) * @param string $action Current action (if set). Generally create or edit or null * @param HookManager $hookmanager Hook manager propagated to allow calling another hook - * @return int < 0 on error, 0 on success, 1 to replace standard code + * @return int Return integer < 0 on error, 0 on success, 1 to replace standard code */ public function loadDataForCustomReports($parameters, &$action, $hookmanager) { @@ -291,7 +291,7 @@ class ActionsMyModule extends CommonHookActions * @param array $parameters Hook metadatas (context, etc...) * @param string $action Current action (if set). Generally create or edit or null * @param HookManager $hookmanager Hook manager propagated to allow calling another hook - * @return int <0 if KO, + * @return int Return integer <0 if KO, * =0 if OK but we want to process standard actions too, * >0 if OK and we want to replace standard actions. */ @@ -319,7 +319,7 @@ class ActionsMyModule extends CommonHookActions * @param CommonObject $object The object to process (an invoice if you are in invoice module, a propale in propale's module, etc...) * @param string $action 'add', 'update', 'view' * @param Hookmanager $hookmanager hookmanager - * @return int <0 if KO, + * @return int Return integer <0 if KO, * =0 if OK but we want to process standard actions too, * >0 if OK and we want to replace standard actions. */ diff --git a/htdocs/modulebuilder/template/class/myobject.class.php b/htdocs/modulebuilder/template/class/myobject.class.php index 30490b92e6d..2c5307279ce 100644 --- a/htdocs/modulebuilder/template/class/myobject.class.php +++ b/htdocs/modulebuilder/template/class/myobject.class.php @@ -587,7 +587,7 @@ class MyObject extends CommonObject * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function validate($user, $notrigger = 0) { @@ -744,7 +744,7 @@ class MyObject extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancel($user, $notrigger = 0) { @@ -768,7 +768,7 @@ class MyObject extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { diff --git a/htdocs/modulebuilder/template/core/modules/mailings/mailinglist_mymodule_myobject.modules.php b/htdocs/modulebuilder/template/core/modules/mailings/mailinglist_mymodule_myobject.modules.php index b554c6aa578..4999067b62c 100644 --- a/htdocs/modulebuilder/template/core/modules/mailings/mailinglist_mymodule_myobject.modules.php +++ b/htdocs/modulebuilder/template/core/modules/mailings/mailinglist_mymodule_myobject.modules.php @@ -96,7 +96,7 @@ class mailing_mailinglist_mymodule_myobject extends MailingTargets * This is the main function that returns the array of emails * * @param int $mailing_id Id of emailing - * @return int <0 if error, number of emails added if ok + * @return int Return integer <0 if error, number of emails added if ok */ public function add_to_target($mailing_id) { diff --git a/htdocs/modulebuilder/template/core/triggers/interface_99_modMyModule_MyModuleTriggers.class.php b/htdocs/modulebuilder/template/core/triggers/interface_99_modMyModule_MyModuleTriggers.class.php index 9420c83b8c0..392addd84d0 100644 --- a/htdocs/modulebuilder/template/core/triggers/interface_99_modMyModule_MyModuleTriggers.class.php +++ b/htdocs/modulebuilder/template/core/triggers/interface_99_modMyModule_MyModuleTriggers.class.php @@ -86,7 +86,7 @@ class InterfaceMyModuleTriggers extends DolibarrTriggers * @param User $user Object user * @param Translate $langs Object langs * @param Conf $conf Object conf - * @return int <0 if KO, 0 if no triggered ran, >0 if OK + * @return int Return integer <0 if KO, 0 if no triggered ran, >0 if OK */ public function runTrigger($action, $object, User $user, Translate $langs, Conf $conf) { diff --git a/htdocs/mrp/class/mo.class.php b/htdocs/mrp/class/mo.class.php index 86273c415d0..4d9f5a2529d 100644 --- a/htdocs/mrp/class/mo.class.php +++ b/htdocs/mrp/class/mo.class.php @@ -294,7 +294,7 @@ class Mo extends CommonObject * * @param User $user User that creates * @param bool $notrigger false=launch triggers after, true=disable triggers - * @return int <=0 if KO, Id of created object if OK + * @return int Return integer <=0 if KO, Id of created object if OK */ public function create(User $user, $notrigger = false) { @@ -1012,7 +1012,7 @@ class Mo extends CommonObject * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function validate($user, $notrigger = 0) { @@ -1164,7 +1164,7 @@ class Mo extends CommonObject * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers * @param bool $also_cancel_consumed_and_produced_lines true if the consumed and produced lines will be deleted (and stocks incremented/decremented back) (false by default) - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancel($user, $notrigger = 0, $also_cancel_consumed_and_produced_lines = false) { @@ -1211,7 +1211,7 @@ class Mo extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { @@ -1237,7 +1237,7 @@ class Mo extends CommonObject * @param bool $mode Type line supported (0 by default) (0: consumed and produced lines; 1: consumed lines; 2: produced lines) * @param bool $also_delete_lines true if the consumed/produced lines is deleted (false by default) * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancelConsumedAndProducedLines($user, $mode = 0, $also_delete_lines = false, $notrigger = 0) { diff --git a/htdocs/multicurrency/class/multicurrency.class.php b/htdocs/multicurrency/class/multicurrency.class.php index c03a8ab9952..a7ef2153c9f 100644 --- a/htdocs/multicurrency/class/multicurrency.class.php +++ b/htdocs/multicurrency/class/multicurrency.class.php @@ -237,7 +237,7 @@ class MultiCurrency extends CommonObject /** * Load all rates in object from the database * - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function fetchAllCurrencyRate() { diff --git a/htdocs/partnership/class/partnership.class.php b/htdocs/partnership/class/partnership.class.php index 05be2893076..4c54741c94d 100644 --- a/htdocs/partnership/class/partnership.class.php +++ b/htdocs/partnership/class/partnership.class.php @@ -555,7 +555,7 @@ class Partnership extends CommonObject * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function validate($user, $notrigger = 0) { @@ -687,7 +687,7 @@ class Partnership extends CommonObject * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function approve($user, $notrigger = 0) { @@ -845,7 +845,7 @@ class Partnership extends CommonObject * @param User $user Object user that modify * @param string $reasondeclinenote Reason decline * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function refused($user, $reasondeclinenote = '', $notrigger = 0) { @@ -872,7 +872,7 @@ class Partnership extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancel($user, $notrigger = 0) { @@ -896,7 +896,7 @@ class Partnership extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { diff --git a/htdocs/product/class/product.class.php b/htdocs/product/class/product.class.php index 1297f2a6752..b98760ffd01 100644 --- a/htdocs/product/class/product.class.php +++ b/htdocs/product/class/product.class.php @@ -1458,7 +1458,7 @@ class Product extends CommonObject * * @param User $user User (object) deleting product * @param int $notrigger Do not execute trigger - * @return int < 0 if KO, 0 = Not possible, > 0 if OK + * @return int Return integer < 0 if KO, 0 = Not possible, > 0 if OK */ public function delete(User $user, $notrigger = 0) { @@ -1760,7 +1760,7 @@ class Product extends CommonObject * * @param string $type It can be 'buy', 'buy_intra', 'buy_export', 'sell', 'sell_intra' or 'sell_export' * @param string $value Accountancy code - * @return int <0 KO >0 OK + * @return int Return integer <0 KO >0 OK */ public function setAccountancyCode($type, $value) { @@ -2082,7 +2082,7 @@ class Product extends CommonObject * @param int $product_id Filter on a particular product id * @param string $fourn_ref Filter on a supplier price ref. 'none' to exclude ref in search. * @param int $fk_soc If of supplier - * @return int <-1 if KO, -1 if qty not enough, 0 if OK but nothing found, id_product if OK and found. May also initialize some properties like (->ref_supplier, buyprice, fourn_pu, vatrate_supplier...) + * @return int Return integer <-1 if KO, -1 if qty not enough, 0 if OK but nothing found, id_product if OK and found. May also initialize some properties like (->ref_supplier, buyprice, fourn_pu, vatrate_supplier...) * @see getSellPrice(), find_min_price_product_fournisseur() */ public function get_buyprice($prodfournprice, $qty, $product_id = 0, $fourn_ref = '', $fk_soc = 0) @@ -3836,7 +3836,7 @@ class Product extends CommonObject * @param string $sql Request to execute * @param string $mode 'byunit'=number of unit, 'bynumber'=nb of entities * @param int $year Year (0=current year, -1=all years) - * @return array|int <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11 + * @return array|int Return integer <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11 */ private function _get_stats($sql, $mode, $year = 0) { @@ -3914,7 +3914,7 @@ class Product extends CommonObject * @param int $filteronproducttype 0=To filter on product only, 1=To filter on services only * @param int $year Year (0=last 12 month, -1=all years) * @param string $morefilter More sql filters - * @return array <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11 + * @return array Return integer <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11 */ public function get_nb_vente($socid, $mode, $filteronproducttype = -1, $year = 0, $morefilter = '') { @@ -3968,7 +3968,7 @@ class Product extends CommonObject * @param int $filteronproducttype 0=To filter on product only, 1=To filter on services only * @param int $year Year (0=last 12 month, -1=all years) * @param string $morefilter More sql filters - * @return array <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11 + * @return array Return integer <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11 */ public function get_nb_achat($socid, $mode, $filteronproducttype = -1, $year = 0, $morefilter = '') { @@ -4021,7 +4021,7 @@ class Product extends CommonObject * @param int $filteronproducttype 0=To filter on product only, 1=To filter on services only * @param int $year Year (0=last 12 month, -1=all years) * @param string $morefilter More sql filters - * @return array <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11 + * @return array Return integer <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11 */ public function get_nb_propal($socid, $mode, $filteronproducttype = -1, $year = 0, $morefilter = '') { @@ -4073,7 +4073,7 @@ class Product extends CommonObject * @param int $filteronproducttype 0=To filter on product only, 1=To filter on services only * @param int $year Year (0=last 12 month, -1=all years) * @param string $morefilter More sql filters - * @return array <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11 + * @return array Return integer <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11 */ public function get_nb_propalsupplier($socid, $mode, $filteronproducttype = -1, $year = 0, $morefilter = '') { @@ -4126,7 +4126,7 @@ class Product extends CommonObject * @param int $filteronproducttype 0=To filter on product only, 1=To filter on services only * @param int $year Year (0=last 12 month, -1=all years) * @param string $morefilter More sql filters - * @return array <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11 + * @return array Return integer <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11 */ public function get_nb_order($socid, $mode, $filteronproducttype = -1, $year = 0, $morefilter = '') { @@ -4178,7 +4178,7 @@ class Product extends CommonObject * @param int $filteronproducttype 0=To filter on product only, 1=To filter on services only * @param int $year Year (0=last 12 month, -1=all years) * @param string $morefilter More sql filters - * @return array <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11 + * @return array Return integer <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11 */ public function get_nb_ordersupplier($socid, $mode, $filteronproducttype = -1, $year = 0, $morefilter = '') { @@ -4230,7 +4230,7 @@ class Product extends CommonObject * @param int $filteronproducttype 0=To filter on product only, 1=To filter on services only * @param int $year Year (0=last 12 month, -1=all years) * @param string $morefilter More sql filters - * @return array <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11 + * @return array Return integer <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11 */ public function get_nb_contract($socid, $mode, $filteronproducttype = -1, $year = 0, $morefilter = '') { @@ -4285,7 +4285,7 @@ class Product extends CommonObject * @param int $filteronproducttype 0=To filter on product only, 1=To filter on services only * @param int $year Year (0=last 12 month, -1=all years) * @param string $morefilter More sql filters - * @return array <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11 + * @return array Return integer <0 if KO, result[month]=array(valuex,valuey) where month is 0 to 11 */ public function get_nb_mos($socid, $mode, $filteronproducttype = -1, $year = 0, $morefilter = '') { @@ -4338,7 +4338,7 @@ class Product extends CommonObject * @param int $qty Quantity * @param int $incdec 1=Increase/decrease stock of child when parent stock increase/decrease * @param int $notrigger Disable triggers - * @return int < 0 if KO, > 0 if OK + * @return int Return integer < 0 if KO, > 0 if OK */ public function add_sousproduit($id_pere, $id_fils, $qty, $incdec = 1, $notrigger = 0) { @@ -4411,7 +4411,7 @@ class Product extends CommonObject * @param int $qty Quantity * @param int $incdec 1=Increase/decrease stock of child when parent stock increase/decrease * @param int $notrigger Disable triggers - * @return int < 0 if KO, > 0 if OK + * @return int Return integer < 0 if KO, > 0 if OK */ public function update_sousproduit($id_pere, $id_fils, $qty, $incdec = 1, $notrigger = 0) { @@ -4463,7 +4463,7 @@ class Product extends CommonObject * @param int $fk_parent Id of parent product (child will no more be linked to it) * @param int $fk_child Id of child product * @param int $notrigger Disable triggers - * @return int < 0 if KO, > 0 if OK + * @return int Return integer < 0 if KO, > 0 if OK */ public function del_sousproduit($fk_parent, $fk_child, $notrigger = 0) { @@ -4566,7 +4566,7 @@ class Product extends CommonObject * @param int $id_fourn Supplier id * @param string $ref_fourn Supplier ref * @param float $quantity Quantity minimum for price - * @return int < 0 if KO, 0 if link already exists for this product, > 0 if OK + * @return int Return integer < 0 if KO, 0 if link already exists for this product, > 0 if OK */ public function add_fournisseur($user, $id_fourn, $ref_fourn, $quantity) { @@ -4695,7 +4695,7 @@ class Product extends CommonObject * * @param int $fromId Id product source * @param int $toId Id product target - * @return int < 0 if KO, > 0 if OK + * @return int Return integer < 0 if KO, > 0 if OK */ public function clone_price($fromId, $toId) { @@ -4808,7 +4808,7 @@ class Product extends CommonObject * * @param int $fromId Id produit source * @param int $toId Id produit cible - * @return int < 0 si erreur, > 0 si ok + * @return int Return integer < 0 si erreur, > 0 si ok */ public function clone_fournisseurs($fromId, $toId) { @@ -5672,7 +5672,7 @@ class Product extends CommonObject * You can also filter on 'warehouseclosed', 'warehouseopen', 'warehouseinternal' * @param int $includedraftpoforvirtual Include draft status of PO for virtual stock calculation * @param int $dateofvirtualstock Date of virtual stock - * @return int < 0 if KO, > 0 if OK + * @return int Return integer < 0 if KO, > 0 if OK * @see load_virtual_stock(), loadBatchInfo() */ public function load_stock($option = '', $includedraftpoforvirtual = null, $dateofvirtualstock = null) @@ -5751,7 +5751,7 @@ class Product extends CommonObject * * @param int $includedraftpoforvirtual Include draft status and not yet approved Purchase Orders for virtual stock calculation * @param int $dateofvirtualstock Date of virtual stock - * @return int < 0 if KO, > 0 if OK + * @return int Return integer < 0 if KO, > 0 if OK * @see load_stock(), loadBatchInfo() */ public function load_virtual_stock($includedraftpoforvirtual = null, $dateofvirtualstock = null) @@ -6253,7 +6253,7 @@ class Product extends CommonObject * Returns the text label from units dictionary * * @param string $type Label type (long or short) - * @return string|int <0 if ko, label if ok + * @return string|int Return integer <0 if ko, label if ok */ public function getLabelOfUnit($type = 'long') { diff --git a/htdocs/product/class/productbatch.class.php b/htdocs/product/class/productbatch.class.php index 7374673fa02..20e3932ce33 100644 --- a/htdocs/product/class/productbatch.class.php +++ b/htdocs/product/class/productbatch.class.php @@ -446,7 +446,7 @@ class Productbatch extends CommonObject * @param int $fk_product_stock id product_stock for objet * @param int $with_qty 1 = doesn't return line with 0 quantity * @param int $fk_product If set to a product id, get eatby and sellby from table llx_product_lot - * @return array|int <0 if KO, array of batch + * @return array|int Return integer <0 if KO, array of batch */ public static function findAll($dbs, $fk_product_stock, $with_qty = 0, $fk_product = 0) { @@ -548,7 +548,7 @@ class Productbatch extends CommonObject * @param int $qty_min [=NULL] Minimum quantity * @param string $sortfield [=NULL] List of sort fields, separated by comma. Example: 't1.fielda,t2.fieldb' * @param string $sortorder [=NULL] Sort order, separated by comma. Example: 'ASC,DESC'; - * @return int|array <0 if KO, array of batch + * @return int|array Return integer <0 if KO, array of batch * * @throws Exception */ diff --git a/htdocs/product/class/productcustomerprice.class.php b/htdocs/product/class/productcustomerprice.class.php index 392ba0b3aa6..255582e62c3 100644 --- a/htdocs/product/class/productcustomerprice.class.php +++ b/htdocs/product/class/productcustomerprice.class.php @@ -811,7 +811,7 @@ class ProductCustomerPrice extends CommonObject * * @param User $user User that modifies * @param int $forceupdateaffiliate update price on each soc child - * @return int <0 if KO, 0 = action disabled, >0 if OK + * @return int Return integer <0 if KO, 0 = action disabled, >0 if OK */ public function setPriceOnAffiliateThirdparty($user, $forceupdateaffiliate) { diff --git a/htdocs/product/class/productfournisseurprice.class.php b/htdocs/product/class/productfournisseurprice.class.php index 29a242b0238..a8b2f56c553 100644 --- a/htdocs/product/class/productfournisseurprice.class.php +++ b/htdocs/product/class/productfournisseurprice.class.php @@ -424,7 +424,7 @@ class ProductFournisseurPrice extends CommonObject * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function validate($user, $notrigger = 0) { @@ -566,7 +566,7 @@ class ProductFournisseurPrice extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancel($user, $notrigger = 0) { @@ -583,7 +583,7 @@ class ProductFournisseurPrice extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { diff --git a/htdocs/product/dynamic_price/class/price_expression.class.php b/htdocs/product/dynamic_price/class/price_expression.class.php index 8c237b0d1bd..ed4f30b099f 100644 --- a/htdocs/product/dynamic_price/class/price_expression.class.php +++ b/htdocs/product/dynamic_price/class/price_expression.class.php @@ -127,7 +127,7 @@ class PriceExpression * Load object in memory from the database * * @param int $id Id object - * @return int < 0 if KO, 0 if OK but not found, > 0 if OK + * @return int Return integer < 0 if KO, 0 if OK but not found, > 0 if OK */ public function fetch($id) { @@ -199,7 +199,7 @@ class PriceExpression * Returns any existing rowid with specified title * * @param String $title Title of expression - * @return int < 0 if KO, 0 if OK but not found, > 0 rowid + * @return int Return integer < 0 if KO, 0 if OK but not found, > 0 rowid */ public function find_title($title) { 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 d6575223866..d9d7a340551 100644 --- a/htdocs/product/dynamic_price/class/price_global_variable.class.php +++ b/htdocs/product/dynamic_price/class/price_global_variable.class.php @@ -138,7 +138,7 @@ class PriceGlobalVariable * Load object in memory from the database * * @param int $id Id object - * @return int < 0 if KO, 0 if OK but not found, > 0 if OK + * @return int Return integer < 0 if KO, 0 if OK but not found, > 0 if OK */ public function fetch($id) { 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 d3fc23e7357..5b7aee5d5f6 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 @@ -154,7 +154,7 @@ class PriceGlobalVariableUpdater * Load object in memory from the database * * @param int $id Id object - * @return int < 0 if KO, 0 if OK but not found, > 0 if OK + * @return int Return integer < 0 if KO, 0 if OK but not found, > 0 if OK */ public function fetch($id) { @@ -445,7 +445,7 @@ class PriceGlobalVariableUpdater /** * Handles the processing of this updater * - * @return int <0 if KO, 0 if OK but no global variable found, >0 if OK + * @return int Return integer <0 if KO, 0 if OK but no global variable found, >0 if OK */ public function process() { diff --git a/htdocs/product/stock/class/mouvementstock.class.php b/htdocs/product/stock/class/mouvementstock.class.php index fc1baf52648..7c018077e5d 100644 --- a/htdocs/product/stock/class/mouvementstock.class.php +++ b/htdocs/product/stock/class/mouvementstock.class.php @@ -182,7 +182,7 @@ class MouvementStock extends CommonObject * @param int $disablestockchangeforsubproduct Disable stock change for sub-products of kit (usefull only if product is a subproduct) * @param int $donotcleanemptylines Do not clean lines in stock table with qty=0 (because we want to have this done by the caller) * @param boolean $force_update_batch Allows to add batch stock movement even if $product doesn't use batch anymore - * @return int <0 if KO, 0 if fk_product is null or product id does not exists, >0 if OK + * @return int Return integer <0 if KO, 0 if fk_product is null or product id does not exists, >0 if OK */ public function _create($user, $fk_product, $entrepot_id, $qty, $type, $price = 0, $label = '', $inventorycode = '', $datem = '', $eatby = '', $sellby = '', $batch = '', $skip_batch = false, $id_product_batch = 0, $disablestockchangeforsubproduct = 0, $donotcleanemptylines = 0, $force_update_batch = false) { @@ -752,7 +752,7 @@ class MouvementStock extends CommonObject * @param string $label Label of movement * @param string $inventorycode Inventory code * @param integer|string $datem Force date of movement - * @return int <0 if KO, 0 if OK + * @return int Return integer <0 if KO, 0 if OK */ private function _createSubProduct($user, $idProduct, $entrepot_id, $qty, $type, $price = 0, $label = '', $inventorycode = '', $datem = '') { @@ -893,7 +893,7 @@ class MouvementStock extends CommonObject * - int if row id of product_batch table (for update) * - or complete array('fk_product_stock'=>, 'batchnumber'=>) * @param int $qty Quantity of product with batch number. May be a negative amount. - * @return int <0 if KO, -2 if we try to update a product_batchid that does not exist, else return productbatch id + * @return int Return integer <0 if KO, -2 if we try to update a product_batchid that does not exist, else return productbatch id */ private function createBatch($dluo, $qty) { @@ -1258,7 +1258,7 @@ class MouvementStock extends CommonObject * * @param int $fk_product Product id * @param string $batch batch number - * @return int <0 if KO, number of equipments found if OK + * @return int Return integer <0 if KO, number of equipments found if OK */ private function getBatchCount($fk_product, $batch) { diff --git a/htdocs/product/stock/class/productlot.class.php b/htdocs/product/stock/class/productlot.class.php index 284cf791dbd..34204e86d5d 100644 --- a/htdocs/product/stock/class/productlot.class.php +++ b/htdocs/product/stock/class/productlot.class.php @@ -179,7 +179,7 @@ class Productlot extends CommonObject * Check sell or eat by date is mandatory * * @param string $onlyFieldName [=''] check all fields by default or only one field name ("sellby", "eatby") - * @return int <0 if KO, 0 nothing done, >0 if OK + * @return int Return integer <0 if KO, 0 nothing done, >0 if OK */ public function checkSellOrEatByMandatory($onlyFieldName = '') { diff --git a/htdocs/product/stock/class/productstockentrepot.class.php b/htdocs/product/stock/class/productstockentrepot.class.php index d0435b5c60a..3aae11eced6 100644 --- a/htdocs/product/stock/class/productstockentrepot.class.php +++ b/htdocs/product/stock/class/productstockentrepot.class.php @@ -242,7 +242,7 @@ class ProductStockEntrepot extends CommonObject * @param array $filter filter array * @param string $filtermode filter mode (AND or OR) * - * @return int|array <0 if KO, array if OK + * @return int|array Return integer <0 if KO, array if OK */ public function fetchAll($fk_product = '', $fk_entrepot = '', $sortorder = '', $sortfield = '', $limit = 0, $offset = 0, array $filter = array(), $filtermode = 'AND') { diff --git a/htdocs/product/stock/massstockmove.php b/htdocs/product/stock/massstockmove.php index d542a589513..5a49139386b 100644 --- a/htdocs/product/stock/massstockmove.php +++ b/htdocs/product/stock/massstockmove.php @@ -822,7 +822,7 @@ function startsWith($haystack, $needle) * * @param Object $static_object static object to fetch * @param string $tmp_ref ref of the object to fetch - * @return int <0 if Ko or Id of object + * @return int Return integer <0 if Ko or Id of object */ function fetchref($static_object, $tmp_ref) { diff --git a/htdocs/product/stock/stocktransfer/class/stocktransfer.class.php b/htdocs/product/stock/stocktransfer/class/stocktransfer.class.php index 27e2ba6a795..d76dc386e5a 100644 --- a/htdocs/product/stock/stocktransfer/class/stocktransfer.class.php +++ b/htdocs/product/stock/stocktransfer/class/stocktransfer.class.php @@ -549,7 +549,7 @@ class StockTransfer extends CommonObject * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function validate($user, $notrigger = 0) { @@ -706,7 +706,7 @@ class StockTransfer extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancel($user, $notrigger = 0) { @@ -730,7 +730,7 @@ class StockTransfer extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { diff --git a/htdocs/product/stock/stocktransfer/class/stocktransferline.class.php b/htdocs/product/stock/stocktransfer/class/stocktransferline.class.php index bc01268fb2c..d00755525c4 100644 --- a/htdocs/product/stock/stocktransfer/class/stocktransferline.class.php +++ b/htdocs/product/stock/stocktransfer/class/stocktransferline.class.php @@ -528,7 +528,7 @@ class StockTransferLine extends CommonObjectLine * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function validate($user, $notrigger = 0) { @@ -685,7 +685,7 @@ class StockTransferLine extends CommonObjectLine * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancel($user, $notrigger = 0) { @@ -709,7 +709,7 @@ class StockTransferLine extends CommonObjectLine * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { diff --git a/htdocs/projet/class/project.class.php b/htdocs/projet/class/project.class.php index b26f84eb0a3..372e3510fcf 100644 --- a/htdocs/projet/class/project.class.php +++ b/htdocs/projet/class/project.class.php @@ -399,7 +399,7 @@ class Project extends CommonObject * * @param User $user User making creation * @param int $notrigger Disable triggers - * @return int <0 if KO, id of created project if OK + * @return int Return integer <0 if KO, id of created project if OK */ public function create($user, $notrigger = 0) { @@ -545,7 +545,7 @@ class Project extends CommonObject * * @param User $user User object of making update * @param int $notrigger 1=Disable all triggers - * @return int <=0 if KO, >0 if OK + * @return int Return integer <=0 if KO, >0 if OK */ public function update($user, $notrigger = 0) { @@ -923,7 +923,7 @@ class Project extends CommonObject * * @param User $user User * @param int $notrigger Disable triggers - * @return int <0 if KO, 0 if not possible, >0 if OK + * @return int Return integer <0 if KO, 0 if not possible, >0 if OK */ public function delete($user, $notrigger = 0) { @@ -1125,7 +1125,7 @@ class Project extends CommonObject * Delete tasks with no children first, then task with children recursively * * @param User $user User - * @return int <0 if KO, 1 if OK + * @return int Return integer <0 if KO, 1 if OK */ public function deleteTasks($user) { @@ -1158,7 +1158,7 @@ class Project extends CommonObject * * @param User $user User that validate * @param int $notrigger 1=Disable triggers - * @return int <0 if KO, 0=Nothing done, >0 if KO + * @return int Return integer <0 if KO, 0=Nothing done, >0 if KO */ public function setValid($user, $notrigger = 0) { @@ -1218,7 +1218,7 @@ class Project extends CommonObject * Close a project * * @param User $user User that close project - * @return int <0 if KO, 0 if already closed, >0 if OK + * @return int Return integer <0 if KO, 0 if already closed, >0 if OK */ public function setClose($user) { @@ -2075,7 +2075,7 @@ class Project extends CommonObject * @param int $datestart First day of week (use dol_get_first_day to find this date) * @param int $taskid Filter on a task id * @param int $userid Time spent by a particular user - * @return int <0 if OK, >0 if KO + * @return int Return integer <0 if OK, >0 if KO */ public function loadTimeSpent($datestart, $taskid = 0, $userid = 0) { @@ -2139,7 +2139,7 @@ class Project extends CommonObject * @param int $datestart First day of week (use dol_get_first_day to find this date) * @param int $taskid Filter on a task id * @param int $userid Time spent by a particular user - * @return int <0 if OK, >0 if KO + * @return int Return integer <0 if OK, >0 if KO */ public function loadTimeSpentMonth($datestart, $taskid = 0, $userid = 0) { @@ -2204,7 +2204,7 @@ class Project extends CommonObject * Load indicators for dashboard (this->nbtodo and this->nbtodolate) * * @param User $user Objet user - * @return WorkboardResponse|int <0 if KO, WorkboardResponse if OK + * @return WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK */ public function load_board($user) { diff --git a/htdocs/projet/class/task.class.php b/htdocs/projet/class/task.class.php index ec4b8d2696c..37e01f8d445 100644 --- a/htdocs/projet/class/task.class.php +++ b/htdocs/projet/class/task.class.php @@ -409,7 +409,7 @@ class Task extends CommonObjectLine * * @param User $user User that modify * @param int $notrigger 0=launch triggers after, 1=disable triggers - * @return int <=0 if KO, >0 if OK + * @return int Return integer <=0 if KO, >0 if OK */ public function update($user = null, $notrigger = 0) { @@ -678,7 +678,7 @@ class Task extends CommonObjectLine /** * Return nb of children * - * @return int <0 if KO, 0 if no children, >0 if OK + * @return int Return integer <0 if KO, 0 if no children, >0 if OK */ public function hasChildren() { @@ -712,7 +712,7 @@ class Task extends CommonObjectLine /** * Return nb of time spent * - * @return int <0 if KO, 0 if no children, >0 if OK + * @return int Return integer <0 if KO, 0 if no children, >0 if OK */ public function hasTimeSpent() { @@ -1283,7 +1283,7 @@ class Task extends CommonObjectLine * * @param User $user User object * @param int $notrigger 0=launch triggers after, 1=disable triggers - * @return int <=0 if KO, >0 if OK + * @return int Return integer <=0 if KO, >0 if OK */ public function addTimeSpent($user, $notrigger = 0) { @@ -1395,7 +1395,7 @@ class Task extends CommonObjectLine * Fetch records of time spent of this task * * @param string $morewherefilter Add more filter into where SQL request (must start with ' AND ...') - * @return int <0 if KO, array of time spent if OK + * @return int Return integer <0 if KO, array of time spent if OK */ public function fetchTimeSpentOnTask($morewherefilter = '') { @@ -1637,7 +1637,7 @@ class Task extends CommonObjectLine * * @param User $userobj User object * @param string $morewherefilter Add more filter into where SQL request (must start with ' AND ...') - * @return array|int <0 if KO, array of time spent if OK + * @return array|int Return integer <0 if KO, array of time spent if OK */ public function fetchAllTimeSpent(User $userobj, $morewherefilter = '') { @@ -2258,7 +2258,7 @@ class Task extends CommonObjectLine * Load indicators for dashboard (this->nbtodo and this->nbtodolate) * * @param User $user Objet user - * @return WorkboardResponse|int <0 if KO, WorkboardResponse if OK + * @return WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK */ public function load_board($user) { @@ -2333,7 +2333,7 @@ class Task extends CommonObjectLine /** * Charge indicateurs this->nb de tableau de bord * - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok */ public function load_state_board() { diff --git a/htdocs/reception/class/reception.class.php b/htdocs/reception/class/reception.class.php index 3e2f6b0a7c8..24a91e4785b 100644 --- a/htdocs/reception/class/reception.class.php +++ b/htdocs/reception/class/reception.class.php @@ -209,7 +209,7 @@ class Reception extends CommonObject * * @param User $user Objet du user qui cree * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <0 si erreur, id reception creee si ok + * @return int Return integer <0 si erreur, id reception creee si ok */ public function create($user, $notrigger = 0) { @@ -489,7 +489,7 @@ class Reception extends CommonObject * * @param User $user Object user that validate * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <0 if OK, >0 if KO + * @return int Return integer <0 if OK, >0 if KO */ public function valid($user, $notrigger = 0) { @@ -715,7 +715,7 @@ class Reception extends CommonObject /** * Get status from all dispatched lines * - * @return int <0 if KO, Status of reception if OK + * @return int Return integer <0 if KO, Status of reception if OK */ public function getStatusDispatch() { @@ -817,7 +817,7 @@ class Reception extends CommonObject * @param integer $sellby sell-by date * @param string $batch Lot number * @param double $cost_price Line cost - * @return int <0 if KO, index of line if OK + * @return int Return integer <0 if KO, index of line if OK */ public function addline($entrepot_id, $id, $qty, $array_options = 0, $comment = '', $eatby = '', $sellby = '', $batch = '', $cost_price = 0) { @@ -1678,7 +1678,7 @@ class Reception extends CommonObject /** * Classify the reception as invoiced (used for exemple by trigger when WORKFLOW_RECEPTION_CLASSIFY_BILLED_INVOICE is on) * - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok */ public function setBilled() { @@ -1722,7 +1722,7 @@ class Reception extends CommonObject /** * Classify the reception as validated/opened * - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok */ public function reOpen() { diff --git a/htdocs/recruitment/class/recruitmentcandidature.class.php b/htdocs/recruitment/class/recruitmentcandidature.class.php index 44d2576507b..e2404de315f 100644 --- a/htdocs/recruitment/class/recruitmentcandidature.class.php +++ b/htdocs/recruitment/class/recruitmentcandidature.class.php @@ -480,7 +480,7 @@ class RecruitmentCandidature extends CommonObject * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function validate($user, $notrigger = 0) { @@ -637,7 +637,7 @@ class RecruitmentCandidature extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancel($user, $notrigger = 0) { @@ -661,7 +661,7 @@ class RecruitmentCandidature extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { diff --git a/htdocs/recruitment/class/recruitmentjobposition.class.php b/htdocs/recruitment/class/recruitmentjobposition.class.php index 4c6261ceac0..131533908e4 100644 --- a/htdocs/recruitment/class/recruitmentjobposition.class.php +++ b/htdocs/recruitment/class/recruitmentjobposition.class.php @@ -495,7 +495,7 @@ class RecruitmentJobPosition extends CommonObject * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function validate($user, $notrigger = 0) { @@ -652,7 +652,7 @@ class RecruitmentJobPosition extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancel($user, $notrigger = 0) { @@ -763,7 +763,7 @@ class RecruitmentJobPosition extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { diff --git a/htdocs/resource/class/dolresource.class.php b/htdocs/resource/class/dolresource.class.php index 3d660697e92..6286b4dcf06 100644 --- a/htdocs/resource/class/dolresource.class.php +++ b/htdocs/resource/class/dolresource.class.php @@ -507,7 +507,7 @@ class Dolresource extends CommonObject * @param int $limit limit page * @param int $offset page * @param array $filter filter output - * @return int <0 if KO, Number of lines loaded if OK + * @return int Return integer <0 if KO, Number of lines loaded if OK */ public function fetchAll($sortorder, $sortfield, $limit, $offset, $filter = '') { diff --git a/htdocs/salaries/class/paymentsalary.class.php b/htdocs/salaries/class/paymentsalary.class.php index 030f9b41e9f..6cc6a576d74 100644 --- a/htdocs/salaries/class/paymentsalary.class.php +++ b/htdocs/salaries/class/paymentsalary.class.php @@ -163,7 +163,7 @@ class PaymentSalary extends CommonObject * * @param User $user User making payment * @param int $closepaidcontrib 1=Also close payed contributions to paid, 0=Do nothing more - * @return int <0 if KO, id of payment if OK + * @return int Return integer <0 if KO, id of payment if OK */ public function create($user, $closepaidcontrib = 0) { @@ -704,7 +704,7 @@ class PaymentSalary extends CommonObject * Old name of function is update_date() * * @param int $date New date - * @return int <0 if KO, 0 if OK + * @return int Return integer <0 if KO, 0 if OK */ public function updatePaymentDate($date) { diff --git a/htdocs/salaries/class/salary.class.php b/htdocs/salaries/class/salary.class.php index 24c1a3f0ac3..1189fc31fdc 100644 --- a/htdocs/salaries/class/salary.class.php +++ b/htdocs/salaries/class/salary.class.php @@ -828,7 +828,7 @@ class Salary extends CommonObject * @param string $type 'direct-debit' or 'bank-transfer' * @param string $sourcetype Source ('facture' or 'supplier_invoice') * @param int $checkduplicateamongall 0=Default (check among open requests only to find if request already exists). 1=Check also among requests completely processed and cancel if at least 1 request exists whatever is its status. - * @return int <0 if KO, 0 if a request already exists, >0 if OK + * @return int Return integer <0 if KO, 0 if a request already exists, >0 if OK */ public function demande_prelevement($fuser, $amount = 0, $type = 'direct-debit', $sourcetype = 'salaire', $checkduplicateamongall = 0) { @@ -945,7 +945,7 @@ class Salary extends CommonObject * * @param User $fuser User making delete * @param int $did ID of request to delete - * @return int <0 if OK, >0 if KO + * @return int Return integer <0 if OK, >0 if KO */ public function demande_prelevement_delete($fuser, $did) { diff --git a/htdocs/societe/class/companybankaccount.class.php b/htdocs/societe/class/companybankaccount.class.php index 2f83e7951c6..37e63bba1d6 100644 --- a/htdocs/societe/class/companybankaccount.class.php +++ b/htdocs/societe/class/companybankaccount.class.php @@ -254,7 +254,7 @@ class CompanyBankAccount extends Account * * @param User|null $user User * @param int $notrigger 1=Disable triggers - * @return int <0 if KO, > 0 if OK (ID of newly created company bank account information) + * @return int Return integer <0 if KO, > 0 if OK (ID of newly created company bank account information) */ public function create(User $user = null, $notrigger = 0) { @@ -328,7 +328,7 @@ class CompanyBankAccount extends Account * * @param User|null $user Object user * @param int $notrigger 1=Disable triggers - * @return int <=0 if KO, >0 if OK + * @return int Return integer <=0 if KO, >0 if OK */ public function update(User $user = null, $notrigger = 0) { diff --git a/htdocs/societe/class/societe.class.php b/htdocs/societe/class/societe.class.php index 1bec8fba579..341c3e4124e 100644 --- a/htdocs/societe/class/societe.class.php +++ b/htdocs/societe/class/societe.class.php @@ -1310,7 +1310,7 @@ class Societe extends CommonObject * @param int $allowmodcodefournisseur Inclut modif code fournisseur et code compta fournisseur * @param string $action 'add' or 'update' or 'merge' * @param int $nosyncmember Do not synchronize info of linked member - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function update($id, $user = '', $call_trigger = 1, $allowmodcodeclient = 0, $allowmodcodefournisseur = 0, $action = 'update', $nosyncmember = 1) { @@ -2061,7 +2061,7 @@ class Societe extends CommonObject * @param int $id Id of third party to delete * @param User|null $fuser User who ask to delete thirdparty * @param int $call_trigger 0=No, 1=yes - * @return int <0 if KO, 0 if nothing done, >0 if OK + * @return int Return integer <0 if KO, 0 if nothing done, >0 if OK */ public function delete($id, User $fuser = null, $call_trigger = 1) { @@ -2384,7 +2384,7 @@ class Societe extends CommonObject * @param string $vatrate VAT rate (may contain the vat code too). Exemple: '1.23', '1.23 (ABC)', ... * @param int $discount_type 0 => customer discount, 1 => supplier discount * @param string $price_base_type Price base type 'HT' or 'TTC' - * @return int <0 if KO, id of discount record if OK + * @return int Return integer <0 if KO, id of discount record if OK */ public function set_remise_except($remise, User $user, $desc, $vatrate = '', $discount_type = 0, $price_base_type = 'HT') { @@ -2455,7 +2455,7 @@ class Societe extends CommonObject * @param string $filter Other filter * @param integer $maxvalue Filter on max value for discount * @param int $discount_type 0 => customer discount, 1 => supplier discount - * @return int <0 if KO, Credit note amount otherwise + * @return int Return integer <0 if KO, Credit note amount otherwise */ public function getAvailableDiscounts($user = '', $filter = '', $maxvalue = 0, $discount_type = 0) { @@ -2581,7 +2581,7 @@ class Societe extends CommonObject * * @param User $user Object user * @param int $commid Id of user - * @return int <=0 if KO, >0 if OK + * @return int Return integer <=0 if KO, >0 if OK */ public function add_commercial(User $user, $commid) { @@ -3657,7 +3657,7 @@ class Societe extends CommonObject * @param int $idparent Id of thirdparty to check * @param int $idchild Id of thirdparty to compare to * @param int $counter Counter to protect against infinite loops - * @return int <0 if KO, 0 if OK or 1 if at some level a parent company was the child to compare to + * @return int Return integer <0 if KO, 0 if OK or 1 if at some level a parent company was the child to compare to */ public function validateFamilyTree($idparent, $idchild, $counter = 0) { @@ -3823,7 +3823,7 @@ class Societe extends CommonObject * * @param int $idprof 1,2,3,4 (Exemple: 1=siren,2=siret,3=naf,4=rcs/rm) * @param Societe $soc Objet societe - * @return int <=0 if KO, >0 if OK + * @return int Return integer <=0 if KO, >0 if OK * TODO better to have this in a lib than into a business class */ public function id_prof_check($idprof, $soc) @@ -4334,7 +4334,7 @@ class Societe extends CommonObject * @param string $socname Name of third party to force * @param string $socalias Alias name of third party to force * @param string $customercode Customer code - * @return int <0 if KO, id of created account if OK + * @return int Return integer <0 if KO, id of created account if OK */ public function create_from_member(Adherent $member, $socname = '', $socalias = '', $customercode = '') { @@ -5223,7 +5223,7 @@ class Societe extends CommonObject * * @param string $type It can be only 'buy' or 'sell' * @param string $value Accountancy code - * @return int <0 KO >0 OK + * @return int Return integer <0 KO >0 OK */ public function setAccountancyCode($type, $value) { diff --git a/htdocs/supplier_proposal/class/supplier_proposal.class.php b/htdocs/supplier_proposal/class/supplier_proposal.class.php index 2169bf4e3f1..0b893ccfe28 100644 --- a/htdocs/supplier_proposal/class/supplier_proposal.class.php +++ b/htdocs/supplier_proposal/class/supplier_proposal.class.php @@ -872,7 +872,7 @@ class SupplierProposal extends CommonObject * * @param User $user User that create * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function create($user, $notrigger = 0) { @@ -1386,7 +1386,7 @@ class SupplierProposal extends CommonObject * * @param User $user Object user that validate * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function valid($user, $notrigger = 0) { @@ -1507,7 +1507,7 @@ class SupplierProposal extends CommonObject * * @param User $user Object user that modify * @param int $delivery_date Delivery date - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok * @deprecated Use setDeliveryDate */ public function set_date_livraison($user, $delivery_date) @@ -1521,7 +1521,7 @@ class SupplierProposal extends CommonObject * * @param User $user Object user that modify * @param int $delivery_date Delivery date - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok */ public function setDeliveryDate($user, $delivery_date) { @@ -1548,7 +1548,7 @@ class SupplierProposal extends CommonObject * * @param User $user Object user that modify * @param double $remise Amount discount - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok */ /* public function set_remise_percent($user, $remise) @@ -1581,7 +1581,7 @@ class SupplierProposal extends CommonObject * * @param User $user Object user that modify * @param double $remise Amount discount - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok */ /* public function set_remise_absolue($user, $remise) @@ -2210,7 +2210,7 @@ class SupplierProposal extends CommonObject * * @param User $user Object user * @param string $mode "opened" for askprice to close, "signed" for proposal to invoice - * @return WorkboardResponse|int <0 if KO, WorkboardResponse if OK + * @return WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK */ public function load_board($user, $mode) { @@ -2367,7 +2367,7 @@ class SupplierProposal extends CommonObject /** * Load indicator this->nb of global stats widget * - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok */ public function load_state_board() { @@ -3254,7 +3254,7 @@ class SupplierProposalLine extends CommonObjectLine * Update propal line object into DB * * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok */ public function update($notrigger = 0) { @@ -3405,7 +3405,7 @@ class SupplierProposalLine extends CommonObjectLine * Update DB line fields total_xxx * Used by migration * - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok */ public function update_total() { diff --git a/htdocs/ticket/class/ticket.class.php b/htdocs/ticket/class/ticket.class.php index f816fc2a3e7..9ffbc59cc98 100644 --- a/htdocs/ticket/class/ticket.class.php +++ b/htdocs/ticket/class/ticket.class.php @@ -1597,7 +1597,7 @@ class Ticket extends CommonObject * * @param User $user Object user * @param int $notrigger No trigger - * @return int <0 if KO, 0=nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=nothing done, >0 if OK */ public function markAsRead($user, $notrigger = 0) { @@ -1655,7 +1655,7 @@ class Ticket extends CommonObject * @param User $user Object user * @param int $id_assign_user ID of user assigned * @param int $notrigger Disable trigger - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function assignUser($user, $id_assign_user, $notrigger = 0) { @@ -1853,7 +1853,7 @@ class Ticket extends CommonObject * * @param User $user User that close * @param int $mode 0=Close solved, 1=Close abandonned - * @return int <0 if KO, 0=nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=nothing done, >0 if OK */ public function close(User $user, $mode = 0) { @@ -2532,7 +2532,7 @@ class Ticket extends CommonObject * @param int $public_area 0=Default, * 1=If we are creating the message from a public area, so confirmation email will be sent to the author * and we can search contact from email to add it as contact of ticket if TICKET_ASSIGN_CONTACT_TO_MESSAGE is set - * @return int <0 if KO, >= 0 if OK + * @return int Return integer <0 if KO, >= 0 if OK */ public function newMessage($user, &$action, $private = 1, $public_area = 0) { @@ -2980,7 +2980,7 @@ class Ticket extends CommonObject * * @param User $user Object user * @param int $mode "opened" for askprice to close, "signed" for proposal to invoice - * @return WorkboardResponse|int <0 if KO, WorkboardResponse if OK + * @return WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK */ public function load_board($user, $mode) { @@ -3047,7 +3047,7 @@ class Ticket extends CommonObject /** * Load indicator this->nb of global stats widget * - * @return int <0 if ko, >0 if ok + * @return int Return integer <0 if ko, >0 if ok */ public function load_state_board() { diff --git a/htdocs/user/class/user.class.php b/htdocs/user/class/user.class.php index bd84a2fa42f..d65319923ea 100644 --- a/htdocs/user/class/user.class.php +++ b/htdocs/user/class/user.class.php @@ -427,7 +427,7 @@ class User extends CommonObject * @param string $email If defined, email to used for search * @param int $fk_socpeople If defined, id of contact for search * @param int $use_email_oauth2 1=Use also email_oauth2 to fetch on email - * @return int <0 if KO, 0 not found, >0 if OK + * @return int Return integer <0 if KO, 0 not found, >0 if OK */ public function fetch($id = 0, $login = '', $sid = '', $loadpersonalconf = 0, $entity = -1, $email = '', $fk_socpeople = 0, $use_email_oauth2 = 0) { @@ -1397,7 +1397,7 @@ class User extends CommonObject * Change status of a user * * @param int $status Status to set - * @return int <0 if KO, 0 if nothing is done, >0 if OK + * @return int Return integer <0 if KO, 0 if nothing is done, >0 if OK */ public function setstatus($status) { @@ -1555,7 +1555,7 @@ class User extends CommonObject * * @param User $user Objet user doing creation * @param int $notrigger 1=do not execute triggers, 0 otherwise - * @return int <0 if KO, id of created user if OK + * @return int Return integer <0 if KO, id of created user if OK */ public function create($user, $notrigger = 0) { @@ -1700,7 +1700,7 @@ class User extends CommonObject * @param Contact $contact Object for source contact * @param string $login Login to force * @param string $password Password to force - * @return int <0 if error, if OK returns id of created user + * @return int Return integer <0 if error, if OK returns id of created user */ public function create_from_contact($contact, $login = '', $password = '') { @@ -1786,7 +1786,7 @@ class User extends CommonObject * * @param Adherent $member Object member source * @param string $login Login to force - * @return int <0 if KO, if OK, return id of created account + * @return int Return integer <0 if KO, if OK, return id of created account */ public function create_from_member($member, $login = '') { @@ -1920,7 +1920,7 @@ class User extends CommonObject * @param int $nosyncmember 0=Synchronize linked member (standard info), 1=Do not synchronize linked member * @param int $nosyncmemberpass 0=Synchronize linked member (password), 1=Do not synchronize linked member * @param int $nosynccontact 0=Synchronize linked contact, 1=Do not synchronize linked contact - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function update($user, $notrigger = 0, $nosyncmember = 0, $nosyncmemberpass = 0, $nosynccontact = 0) { @@ -2272,7 +2272,7 @@ class User extends CommonObject * Mise a jour en base de la date de derniere connexion d'un utilisateur * Fonction appelee lors d'une nouvelle connexion * - * @return int <0 si echec, >=0 si ok + * @return int Return integer <0 si echec, >=0 si ok */ public function update_last_login_date() { @@ -2456,7 +2456,7 @@ class User extends CommonObject * @param User $user Object user that send the email (not the user we send to) @todo object $user is not used ! * @param string $password New password * @param int $changelater 0=Send clear passwod into email, 1=Change password only after clicking on confirm email. @todo Add method 2 = Send link to reset password - * @return int < 0 si erreur, > 0 si ok + * @return int Return integer < 0 si erreur, > 0 si ok */ public function send_password($user, $password = '', $changelater = 0) { @@ -3805,7 +3805,7 @@ class User extends CommonObject * * @param int $id_user id_user entry to update * @param int $protection Deep counter to avoid infinite loop (no more required, a protection is added with array useridfound) - * @return int < 0 if KO (infinit loop), >= 0 if OK + * @return int Return integer < 0 if KO (infinit loop), >= 0 if OK */ public function build_path_from_id_user($id_user, $protection = 0) { @@ -4104,7 +4104,7 @@ class User extends CommonObject * to disable exact e-mail search * * @param string $email The full e-mail (or a part of a e-mail) - * @return int <0 = user was not found, >0 = The id of the user + * @return int Return integer <0 = user was not found, >0 = The id of the user */ public function findUserIdByEmail($email) { diff --git a/htdocs/user/class/userbankaccount.class.php b/htdocs/user/class/userbankaccount.class.php index bdf232d3b9a..9a43479e2da 100644 --- a/htdocs/user/class/userbankaccount.class.php +++ b/htdocs/user/class/userbankaccount.class.php @@ -87,7 +87,7 @@ class UserBankAccount extends Account * * @param User|null $user User * @param int $notrigger 1=Disable triggers - * @return int <0 if KO, >= 0 if OK + * @return int Return integer <0 if KO, >= 0 if OK */ public function create(User $user = null, $notrigger = 0) { @@ -115,7 +115,7 @@ class UserBankAccount extends Account * * @param User|null $user Object user * @param int $notrigger 1=Disable triggers - * @return int <=0 if KO, >0 if OK + * @return int Return integer <=0 if KO, >0 if OK */ public function update(User $user = null, $notrigger = 0) { diff --git a/htdocs/user/class/usergroup.class.php b/htdocs/user/class/usergroup.class.php index d7a0980c914..99ca4fbc593 100644 --- a/htdocs/user/class/usergroup.class.php +++ b/htdocs/user/class/usergroup.class.php @@ -568,7 +568,7 @@ class UserGroup extends CommonObject * Charge dans l'objet group, la liste des permissions auquels le groupe a droit * * @param string $moduletag Name of module we want permissions ('' means all) - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function getrights($moduletag = '') { @@ -656,7 +656,7 @@ class UserGroup extends CommonObject * Delete a group * * @param User $user User that delete - * @return int <0 if KO, > 0 if OK + * @return int Return integer <0 if KO, > 0 if OK */ public function delete(User $user) { @@ -667,7 +667,7 @@ class UserGroup extends CommonObject * Create group into database * * @param int $notrigger 0=triggers enabled, 1=triggers disabled - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function create($notrigger = 0) { @@ -689,7 +689,7 @@ class UserGroup extends CommonObject * Update group into database * * @param int $notrigger 0=triggers enabled, 1=triggers disabled - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function update($notrigger = 0) { diff --git a/htdocs/variants/class/ProductAttribute.class.php b/htdocs/variants/class/ProductAttribute.class.php index 6fd0fbe6c93..cf2404301da 100644 --- a/htdocs/variants/class/ProductAttribute.class.php +++ b/htdocs/variants/class/ProductAttribute.class.php @@ -196,7 +196,7 @@ class ProductAttribute extends CommonObject * * @param User $user Object user * @param int $notrigger Do not execute trigger - * @return int <0 KO, Id of new variant if OK + * @return int Return integer <0 KO, Id of new variant if OK */ public function create(User $user, $notrigger = 0) { @@ -274,7 +274,7 @@ class ProductAttribute extends CommonObject * Fetches the properties of a product attribute * * @param int $id Attribute id - * @return int <1 KO, >1 OK + * @return int Return integer <1 KO, >1 OK */ public function fetch($id) { @@ -366,7 +366,7 @@ class ProductAttribute extends CommonObject * * @param User $user Object user * @param int $notrigger Do not execute trigger - * @return int <0 KO, >0 OK + * @return int Return integer <0 KO, >0 OK */ public function update(User $user, $notrigger = 0) { @@ -437,7 +437,7 @@ class ProductAttribute extends CommonObject * * @param User $user Object user * @param int $notrigger Do not execute trigger - * @return int <0 KO, >0 OK + * @return int Return integer <0 KO, >0 OK */ public function delete(User $user, $notrigger = 0) { @@ -827,7 +827,7 @@ class ProductAttribute extends CommonObject /** * Test if used by a product * - * @return int <0 KO, =0 if No, =1 if Yes + * @return int Return integer <0 KO, =0 if No, =1 if Yes */ public function isUsed() { @@ -976,7 +976,7 @@ class ProductAttribute extends CommonObject * Update a attribute to have a higher position * * @param int $rowid Id of line - * @return int <0 KO, >0 OK + * @return int Return integer <0 KO, >0 OK */ public function attributeMoveUp($rowid) { @@ -995,7 +995,7 @@ class ProductAttribute extends CommonObject * Update a attribute to have a lower position * * @param int $rowid Id of line - * @return int <0 KO, >0 OK + * @return int Return integer <0 KO, >0 OK */ public function attributeMoveDown($rowid) { diff --git a/htdocs/variants/class/ProductAttributeValue.class.php b/htdocs/variants/class/ProductAttributeValue.class.php index 5cd32e9fa3b..4d4dc87f74a 100644 --- a/htdocs/variants/class/ProductAttributeValue.class.php +++ b/htdocs/variants/class/ProductAttributeValue.class.php @@ -133,7 +133,7 @@ class ProductAttributeValue extends CommonObjectLine * * @param User $user Object user * @param int $notrigger Do not execute trigger - * @return int <0 KO >0 OK + * @return int Return integer <0 KO >0 OK */ public function create(User $user, $notrigger = 0) { @@ -209,7 +209,7 @@ class ProductAttributeValue extends CommonObjectLine * Gets a product attribute value * * @param int $id Product attribute value id - * @return int <0 KO, >0 OK + * @return int Return integer <0 KO, >0 OK */ public function fetch($id) { @@ -386,7 +386,7 @@ class ProductAttributeValue extends CommonObjectLine * * @param User $user Object user * @param int $notrigger Do not execute trigger - * @return int <0 KO, >0 OK + * @return int Return integer <0 KO, >0 OK */ public function delete(User $user, $notrigger = 0) { @@ -448,7 +448,7 @@ class ProductAttributeValue extends CommonObjectLine /** * Test if used by a product * - * @return int <0 KO, =0 if No, =1 if Yes + * @return int Return integer <0 KO, =0 if No, =1 if Yes */ public function isUsed() { diff --git a/htdocs/variants/class/ProductCombination.class.php b/htdocs/variants/class/ProductCombination.class.php index 1a76fafbc5d..7763146fcda 100644 --- a/htdocs/variants/class/ProductCombination.class.php +++ b/htdocs/variants/class/ProductCombination.class.php @@ -110,7 +110,7 @@ class ProductCombination * Retrieves a combination by its rowid * * @param int $rowid Row id - * @return int <0 KO, >0 OK + * @return int Return integer <0 KO, >0 OK */ public function fetch($rowid) { @@ -151,7 +151,7 @@ class ProductCombination * * @param int $fk_price_level The price level to fetch, use 0 for all * @param bool $useCache To use cache or not - * @return int <0 KO, >0 OK + * @return int Return integer <0 KO, >0 OK */ public function fetchCombinationPriceLevels($fk_price_level = 0, $useCache = true) { @@ -199,7 +199,7 @@ class ProductCombination * Retrieves combination price levels * * @param int $clean Levels of PRODUIT_MULTIPRICES_LIMIT - * @return int <0 KO, >0 OK + * @return int Return integer <0 KO, >0 OK */ public function saveCombinationPriceLevels($clean = 1) { @@ -245,7 +245,7 @@ class ProductCombination * * @param int $productid Product ID of variant * @param int $donotloadpricelevel Avoid loading price impact for each level. If PRODUIT_MULTIPRICES is not set, this has no effect. - * @return int <0 if KO, 0 if product ID is not ID of a variant product (so parent not found), >0 if OK (ID of parent) + * @return int Return integer <0 if KO, 0 if product ID is not ID of a variant product (so parent not found), >0 if OK (ID of parent) */ public function fetchByFkProductChild($productid, $donotloadpricelevel = 0) { @@ -284,7 +284,7 @@ class ProductCombination * Retrieves all product combinations by the product parent row id * * @param int $fk_product_parent Rowid of parent product - * @return int|ProductCombination[] <0 KO + * @return int|ProductCombination[] Return integer <0 KO */ public function fetchAllByFkProductParent($fk_product_parent) { @@ -384,7 +384,7 @@ class ProductCombination * Updates a product combination * * @param User $user Object user - * @return int <0 KO, >0 OK + * @return int Return integer <0 KO, >0 OK */ public function update(User $user) { @@ -451,7 +451,7 @@ class ProductCombination * * @param User $user Object user * @param int $fk_product_parent Rowid of parent product - * @return int <0 KO >0 OK + * @return int Return integer <0 KO >0 OK */ public function deleteByFkProductParent($user, $fk_product_parent) { @@ -711,7 +711,7 @@ class ProductCombination * @param bool|float $forced_weightvar If the weight variation is forced * @param bool|string $forced_refvar If the reference is forced * @param string $ref_ext External reference - * @return int <0 KO, >0 OK + * @return int Return integer <0 KO, >0 OK */ public function createProductCombination(User $user, Product $product, array $combinations, array $variations, $price_var_percent = false, $forced_pricevar = false, $forced_weightvar = false, $forced_refvar = false, $ref_ext = '') { @@ -1077,7 +1077,7 @@ class ProductCombinationLevel * Retrieves a combination level by its rowid * * @param int $rowid Row id - * @return int <0 KO, >0 OK + * @return int Return integer <0 KO, >0 OK */ public function fetch($rowid) { @@ -1135,7 +1135,7 @@ class ProductCombinationLevel * Assign vars form an stdclass like sql obj * * @param Object $obj Object resultset - * @return int <0 KO, >0 OK + * @return int Return integer <0 KO, >0 OK */ public function fetchFormObj($obj) { @@ -1156,7 +1156,7 @@ class ProductCombinationLevel /** * Save a price impact of a product combination for a price level * - * @return int <0 KO, >0 OK + * @return int Return integer <0 KO, >0 OK */ public function save() { @@ -1222,7 +1222,7 @@ class ProductCombinationLevel /** * delete * - * @return int <0 KO, >0 OK + * @return int Return integer <0 KO, >0 OK */ public function delete() { @@ -1237,7 +1237,7 @@ class ProductCombinationLevel * delete all for a combination * * @param int $fk_product_attribute_combination Id of combination - * @return int <0 KO, >0 OK + * @return int Return integer <0 KO, >0 OK */ public function deleteAllForCombination($fk_product_attribute_combination) { @@ -1252,7 +1252,7 @@ class ProductCombinationLevel * Clean not needed price levels for a combination * * @param int $fk_product_attribute_combination Id of combination - * @return int <0 KO, >0 OK + * @return int Return integer <0 KO, >0 OK */ public function clean($fk_product_attribute_combination) { diff --git a/htdocs/variants/class/ProductCombination2ValuePair.class.php b/htdocs/variants/class/ProductCombination2ValuePair.class.php index 15c2a11ddd9..6c2a2120827 100644 --- a/htdocs/variants/class/ProductCombination2ValuePair.class.php +++ b/htdocs/variants/class/ProductCombination2ValuePair.class.php @@ -95,7 +95,7 @@ class ProductCombination2ValuePair * Creates a product combination 2 value pair * * @param User $user User that create - * @return int <0 KO, >0 OK + * @return int Return integer <0 KO, >0 OK */ public function create($user) { diff --git a/htdocs/webhook/class/target.class.php b/htdocs/webhook/class/target.class.php index 5331101bd89..3030617098b 100644 --- a/htdocs/webhook/class/target.class.php +++ b/htdocs/webhook/class/target.class.php @@ -218,7 +218,7 @@ class Target extends CommonObject * * @param User $user User that creates * @param bool $notrigger false=launch triggers after, true=disable triggers - * @return int <0 if KO, ID of created object if OK + * @return int Return integer <0 if KO, ID of created object if OK */ public function create(User $user, $notrigger = false) { @@ -490,7 +490,7 @@ class Target extends CommonObject * * @param User $user User making status change * @param int $notrigger 1=Does not execute triggers, 0= execute triggers - * @return int <=0 if OK, 0=Nothing done, >0 if KO + * @return int Return integer <=0 if OK, 0=Nothing done, >0 if KO */ public function validate($user, $notrigger = 0) { @@ -647,7 +647,7 @@ class Target extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function cancel($user, $notrigger = 0) { @@ -671,7 +671,7 @@ class Target extends CommonObject * * @param User $user Object user that modify * @param int $notrigger 1=Does not execute triggers, 0=Execute triggers - * @return int <0 if KO, 0=Nothing done, >0 if OK + * @return int Return integer <0 if KO, 0=Nothing done, >0 if OK */ public function reopen($user, $notrigger = 0) { diff --git a/htdocs/website/class/website.class.php b/htdocs/website/class/website.class.php index 68b29b89346..f5a4ec292bd 100644 --- a/htdocs/website/class/website.class.php +++ b/htdocs/website/class/website.class.php @@ -161,7 +161,7 @@ class Website extends CommonObject * @param User $user User that creates * @param bool $notrigger false=launch triggers after, true=disable triggers * - * @return int <0 if KO, 0 if already exists, ID of created object if OK + * @return int Return integer <0 if KO, 0 if already exists, ID of created object if OK */ public function create(User $user, $notrigger = false) { @@ -1168,7 +1168,7 @@ class Website extends CommonObject * Open a zip with all data of web site and load it into database. * * @param string $pathtofile Full path of zip file - * @return int <0 if KO, Id of new website if OK + * @return int Return integer <0 if KO, Id of new website if OK */ public function importWebSite($pathtofile) { @@ -1327,7 +1327,7 @@ class Website extends CommonObject * Rebuild all files of all the pages/containers of a website. Rebuild also the index and wrapper.php file. * Note: Files are already regenerated during importWebSite so this function is useless when importing a website. * - * @return int <0 if KO, >=0 if OK + * @return int Return integer <0 if KO, >=0 if OK */ public function rebuildWebSiteFiles() { diff --git a/htdocs/workstation/class/workstationresource.class.php b/htdocs/workstation/class/workstationresource.class.php index 0b670891583..c50a8417e90 100644 --- a/htdocs/workstation/class/workstationresource.class.php +++ b/htdocs/workstation/class/workstationresource.class.php @@ -100,7 +100,7 @@ class WorkstationResource extends CommonObject * Function used to remove all resources linked to a workstation * * @param int $fk_workstation Id of workstation we need to remove linked resources - * @return int <0 if KO, 0 if nothing done, >0 if OK and something done + * @return int Return integer <0 if KO, 0 if nothing done, >0 if OK and something done */ public static function deleteAllResourcesOfWorkstation($fk_workstation) { diff --git a/htdocs/workstation/class/workstationusergroup.class.php b/htdocs/workstation/class/workstationusergroup.class.php index a40ea43143a..e53bee221ef 100644 --- a/htdocs/workstation/class/workstationusergroup.class.php +++ b/htdocs/workstation/class/workstationusergroup.class.php @@ -100,7 +100,7 @@ class WorkstationUserGroup extends CommonObject * Function used to remove all usergroups linked to a workstation * * @param int $fk_workstation Id of workstation we need to remove linked usergroups - * @return int <0 if KO, 0 if nothing done, >0 if OK and something done + * @return int Return integer <0 if KO, 0 if nothing done, >0 if OK and something done */ public static function deleteAllGroupsOfWorkstation($fk_workstation) {