vignesh/dolibarr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

avoid phpstan error with phpdoc

Browse source
This commit is contained in:
Frédéric FRANCE 2023-12-06 15:46:39 +01:00
parent 20d3fe4a78
commit 61b79fda17
181 changed files with 573 additions and 573 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
htdocs/accountancy/class/accountancycategory.class.php
View file

@ -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)
{

2
htdocs/accountancy/class/accountancyexport.class.php
View file

@ -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)
{

2
htdocs/accountancy/class/accountancysystem.class.php
View file

@ -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 = '')
{

4
htdocs/accountancy/class/accountingaccount.class.php
View file

@ -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)
{

2
htdocs/accountancy/class/accountingjournal.class.php
View file

@ -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)
{

10
htdocs/accountancy/class/bookkeeping.class.php
View file

@ -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)
{

12
htdocs/accountancy/class/lettering.class.php
View file

@ -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)
{

6
htdocs/adherents/class/adherent.class.php
View file

@ -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)
{

4
htdocs/adherents/class/subscription.class.php
View file

@ -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)
{

8
htdocs/asset/class/asset.class.php
View file

@ -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)
{

2
htdocs/asset/class/assetdepreciationoptions.class.php
View file

@ -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)
{

6
htdocs/asset/class/assetmodel.class.php
View file

@ -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)
{

8
htdocs/bom/class/bom.class.php
View file

@ -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)
{

6
htdocs/bookcal/class/availabilities.class.php
View file

@ -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)
{

6
htdocs/bookcal/class/calendar.class.php
View file

@ -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)
{

4
htdocs/bookmarks/class/bookmark.class.php
View file

@ -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()
{

6
htdocs/categories/class/categorie.class.php
View file

@ -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()
{

2
htdocs/comm/action/class/actioncomm.class.php
View file

@ -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)
{

4
htdocs/comm/action/index.php
View file

@ -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)
{

2
htdocs/comm/mailing/class/mailing.class.php
View file

@ -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)
{

24
htdocs/comm/propal/class/propal.class.php
View file

@ -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)
{

34
htdocs/commande/class/commande.class.php
View file

@ -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)
{

12
htdocs/compta/bank/class/account.class.php
View file

@ -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()
{

2
htdocs/compta/bank/class/paymentvarious.class.php
View file

@ -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()
{

10
htdocs/compta/facture/class/facture-rec.class.php
View file

@ -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)
{

14
htdocs/compta/facture/class/facture.class.php
View file

@ -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)
{

2
htdocs/compta/localtax/class/localtax.class.php
View file

@ -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)
{

6
htdocs/compta/paiement/cheque/class/remisecheque.class.php
View file

@ -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')
{

8
htdocs/compta/paiement/class/paiement.class.php
View file

@ -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 = '')

10
htdocs/compta/prelevement/class/bonprelevement.class.php
View file

@ -744,7 +744,7 @@ class BonPrelevement extends CommonObject
*
* @param string $mode 'direct-debit' or 'bank-transfer'
* @param string $type for type=salary
* @return double <O if KO, Total amount
* @return double Return integer <O if KO, Total amount
*/
public function SommeAPrelever($mode = 'direct-debit', $type = '')
{
@ -801,7 +801,7 @@ class BonPrelevement extends CommonObject
*
* @param string $mode 'direct-debit' or 'bank-transfer'
* @param string $type for salary invoice
* @return int <O if KO, number of invoices if OK
* @return int Return integer <O if KO, number of invoices if OK
*/
public function nbOfInvoiceToPay($mode = 'direct-debit', $type = '')
{
@ -818,7 +818,7 @@ class BonPrelevement extends CommonObject
*
* @param string $type 'direct-debit' or 'bank-transfer'
* @param int $forsalary 0= for facture & facture_supplier, 1=for salary
* @return int <O if KO, number of invoices if OK
* @return int Return integer <O if KO, number of invoices if OK
*/
public function NbFactureAPrelever($type = 'direct-debit', $forsalary = 0)
{
@ -900,7 +900,7 @@ class BonPrelevement extends CommonObject
* @param int $did ID of an existing payment request. If $did is defined, we use the existing payment request.
* @param int $fk_bank_account Bank account ID the receipt is generated for. Will use the ID into the setup of module Direct Debit or Credit Transfer if 0.
* @param int $sourcetype 'invoice' or 'salary'
* @return int <0 if KO, No of invoice included into file if OK
* @return int Return integer <0 if KO, No of invoice included into file if OK
*/
public function create($banque = 0, $agence = 0, $mode = 'real', $format = 'ALL', $executiondate = '', $notrigger = 0, $type = 'direct-debit', $did = 0, $fk_bank_account = 0, $sourcetype = 'invoice')
{
@ -2618,7 +2618,7 @@ class BonPrelevement extends CommonObject
*
* @param User $user Objet user
* @param string $mode Mode 'direct_debit' or 'credit_transfer'
* @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)
{

2
htdocs/compta/prelevement/class/ligneprelevement.class.php
View file

@ -98,7 +98,7 @@ class LignePrelevement
* Recupere l'objet prelevement
*
* @param int $rowid Id de la facture a recuperer
* @return integer <0 if KO, >=0 if OK
* @return integer Return integer <0 if KO, >=0 if OK
*/
public function fetch($rowid)
{

4
htdocs/compta/sociales/class/chargesociales.class.php
View file

@ -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)
{

4
htdocs/compta/sociales/class/paymentsocialcontribution.class.php
View file

@ -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()
{

2
htdocs/compta/tva/class/paymentvat.class.php
View file

@ -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)
{

2
htdocs/compta/tva/class/tva.class.php
View file

@ -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)
{

8
htdocs/contact/class/contact.class.php
View file

@ -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()

12
htdocs/contrat/class/contrat.class.php
View file

@ -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)
{

2
htdocs/core/class/CMailFile.class.php
View file

@ -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)
{

2
htdocs/core/class/antivir.class.php
View file

@ -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)
{

2
htdocs/core/class/comment.class.php
View file

@ -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)
{

4
htdocs/core/class/commondocgenerator.class.php
View file

@ -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)
{

16
htdocs/core/class/commoninvoice.class.php
View file

@ -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)
{

42
htdocs/core/class/commonobject.class.php
View file

@ -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 = '')
{

2
htdocs/core/class/commonobjectline.class.php
View file

@ -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')
{

4
htdocs/core/class/conf.class.php
View file

@ -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)
{

2
htdocs/core/class/cproductnature.class.php
View file

@ -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')
{

2
htdocs/core/class/cunits.class.php
View file

@ -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 = '')
{

10
htdocs/core/class/discount.class.php
View file

@ -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)
{

12
htdocs/core/class/extrafields.class.php
View file

@ -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())

10
htdocs/core/class/html.form.class.php
View file

@ -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')
{

2
htdocs/core/class/html.formactions.class.php
View file

@ -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)
{

6
htdocs/core/class/html.formfile.class.php
View file

@ -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)

4
htdocs/core/class/html.formmail.class.php
View file

@ -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)
{

2
htdocs/core/class/infobox.class.php
View file

@ -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)
{

4
htdocs/core/class/ldap.class.php
View file

@ -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)
{

4
htdocs/core/class/link.class.php
View file

@ -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)
{

2
htdocs/core/class/menubase.class.php
View file

@ -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)
{

4
htdocs/core/class/notify.class.php
View file

@ -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())
{

6
htdocs/core/class/timespent.class.php
View file

@ -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)
{

6
htdocs/core/class/translate.class.php
View file

@ -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)
{

6
htdocs/core/db/Database.interface.php
View file

@ -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,

6
htdocs/core/db/mysqli.class.php
View file

@ -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)
{

6
htdocs/core/db/pgsql.class.php
View file

@ -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)
{

6
htdocs/core/db/sqlite3.class.php
View file

@ -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)
{

2
htdocs/core/lib/admin.lib.php
View file

@ -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 = '')
{

16
htdocs/core/lib/files.lib.php
View file

@ -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 = '')

6
htdocs/core/lib/functions.lib.php
View file

@ -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 = '')

2
htdocs/core/lib/functions2.lib.php
View file

@ -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)
{

10
htdocs/core/lib/memory.lib.php
View file

@ -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)
{

6
htdocs/core/lib/modulebuilder.lib.php
View file

@ -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)
{

4
htdocs/core/lib/xcal.lib.php
View file

@ -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 = '')
{

6
htdocs/core/modules/DolibarrModules.class.php
View file

@ -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()
{

2
htdocs/core/modules/expedition/doc/pdf_espadon.modules.php
View file

@ -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)
{

2
htdocs/core/modules/expedition/doc/pdf_merou.modules.php
View file

@ -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)
{

2
htdocs/core/modules/expedition/doc/pdf_rouget.modules.php
View file

@ -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)
{

2
htdocs/core/modules/export/export_excel2007.modules.php
View file

@ -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)
{

2
htdocs/core/modules/export/export_tsv.modules.php
View file

@ -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)
{

2
htdocs/core/modules/export/exportcsv.class.php
View file

@ -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)
{

6
htdocs/core/modules/import/import_csv.modules.php
View file

@ -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()
{

6
htdocs/core/modules/import/import_xlsx.modules.php
View file

@ -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()
{

2
htdocs/core/modules/mailings/advthirdparties.modules.php
View file

@ -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)
{

2
htdocs/core/modules/mailings/contacts1.modules.php
View file

@ -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)
{

2
htdocs/core/modules/mailings/eventorganization.modules.php
View file

@ -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)
{

2
htdocs/core/modules/mailings/fraise.modules.php
View file

@ -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)
{

4
htdocs/core/modules/mailings/modules_mailings.php
View file

@ -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)
{

2
htdocs/core/modules/mailings/partnership.modules.php
View file

@ -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)
{

2
htdocs/core/modules/mailings/pomme.modules.php
View file

@ -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)
{

2
htdocs/core/modules/mailings/thirdparties.modules.php
View file

@ -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)
{

2
htdocs/core/modules/mailings/thirdparties_services_expired.modules.php
View file

@ -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)
{

2
htdocs/core/modules/mailings/xinputfile.modules.php
View file

@ -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)
{

2
htdocs/core/modules/mailings/xinputuser.modules.php
View file

@ -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)
{

2
htdocs/core/triggers/dolibarrtriggers.class.php
View file

@ -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);
}

2
htdocs/core/triggers/interface_20_modWorkflow_WorkflowManager.class.php
View file

@ -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)
{

2
htdocs/core/triggers/interface_50_modAgenda_ActionsAuto.class.php
View file

@ -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)
{

2
htdocs/core/triggers/interface_50_modBlockedlog_ActionsBlockedLog.class.php
View file

@ -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)
{

2
htdocs/core/triggers/interface_50_modEventOrganization_EventOrganization.class.php
View file

@ -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)
{

2
htdocs/core/triggers/interface_50_modLdap_Ldapsynchro.class.php
View file

@ -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)
{

2
htdocs/core/triggers/interface_50_modMailmanspip_Mailmanspipsynchro.class.php
View file

@ -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)
{

2
htdocs/core/triggers/interface_50_modNotification_Notification.class.php
View file

@ -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)
{

2
htdocs/core/triggers/interface_50_modTicket_TicketEmail.class.php
View file

@ -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)
{

Some files were not shown because too many files have changed in this diff Show more