clean phpdoc for phpstan (#26905)

This commit is contained in:
Frédéric FRANCE 2023-12-01 19:51:32 +01:00 committed by GitHub
parent 0d1983766e
commit 53c8a3acf8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
202 changed files with 1004 additions and 1004 deletions

View file

@ -153,7 +153,7 @@ class AccountancyCategory // extends CommonObject
*
* @param User $user User that create
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create($user, $notrigger = 0)
{
@ -252,7 +252,7 @@ class AccountancyCategory // extends CommonObject
* @param int $id Id object
* @param string $code Code
* @param string $label Label
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($id, $code = '', $label = '')
{
@ -311,7 +311,7 @@ class AccountancyCategory // 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 = null, $notrigger = 0)
{
@ -392,7 +392,7 @@ class AccountancyCategory // extends CommonObject
*
* @param User $user User that delete
* @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 delete($user, $notrigger = 0)
{
@ -429,7 +429,7 @@ class AccountancyCategory // extends CommonObject
* Function to select into ->lines_display all accounting accounts for a given custom accounting group
*
* @param int $id Id
* @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 display($id)
{
@ -464,7 +464,7 @@ class AccountancyCategory // extends CommonObject
* Function to fill ->lines_cptbk with accounting account (defined in chart of account) and not yet into a custom group
*
* @param int $id Id of category to know which account to exclude
* @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 getAccountsWithNoCategory($id)
{
@ -508,7 +508,7 @@ class AccountancyCategory // extends CommonObject
* @param int $id_cat Id category
* @param array $cpts list of accounts array
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function updateAccAcc($id_cat, $cpts = array())
{
@ -579,7 +579,7 @@ class AccountancyCategory // extends CommonObject
*
* @param int $cpt_id Id of accounting account
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function deleteCptCat($cpt_id)
{

View file

@ -249,7 +249,7 @@ class AccountingAccount extends CommonObject
*
* @param User $user User making action
* @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 create($user, $notrigger = 0)
{
@ -395,7 +395,7 @@ class AccountingAccount extends CommonObject
/**
* Check usage of accounting code
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function checkUsage()
{
@ -430,7 +430,7 @@ class AccountingAccount extends CommonObject
*
* @param User $user User that deletes
* @param int $notrigger 0=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 delete($user, $notrigger = 0)
{
@ -619,7 +619,7 @@ class AccountingAccount extends CommonObject
*
* @param int $id Id
* @param int $mode 0=field active, 1=field reconcilable
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function accountDeactivate($id, $mode = 0)
{
@ -659,7 +659,7 @@ class AccountingAccount extends CommonObject
*
* @param int $id Id
* @param int $mode 0=field active, 1=field reconcilable
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function accountActivate($id, $mode = 0)
{

View file

@ -168,7 +168,7 @@ class AccountingJournal extends CommonObject
* @param array $filter filter array
* @param string $filtermode filter mode (AND or OR)
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetchAll($sortorder = '', $sortfield = '', $limit = 0, $offset = 0, array $filter = array(), $filtermode = 'AND')
{
@ -379,7 +379,7 @@ class AccountingJournal extends CommonObject
* @param int $date_start Filter 'start date'
* @param int $date_end Filter 'end date'
* @param string $in_bookkeeping Filter 'in bookkeeping' ('already', 'notyet')
* @return array|int <0 if KO, >0 if OK
* @return array|int Return integer <0 if KO, >0 if OK
*/
public function getData(User $user, $type = 'view', $date_start = null, $date_end = null, $in_bookkeeping = 'notyet')
{
@ -423,7 +423,7 @@ class AccountingJournal extends CommonObject
* @param int $date_start Filter 'start date'
* @param int $date_end Filter 'end date'
* @param string $in_bookkeeping Filter 'in bookkeeping' ('already', 'notyet')
* @return array|int <0 if KO, >0 if OK
* @return array|int Return integer <0 if KO, >0 if OK
*/
public function getAssetData(User $user, $type = 'view', $date_start = null, $date_end = null, $in_bookkeeping = 'notyet')
{
@ -778,7 +778,7 @@ class AccountingJournal extends CommonObject
* ),
* );
* @param int $max_nb_errors Nb error authorized before stop the process
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function writeIntoBookkeeping(User $user, &$journal_data = array(), $max_nb_errors = 10)
{
@ -919,7 +919,7 @@ class AccountingJournal extends CommonObject
* );
* @param int $search_date_end Search date end
* @param string $sep CSV separator
* @return int|string <0 if KO, >0 if OK
* @return int|string Return integer <0 if KO, >0 if OK
*/
public function exportCsv(&$journal_data = array(), $search_date_end = 0, $sep = '')
{

View file

@ -218,7 +218,7 @@ class BookKeeping extends CommonObject
*
* @param User $user User that creates
* @param bool $notrigger false=launch triggers after, true=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create(User $user, $notrigger = false)
{
@ -570,7 +570,7 @@ class BookKeeping extends CommonObject
* @param User $user User that creates
* @param bool $notrigger false=launch triggers after, true=disable triggers
* @param string $mode Mode
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function createStd(User $user, $notrigger = false, $mode = '')
{
@ -762,7 +762,7 @@ class BookKeeping extends CommonObject
* @param string $ref Ref
* @param string $mode Mode
*
* @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($id, $ref = null, $mode = '')
{
@ -1046,7 +1046,7 @@ class BookKeeping extends CommonObject
* @param array $filter Filter array
* @param string $filtermode Filter mode (AND or OR)
* @param int $showAlreadyExportMovements Show movements when field 'date_export' is not empty (0:No / 1:Yes (Default))
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetchAll($sortorder = '', $sortfield = '', $limit = 0, $offset = 0, array $filter = array(), $filtermode = 'AND', $showAlreadyExportMovements = 1)
{
@ -1197,7 +1197,7 @@ class BookKeeping extends CommonObject
* @param array $filter filter array
* @param string $filtermode filter mode (AND or OR)
* @param int $option option (0: aggregate by general account or 1: aggreegate by subaccount)
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetchAllBalance($sortorder = '', $sortfield = '', $limit = 0, $offset = 0, array $filter = array(), $filtermode = 'AND', $option = 0)
{
@ -1307,7 +1307,7 @@ class BookKeeping extends CommonObject
* @param User $user User that modifies
* @param bool $notrigger false=launch triggers after, true=disable triggers
* @param string $mode Mode ('' or _tmp')
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update(User $user, $notrigger = false, $mode = '')
{
@ -1452,7 +1452,7 @@ class BookKeeping extends CommonObject
* @param string $field Field
* @param string $value Value
* @param string $mode Mode ('' or _tmp')
* @return number <0 if KO, >0 if OK
* @return number Return integer <0 if KO, >0 if OK
*/
public function updateByMvt($piece_num = '', $field = '', $value = '', $mode = '')
{
@ -1494,7 +1494,7 @@ class BookKeeping extends CommonObject
* @param User $user User that deletes
* @param bool $notrigger false=launch triggers after, true=disable triggers
* @param string $mode Mode
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function delete(User $user, $notrigger = false, $mode = '')
{
@ -1593,7 +1593,7 @@ class BookKeeping extends CommonObject
* @param string $journal Journal to delete
* @param string $mode Mode
* @param int $delmonth Month
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function deleteByYearAndJournal($delyear = 0, $journal = '', $mode = '', $delmonth = 0)
{
@ -1778,7 +1778,7 @@ class BookKeeping extends CommonObject
*
* @param int $piecenum Accounting document to get
* @param string $mode Mode
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetchPerMvt($piecenum, $mode = '')
{
@ -1858,7 +1858,7 @@ class BookKeeping extends CommonObject
*
* @param int $piecenum Id of line to get
* @param string $mode Mode
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetchAllPerMvt($piecenum, $mode = '')
{
@ -1992,7 +1992,7 @@ class BookKeeping extends CommonObject
*
* @param number $direction If 0: tmp => real, if 1: real => tmp
* @param string $piece_num Piece num = Transaction ref
* @return int int <0 if KO, >0 if OK
* @return int int Return integer <0 if KO, >0 if OK
*/
public function transformTransaction($direction = 0, $piece_num = '')
{
@ -2404,7 +2404,7 @@ class BookKeeping extends CommonObject
*
* @param bool $force Force reload
* @param string $mode active or closed ?
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function loadFiscalPeriods($force = false, $mode = 'active')
{
@ -2565,7 +2565,7 @@ class BookKeeping extends CommonObject
*
* @param int $date_start Date start
* @param int $date_end Date end
* @return int int <0 if KO, >0 if OK
* @return int int Return integer <0 if KO, >0 if OK
*/
public function validateMovementForFiscalPeriod($date_start, $date_end)
{
@ -2598,7 +2598,7 @@ class BookKeeping extends CommonObject
* @param int $new_fiscal_period_id New fiscal year ID
* @param bool $separate_auxiliary_account Separate auxiliary account
* @param bool $generate_bookkeeping_records Generate closure bookkeeping records
* @return int int <0 if KO, >0 if OK
* @return int int Return integer <0 if KO, >0 if OK
*/
public function closeFiscalPeriod($fiscal_period_id, $new_fiscal_period_id, $separate_auxiliary_account = false, $generate_bookkeeping_records = true)
{
@ -2834,7 +2834,7 @@ class BookKeeping extends CommonObject
* @param int $new_fiscal_period_id New fiscal year ID
* @param int $date_start Date start
* @param int $date_end Date end
* @return int int <0 if KO, >0 if OK
* @return int int Return integer <0 if KO, >0 if OK
*/
public function insertAccountingReversal($fiscal_period_id, $inventory_journal_id, $new_fiscal_period_id, $date_start, $date_end)
{

View file

@ -377,7 +377,7 @@ class Adherent extends CommonObject
* @param string $moreinheader Add more html headers
* @deprecated since V18
* @see sendEmail()
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function send_an_email($text, $subject, $filename_list = array(), $mimetype_list = array(), $mimefilename_list = array(), $addr_cc = "", $addr_bcc = "", $deliveryreceipt = 0, $msgishtml = -1, $errors_to = '', $moreinheader = '')
{
@ -402,7 +402,7 @@ class Adherent extends CommonObject
* @param string $errors_to erros to
* @param string $moreinheader Add more html headers
* @since V18
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function sendEmail($text, $subject, $filename_list = array(), $mimetype_list = array(), $mimefilename_list = array(), $addr_cc = "", $addr_bcc = "", $deliveryreceipt = 0, $msgishtml = -1, $errors_to = '', $moreinheader = '')
{
@ -573,7 +573,7 @@ class Adherent extends CommonObject
*
* @param User $user Objet user qui demande la creation
* @param int $notrigger 1 ne declenche pas les triggers, 0 sinon
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function create($user, $notrigger = 0)
{
@ -704,7 +704,7 @@ class Adherent extends CommonObject
* @param int $nosyncuserpass 0=Synchronize linked user (password), 1=Do not synchronize linked user
* @param int $nosyncthirdparty 0=Synchronize linked thirdparty (standard info), 1=Do not synchronize linked thirdparty
* @param string $action Current action for hookmanager
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update($user, $notrigger = 0, $nosyncuser = 0, $nosyncuserpass = 0, $nosyncthirdparty = 0, $action = 'update')
{
@ -975,7 +975,7 @@ class Adherent extends CommonObject
* This function is called when we delete a subscription for example.
*
* @param User $user User making change
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update_end_date($user)
{
@ -1510,7 +1510,7 @@ class Adherent extends CommonObject
* first_subscription_date, first_subscription_date_start, first_subscription_date_end, first_subscription_amount
* last_subscription_date, last_subscription_date_start, last_subscription_date_end, last_subscription_amount
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch_subscriptions()
{
@ -1575,7 +1575,7 @@ class Adherent extends CommonObject
* Function to get partnerships array
*
* @param string $mode 'member' or 'thirdparty'
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetchPartnerships($mode)
{
@ -1683,7 +1683,7 @@ class Adherent extends CommonObject
* @param string $autocreatethirdparty Auto create new thirdparty if member not yet linked to a thirdparty and we request an option that generate invoice.
* @param string $ext_payment_id External id of payment (for example Stripe charge id)
* @param string $ext_payment_site Name of external paymentmode (for example 'stripe')
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function subscriptionComplementaryActions($subscriptionid, $option, $accountid, $datesubscription, $paymentdate, $operation, $label, $amount, $num_chq, $emetteur_nom = '', $emetteur_banque = '', $autocreatethirdparty = 0, $ext_payment_id = '', $ext_payment_site = '')
{
@ -1992,7 +1992,7 @@ class Adherent extends CommonObject
* Fonction qui resilie un adherent
*
* @param User $user User making change
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function resiliate($user)
{
@ -2042,7 +2042,7 @@ class Adherent extends CommonObject
* For historical purpose it add an "extra-subscription" type excluded
*
* @param User $user User making change
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function exclude($user)
{
@ -2089,7 +2089,7 @@ class Adherent extends CommonObject
/**
* Function to add member into external tools mailing-list, spip, etc.
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function add_to_abo()
{
@ -2141,7 +2141,7 @@ class Adherent extends CommonObject
/**
* Function to delete a member from external tools like mailing-list, spip, etc.
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function del_to_abo()
{
@ -2469,7 +2469,7 @@ class Adherent 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()
{
@ -2932,7 +2932,7 @@ class Adherent extends CommonObject
* Existing categories are left untouch.
*
* @param int[]|int $categories Category or categories IDs
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setCategories($categories)
{

View file

@ -159,7 +159,7 @@ class AdherentType extends CommonObject
/**
* Load array this->multilangs
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function getMultiLangs()
{
@ -195,7 +195,7 @@ class AdherentType extends CommonObject
* Update or add a translation for this member type
*
* @param User $user Object user making update
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setMultiLangs($user)
{
@ -281,7 +281,7 @@ class AdherentType extends CommonObject
*
* @param string $langtodelete Language code to delete
* @param User $user Object user making delete
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function delMultiLangs($langtodelete, $user)
{
@ -486,7 +486,7 @@ class AdherentType extends CommonObject
* Function that retrieves the properties of a membership type
*
* @param int $rowid Id of member type to load
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($rowid)
{

View file

@ -256,7 +256,7 @@ class Subscription extends CommonObject
*
* @param User $user User who updated
* @param int $notrigger 0=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)
{
@ -321,7 +321,7 @@ class Subscription extends CommonObject
*
* @param User $user User that delete
* @param bool $notrigger false=launch triggers after, true=disable triggers
* @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 delete($user, $notrigger = false)
{

View file

@ -213,7 +213,7 @@ class Asset extends CommonObject
*
* @param User $user User that creates
* @param bool $notrigger false=launch triggers after, true=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create(User $user, $notrigger = false)
{
@ -341,7 +341,7 @@ class Asset extends CommonObject
*
* @param int $id Id object
* @param string $ref Ref
* @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($id, $ref = null)
{
@ -367,7 +367,7 @@ class Asset extends CommonObject
/**
* Load object lines in memory from the database
*
* @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 fetchLines()
{
@ -462,7 +462,7 @@ class Asset extends CommonObject
*
* @param User $user User that modifies
* @param bool $notrigger false=launch triggers after, true=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 = false)
{
@ -499,7 +499,7 @@ class Asset extends CommonObject
*
* @param User $user User that deletes
* @param bool $notrigger false=launch triggers after, true=disable 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 = false)
{
@ -512,7 +512,7 @@ class Asset extends CommonObject
*
* @param User $user User that creates
* @param bool $notrigger false=launch triggers after, true=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function setDataFromAssetModel(User $user, $notrigger = false)
{
@ -621,7 +621,7 @@ class Asset extends CommonObject
/**
* Fetch depreciation lines for each mode in $this->depreciation_lines (sort by depreciation date)
*
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function fetchDepreciationLines()
{
@ -799,7 +799,7 @@ class Asset extends CommonObject
/**
* Calculation depreciation lines (reversal and future) for each mode
*
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function calculationDepreciation()
{
@ -1090,7 +1090,7 @@ class Asset extends CommonObject
* Set last cumulative depreciation for each mode
*
* @param int $asset_depreciation_id Asset depreciation line ID
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setLastCumulativeDepreciation($asset_depreciation_id)
{

View file

@ -102,7 +102,7 @@ class AssetAccountancyCodes extends CommonObject
*
* @param int $asset_id Asset ID to set
* @param int $asset_model_id Asset model ID to set
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetchAccountancyCodes($asset_id = 0, $asset_model_id = 0)
{
@ -170,7 +170,7 @@ class AssetAccountancyCodes extends CommonObject
* @param int $asset_id Asset ID to set
* @param int $asset_model_id Asset model ID to set
* @param int $notrigger 1=disable trigger UPDATE (when called by create)
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function updateAccountancyCodes($user, $asset_id = 0, $asset_model_id = 0, $notrigger = 0)
{

View file

@ -146,7 +146,7 @@ class AssetDepreciationOptions extends CommonObject
* @param string $mode Depreciation mode (economic, accelerated_depreciation, ...)
* @param int $class_type Type (0:asset, 1:asset model)
* @param bool $all_field Get all fields
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setInfosForMode($mode, $class_type = 0, $all_field = false)
{
@ -190,7 +190,7 @@ class AssetDepreciationOptions extends CommonObject
* Fill deprecation_options property of object (using for data sent by forms)
*
* @param int $class_type Type (0:asset, 1:asset model)
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setDeprecationOptionsFromPost($class_type = 0)
{
@ -304,7 +304,7 @@ class AssetDepreciationOptions extends CommonObject
*
* @param int $asset_id Asset ID to set
* @param int $asset_model_id Asset model ID to set
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetchDeprecationOptions($asset_id = 0, $asset_model_id = 0)
{
@ -413,7 +413,7 @@ class AssetDepreciationOptions extends CommonObject
* @param int $asset_id Asset ID to set
* @param int $asset_model_id Asset model ID to set
* @param int $notrigger 1=disable trigger UPDATE (when called by create)
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function updateDeprecationOptions($user, $asset_id = 0, $asset_model_id = 0, $notrigger = 0)
{

View file

@ -188,7 +188,7 @@ class AssetModel extends CommonObject
*
* @param User $user User that creates
* @param bool $notrigger false=launch triggers after, true=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create(User $user, $notrigger = false)
{
@ -301,7 +301,7 @@ class AssetModel extends CommonObject
*
* @param int $id Id object
* @param string $ref Ref
* @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($id, $ref = null)
{
@ -315,7 +315,7 @@ class AssetModel extends CommonObject
/**
* Load object lines in memory from the database
*
* @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 fetchLines()
{
@ -410,7 +410,7 @@ class AssetModel extends CommonObject
*
* @param User $user User that modifies
* @param bool $notrigger false=launch triggers after, true=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 = false)
{
@ -422,7 +422,7 @@ class AssetModel extends CommonObject
*
* @param User $user User that deletes
* @param bool $notrigger false=launch triggers after, true=disable 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 = false)
{
@ -502,7 +502,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 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setDraft($user, $notrigger = 0)
{

View file

@ -211,7 +211,7 @@ class BlockedLogAuthority
* Create authority in database.
*
* @param User $user Object user that create
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function create($user)
{
@ -259,7 +259,7 @@ class BlockedLogAuthority
* Create authority in database.
*
* @param User $user Object user that create
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update($user)
{
@ -293,7 +293,7 @@ class BlockedLogAuthority
/**
* For cron to sync to authority.
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function syncSignatureWithAuthority()
{

View file

@ -854,7 +854,7 @@ class BlockedLog
*
* @param User $user Object user that create
* @param int $forcesignature Force signature (for example '0000000000' when we disabled the module)
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function create($user, $forcesignature = '')
{

View file

@ -298,7 +298,7 @@ class BOM extends CommonObject
*
* @param User $user User that creates
* @param bool $notrigger false=launch triggers after, true=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create(User $user, $notrigger = false)
{
@ -405,7 +405,7 @@ class BOM extends CommonObject
*
* @param int $id Id object
* @param string $ref Ref
* @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($id, $ref = null)
{
@ -422,7 +422,7 @@ class BOM extends CommonObject
/**
* Load object lines in memory from the database
*
* @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 fetchLines()
{
@ -437,7 +437,7 @@ class BOM extends CommonObject
*
* @param int $typeproduct 0 type product, 1 type service
* @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 fetchLinesbytypeproduct($typeproduct = 0)
{
@ -563,7 +563,7 @@ class BOM extends CommonObject
*
* @param User $user User that modifies
* @param bool $notrigger false=launch triggers after, true=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 = false)
{
@ -579,7 +579,7 @@ class BOM extends CommonObject
*
* @param User $user User that deletes
* @param bool $notrigger false=launch triggers after, true=disable 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 = false)
{
@ -601,7 +601,7 @@ class BOM extends CommonObject
* @param string $fk_unit Unit
* @param array $array_options extrafields array
* @param int $fk_default_workstation Default workstation
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function addLine($fk_product, $qty, $qty_frozen = 0, $disable_stock_change = 0, $efficiency = 1.0, $position = -1, $fk_bom_child = null, $import_key = null, $fk_unit = '', $array_options = 0, $fk_default_workstation = null)
{
@ -1039,7 +1039,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 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setDraft($user, $notrigger = 0)
{
@ -1407,7 +1407,7 @@ class BOM extends CommonObject
* BOM costs calculation based on cost_price or pmp of each BOM line.
* Set the property ->total_cost and ->unit_cost of BOM.
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function calculateCosts()
{
@ -1836,7 +1836,7 @@ class BOMLine extends CommonObjectLine
*
* @param User $user User that creates
* @param bool $notrigger false=launch triggers after, true=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create(User $user, $notrigger = false)
{
@ -1852,7 +1852,7 @@ class BOMLine extends CommonObjectLine
*
* @param int $id Id object
* @param string $ref Ref
* @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($id, $ref = null)
{
@ -1940,7 +1940,7 @@ class BOMLine extends CommonObjectLine
*
* @param User $user User that modifies
* @param bool $notrigger false=launch triggers after, true=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 = false)
{
@ -1956,7 +1956,7 @@ class BOMLine extends CommonObjectLine
*
* @param User $user User that deletes
* @param bool $notrigger false=launch triggers after, true=disable 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 = false)
{

View file

@ -239,7 +239,7 @@ class Availabilities extends CommonObject
*
* @param User $user User that creates
* @param bool $notrigger false=launch triggers after, true=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create(User $user, $notrigger = false)
{
@ -355,7 +355,7 @@ class Availabilities extends CommonObject
*
* @param int $id Id object
* @param string $ref Ref
* @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($id, $ref = null)
{
@ -369,7 +369,7 @@ class Availabilities extends CommonObject
/**
* Load object lines in memory from the database
*
* @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 fetchLines()
{
@ -465,7 +465,7 @@ class Availabilities extends CommonObject
*
* @param User $user User that modifies
* @param bool $notrigger false=launch triggers after, true=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 = false)
{
@ -477,7 +477,7 @@ class Availabilities extends CommonObject
*
* @param User $user User that deletes
* @param bool $notrigger false=launch triggers after, true=disable 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 = false)
{
@ -640,7 +640,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 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setDraft($user, $notrigger = 0)
{

View file

@ -199,7 +199,7 @@ class Calendar extends CommonObject
*
* @param User $user User that creates
* @param bool $notrigger false=launch triggers after, true=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create(User $user, $notrigger = false)
{
@ -314,7 +314,7 @@ class Calendar extends CommonObject
*
* @param int $id Id object
* @param string $ref Ref
* @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($id, $ref = null)
{
@ -328,7 +328,7 @@ class Calendar extends CommonObject
/**
* Load object lines in memory from the database
*
* @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 fetchLines()
{
@ -422,7 +422,7 @@ class Calendar extends CommonObject
*
* @param User $user User that modifies
* @param bool $notrigger false=launch triggers after, true=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 = false)
{
@ -434,7 +434,7 @@ class Calendar extends CommonObject
*
* @param User $user User that deletes
* @param bool $notrigger false=launch triggers, true=disable 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 = false)
{
@ -597,7 +597,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 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setDraft($user, $notrigger = 0)
{

View file

@ -109,7 +109,7 @@ class Bookmark extends CommonObject
* Directs the bookmark
*
* @param int $id Bookmark Id Loader
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($id)
{
@ -235,7 +235,7 @@ class Bookmark extends CommonObject
* Removes the bookmark
*
* @param User $user User deleting
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function delete($user)
{

View file

@ -339,7 +339,7 @@ class Categorie extends CommonObject
* @param string $label Label of category
* @param string $type Type of category ('product', '...') or (0, 1, ...)
* @param string $ref_ext External reference of object
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($id, $label = '', $type = null, $ref_ext = '')
{
@ -1087,7 +1087,7 @@ class Categorie extends CommonObject
/**
* Load the array this->motherof that is array(id_son=>id_parent, ...)
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
protected function load_motherof()
{
@ -1236,7 +1236,7 @@ class Categorie extends CommonObject
*
* @param int $id_categ id_categ entry to update
* @param int $protection Deep counter to avoid infinite loop
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
* @see get_full_arbo()
*/
private function buildPathFromId($id_categ, $protection = 1000)
@ -1874,7 +1874,7 @@ class Categorie extends CommonObject
*
* @param User $user Object user
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setMultiLangs($user)
{
@ -1944,7 +1944,7 @@ class Categorie extends CommonObject
/**
* Load array this->multilangs
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function getMultiLangs()
{

View file

@ -785,7 +785,7 @@ class ActionComm extends CommonObject
* @param string $ref_ext Ref ext to get
* @param string $email_msgid Email msgid
* @param string $loadresources 1=Load also resources
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($id, $ref = '', $ref_ext = '', $email_msgid = '', $loadresources = 1)
{
@ -931,7 +931,7 @@ class ActionComm extends CommonObject
/**
* Initialize $this->userassigned & this->socpeopleassigned array with list of id of user and contact assigned to event
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetchResources()
{
@ -977,7 +977,7 @@ class ActionComm extends CommonObject
* Initialize this->userassigned array with list of id of user assigned to event
*
* @param bool $override Override $this->userownerid when empty. TODO This should be false by default. True is here to fix corrupted data.
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch_userassigned($override = true)
{
@ -1024,7 +1024,7 @@ class ActionComm extends CommonObject
* @TODO Add User $user as first param
*
* @param int $notrigger 1 = disable triggers, 0 = enable triggers
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function delete($notrigger = 0)
{
@ -1122,7 +1122,7 @@ class ActionComm extends CommonObject
*
* @param User $user Object user making change
* @param int $notrigger 1 = disable triggers, 0 = enable 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)
{
@ -1908,7 +1908,7 @@ class ActionComm extends CommonObject
* Existing categories are left untouch.
*
* @param int[]|int $categories Category or categories IDs
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setCategories($categories)
{

View file

@ -167,7 +167,7 @@ class ActionCommReminder extends CommonObject
*
* @param User $user User that creates
* @param bool $notrigger false=launch triggers after, true=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create(User $user, $notrigger = false)
{
@ -180,7 +180,7 @@ class ActionCommReminder extends CommonObject
*
* @param int $id Id object
* @param string $ref Ref
* @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($id, $ref = null)
{
@ -193,7 +193,7 @@ class ActionCommReminder extends CommonObject
*
* @param User $user User that modifies
* @param bool $notrigger false=launch triggers after, true=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 = false)
{
@ -205,7 +205,7 @@ class ActionCommReminder extends CommonObject
*
* @param User $user User that deletes
* @param bool $notrigger false=launch triggers after, true=disable 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 = false)
{

View file

@ -143,7 +143,7 @@ class AdvanceTargetingMailing extends CommonObject
*
* @param User $user User that creates
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create($user, $notrigger = 0)
{
@ -219,7 +219,7 @@ class AdvanceTargetingMailing extends CommonObject
* Load object in memory from the database
*
* @param int $id Id object
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($id)
{
@ -273,7 +273,7 @@ class AdvanceTargetingMailing extends CommonObject
* Load object in memory from the database
*
* @param int $id Id object
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch_by_mailing($id = 0)
{
@ -336,7 +336,7 @@ class AdvanceTargetingMailing extends CommonObject
*
* @param int $id Id object
* @param string $type_element Type target
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch_by_element($id = 0, $type_element = 'mailing')
{
@ -395,7 +395,7 @@ class AdvanceTargetingMailing extends CommonObject
*
* @param User $user User that modifies
* @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, $notrigger = 0)
{
@ -458,7 +458,7 @@ class AdvanceTargetingMailing extends CommonObject
*
* @param User $user User that deletes
* @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 delete($user, $notrigger = 0)
{
@ -498,7 +498,7 @@ class AdvanceTargetingMailing extends CommonObject
*
* @param User $user User that deletes
* @param array $arrayquery All element to Query
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function savequery($user, $arrayquery)
{
@ -526,7 +526,7 @@ class AdvanceTargetingMailing extends CommonObject
* Load object in memory from database
*
* @param array $arrayquery All element to Query
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function query_thirdparty($arrayquery)
{
@ -678,7 +678,7 @@ class AdvanceTargetingMailing extends CommonObject
*
* @param array $arrayquery All element to Query
* @param int $withThirdpartyFilter add contact with tridparty filter
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function query_contact($arrayquery, $withThirdpartyFilter = 0)
{

View file

@ -237,7 +237,7 @@ class Mailing extends CommonObject
*
* @param User $user Object of user making creation
* @param int $notrigger Disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create($user, $notrigger = 0)
{
@ -366,7 +366,7 @@ class Mailing extends CommonObject
*
* @param int $rowid Id of emailing
* @param string $ref Title to search from title
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($rowid, $ref = '')
{
@ -559,7 +559,7 @@ class Mailing extends CommonObject
* Validate emailing
*
* @param User $user Objet user qui valide
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function valid($user)
{
@ -661,7 +661,7 @@ class Mailing extends CommonObject
* Change status of each recipient
*
* @param User $user Objet user qui valide
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function reset_targets_status($user)
{
@ -719,7 +719,7 @@ class Mailing extends CommonObject
* Refresh denormalized value ->nbemail into emailing record
* Note: There is also the method update_nb into modules_mailings that is used for this.
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function refreshNbOfTargets()
{

View file

@ -423,7 +423,7 @@ class Propal extends CommonObject
* @param int $idproduct Product Id to add
* @param int $qty Quantity
* @param int $remise_percent Discount effected on Product
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*
* TODO Replace calls to this function by generation objet Ligne
*/
@ -1729,7 +1729,7 @@ class Propal 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)
{
@ -1840,7 +1840,7 @@ class Propal extends CommonObject
* @param int $only_product Return only physical products
* @param int $loadalsotranslation Return translation for products
* @param string $sqlforgedfilters Filter on other fields
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch_lines($only_product = 0, $loadalsotranslation = 0, $sqlforgedfilters = '')
{
@ -2097,7 +2097,7 @@ class Propal extends CommonObject
* @param User $user Object user that modify
* @param int $date 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 set_date($user, $date, $notrigger = 0)
{
@ -2161,7 +2161,7 @@ class Propal extends CommonObject
* @param User $user Object user that modify
* @param int $date_end_validity End of validity 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 set_echeance($user, $date_end_validity, $notrigger = 0)
{
@ -2292,7 +2292,7 @@ class Propal extends CommonObject
* @param User $user Object user that modify
* @param int $id Availability id
* @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_availability($user, $id, $notrigger = 0)
{
@ -2355,7 +2355,7 @@ class Propal extends CommonObject
* @param User $user Object user that modify
* @param int $id Input reason id
* @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_demand_reason($user, $id, $notrigger = 0)
{
@ -2608,7 +2608,7 @@ class Propal extends CommonObject
* @param int $status Status
* @param string $note Comment
* @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 reopen($user, $status, $note = '', $notrigger = 0)
{
@ -2667,7 +2667,7 @@ class Propal extends CommonObject
* @param int $status Status (self::STATUS_BILLED or self::STATUS_REFUSED)
* @param string $note Complete private note with this note
* @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 closeProposal($user, $status, $note = '', $notrigger = 0)
{
@ -2865,7 +2865,7 @@ class Propal 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 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setDraft($user, $notrigger = 0)
{
@ -4183,7 +4183,7 @@ class PropaleLigne extends CommonObjectLine
* Retrieve the propal line object
*
* @param int $rowid Propal line id
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($rowid)
{
@ -4271,7 +4271,7 @@ class PropaleLigne extends CommonObjectLine
* Insert object line propal in database
*
* @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 insert($notrigger = 0)
{
@ -4649,7 +4649,7 @@ class PropaleLigne extends CommonObjectLine
* Update DB line fields total_xxx
* Used by migration
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update_total()
{

View file

@ -623,7 +623,7 @@ class Commande extends CommonOrder
*
* @param User $user Object user that modify
* @param int $idwarehouse Warehouse ID to use for stock change (Used only if option STOCK_CALCULATE_ON_VALIDATE_ORDER is on)
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setDraft($user, $idwarehouse = -1)
{
@ -764,7 +764,7 @@ class Commande extends CommonOrder
*
* @param User $user Objet user that close
* @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 cloture($user, $notrigger = 0)
{
@ -824,7 +824,7 @@ class Commande extends CommonOrder
* If stock is decremented on order validation, we must reincrement it
*
* @param int $idwarehouse Id warehouse to use for stock change.
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function cancel($idwarehouse = -1)
{
@ -897,7 +897,7 @@ class Commande extends CommonOrder
*
* @param User $user Objet user that make creation
* @param int $notrigger Disable all triggers
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function create($user, $notrigger = 0)
{
@ -2071,7 +2071,7 @@ class Commande extends CommonOrder
*
* @param int $only_product Return only physical products, not services
* @param int $loadalsotranslation Return translation for products
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch_lines($only_product = 0, $loadalsotranslation = 0)
{
@ -2442,7 +2442,7 @@ class Commande extends CommonOrder
* @param User $user User qui positionne la remise
* @param float $remise Discount (percent)
* @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($user, $remise, $notrigger = 0)
{
@ -2457,7 +2457,7 @@ class Commande extends CommonOrder
* @param User $user User setting the discount
* @param float $remise Discount (percent)
* @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
*/
public function setDiscount($user, $remise, $notrigger = 0)
@ -2521,7 +2521,7 @@ class Commande extends CommonOrder
* @param User $user User qui positionne la remise
* @param float $remise 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)
@ -2588,7 +2588,7 @@ class Commande extends CommonOrder
* @param User $user Object user making change
* @param int $date 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 set_date($user, $date, $notrigger = 0)
{
@ -2918,7 +2918,7 @@ class Commande extends CommonOrder
* @param User $user User that make change
* @param string $ref_client Customer ref
* @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)
{
@ -3316,7 +3316,7 @@ class Commande extends CommonOrder
*
* @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)
{
@ -4294,7 +4294,7 @@ class OrderLine extends CommonOrderLine
* Load line order
*
* @param int $rowid Id line order
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($rowid)
{
@ -4469,7 +4469,7 @@ class OrderLine extends CommonOrderLine
*
* @param User $user User that modify
* @param int $notrigger 1 = disable triggers
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function insert($user = null, $notrigger = 0)
{
@ -4797,7 +4797,7 @@ class OrderLine extends CommonOrderLine
* Update DB line fields total_xxx
* Used by migration
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update_total()
{

View file

@ -834,7 +834,7 @@ class Account extends CommonObject
*
* @param User $user Object user making action
* @param int $notrigger 1=Disable triggers
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update(User $user, $notrigger = 0)
{
@ -938,7 +938,7 @@ class Account extends CommonObject
* Update BBAN (RIB) account fields
*
* @param User|null $user Object user making update
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update_bban(User $user = null)
{
@ -993,7 +993,7 @@ class Account extends CommonObject
*
* @param int $id Id of bank account to get
* @param string $ref Ref of bank account to get
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($id, $ref = '')
{
@ -1103,7 +1103,7 @@ class Account extends CommonObject
* Existing categories are left untouch.
*
* @param int[]|int $categories Category or categories IDs
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setCategories($categories)
{
@ -1115,7 +1115,7 @@ class Account extends CommonObject
* Delete bank account from database
*
* @param User|null $user User deleting
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function delete(User $user = null)
{
@ -1342,7 +1342,7 @@ class Account extends CommonObject
* Charge indicateurs this->nb de tableau de bord
*
* @param int $filteraccountid To get info for a particular account id
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function load_state_board($filteraccountid = 0)
{
@ -2181,7 +2181,7 @@ class AccountLine extends CommonObjectLine
*
* @param User|null $user User object that delete
* @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 = null, $notrigger = 0)
{
@ -2264,7 +2264,7 @@ class AccountLine extends CommonObjectLine
* Delete bank line records
*
* @param User|null $user User object that delete
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function delete_urls(User $user = null)
{
@ -2301,7 +2301,7 @@ class AccountLine extends CommonObjectLine
*
* @param User $user Object user making update
* @param int $notrigger 0=Disable all triggers
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update(User $user, $notrigger = 0)
{
@ -2333,7 +2333,7 @@ class AccountLine extends CommonObjectLine
* @param User $user Objet user making update
* @param int $cat Category id
* @param int $conciliated 1=Set transaction to conciliated, 0=Keep transaction non conciliated
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update_conciliation(User $user, $cat, $conciliated = 1)
{

View file

@ -82,7 +82,7 @@ class BankCateg // extends CommonObject
*
* @param User $user User that create
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create(User $user, $notrigger = 0)
{
@ -136,7 +136,7 @@ class BankCateg // extends CommonObject
* Load object in memory from database
*
* @param int $id Id object
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($id)
{
@ -172,7 +172,7 @@ class BankCateg // extends CommonObject
*
* @param User|null $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 = null, $notrigger = 0)
{
@ -221,7 +221,7 @@ class BankCateg // extends CommonObject
*
* @param User $user User that delete
* @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 delete(User $user, $notrigger = 0)
{

View file

@ -197,7 +197,7 @@ class PaymentVarious extends CommonObject
*
* @param User $user User that modify
* @param int $notrigger 0=no, 1=yes (no update trigger)
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update($user = null, $notrigger = 0)
{
@ -267,7 +267,7 @@ class PaymentVarious extends CommonObject
*
* @param int $id id object
* @param User $user User that load
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($id, $user = null)
{
@ -339,7 +339,7 @@ class PaymentVarious extends CommonObject
* Delete object in database
*
* @param User $user User that delete
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function delete($user)
{
@ -415,7 +415,7 @@ class PaymentVarious extends CommonObject
* Create in database
*
* @param User $user User that create
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function create($user)
{
@ -589,7 +589,7 @@ class PaymentVarious extends CommonObject
* Update link between payment various and line generate into llx_bank
*
* @param int $id_bank Id bank account
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update_fk_bank($id_bank)
{

View file

@ -162,7 +162,7 @@ class CashControl extends CommonObject
*
* @param User $user User that create
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create(User $user, $notrigger = 0)
{
@ -247,7 +247,7 @@ class CashControl extends CommonObject
*
* @param User $user User
* @param number $notrigger No trigger
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function valid(User $user, $notrigger = 0)
{
@ -325,7 +325,7 @@ class CashControl extends CommonObject
*
* @param int $id Id object
* @param string $ref Ref
* @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($id, $ref = null)
{
@ -339,7 +339,7 @@ class CashControl extends CommonObject
*
* @param User $user User that modifies
* @param bool $notrigger false=launch triggers after, true=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 = false)
{
@ -351,7 +351,7 @@ class CashControl extends CommonObject
*
* @param User $user User that deletes
* @param bool $notrigger false=launch triggers after, true=disable 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 = false)
{

View file

@ -134,7 +134,7 @@ class Deplacement extends CommonObject
* TODO Add ref number
*
* @param User $user User that creates
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function create($user)
{
@ -210,7 +210,7 @@ class Deplacement extends CommonObject
* Update record
*
* @param User $user User making update
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update($user)
{
@ -266,7 +266,7 @@ class Deplacement extends CommonObject
*
* @param int $id Id of record to load
* @param string $ref Ref of record
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($id, $ref = '')
{
@ -309,7 +309,7 @@ class Deplacement extends CommonObject
* Delete record
*
* @param User $user USer that Delete
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function delete($user)
{

View file

@ -789,7 +789,7 @@ class FactureRec extends CommonInvoice
* @param User $user User that delete.
* @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 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function delete(User $user, $notrigger = 0, $idwarehouse = -1)
{
@ -1874,7 +1874,7 @@ class FactureRec extends CommonInvoice
* @param int $frequency value of frequency
* @param string $unit unit of frequency (d, m, y)
* @param int $notrigger Disable the trigger
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setFrequencyAndUnit($frequency, $unit, $notrigger = 0)
{
@ -1926,7 +1926,7 @@ class FactureRec extends CommonInvoice
* @param datetime $date date of execution
* @param int $increment_nb_gen_done 0 do nothing more, >0 increment nb_gen_done
* @param int $notrigger Disable the trigger
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setNextDate($date, $increment_nb_gen_done = 0, $notrigger = 0)
{
@ -1971,7 +1971,7 @@ class FactureRec extends CommonInvoice
*
* @param int $nb number of maximum period
* @param int $notrigger Disable the trigger
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setMaxPeriod($nb, $notrigger = 0)
{
@ -2016,7 +2016,7 @@ class FactureRec extends CommonInvoice
*
* @param int $validate 0 to create in draft, 1 to create and validate invoice
* @param int $notrigger Disable the trigger
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setAutoValidate($validate, $notrigger = 0)
{
@ -2056,7 +2056,7 @@ class FactureRec extends CommonInvoice
*
* @param int $validate 0 no document, 1 to generate document
* @param int $notrigger Disable the trigger
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setGeneratePdf($validate, $notrigger = 0)
{
@ -2096,7 +2096,7 @@ class FactureRec extends CommonInvoice
*
* @param string $model model of document generator
* @param int $notrigger Disable the trigger
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setModelPdf($model, $notrigger = 0)
{
@ -2174,7 +2174,7 @@ class FactureLigneRec extends CommonInvoiceLine
*
* @param User $user Object user
* @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 delete(User $user, $notrigger = false)
{

View file

@ -449,7 +449,7 @@ class Facture extends CommonInvoice
* @param User $user Object user that create
* @param int $notrigger 1=Does not execute triggers, 0 otherwise
* @param int $forceduedate If set, do not recalculate due date from payment condition but force it with value
* @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, $forceduedate = 0)
{
@ -1122,7 +1122,7 @@ class Facture extends CommonInvoice
*
* @param User $user Object user that ask creation
* @param int $invertdetail Reverse sign of amounts for lines
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function createFromCurrent(User $user, $invertdetail = 0)
{
@ -2440,7 +2440,7 @@ class Facture extends CommonInvoice
*
* @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)
{
@ -2679,7 +2679,7 @@ class Facture extends CommonInvoice
*
* @param string $ref_client Customer ref
* @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($ref_client, $notrigger = 0)
{
@ -2933,7 +2933,7 @@ class Facture extends CommonInvoice
* @param User $user Object user that modify
* @param string $close_code Code renseigne si on classe a payee completement alors que paiement incomplet (cas escompte par exemple)
* @param string $close_note Commentaire renseigne si on classe a payee alors que paiement incomplet (cas escompte par exemple)
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function set_paid($user, $close_code = '', $close_note = '')
{
@ -2950,7 +2950,7 @@ class Facture extends CommonInvoice
* @param User $user Object user that modify
* @param string $close_code Code renseigne si on classe a payee completement alors que paiement incomplet (cas escompte par exemple)
* @param string $close_note Commentaire renseigne si on classe a payee alors que paiement incomplet (cas escompte par exemple)
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setPaid($user, $close_code = '', $close_note = '')
{
@ -3013,7 +3013,7 @@ class Facture extends CommonInvoice
* @deprecated
* @see setUnpaid()
* @param User $user Object user that change status
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function set_unpaid($user)
{
@ -3028,7 +3028,7 @@ class Facture extends CommonInvoice
* ou quand une facture annulee et reouverte.
*
* @param User $user Object user that change status
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setUnpaid($user)
{
@ -3078,7 +3078,7 @@ class Facture extends CommonInvoice
* @param User $user Object user making change
* @param string $close_code Code of closing invoice (CLOSECODE_REPLACED, CLOSECODE_...)
* @param string $close_note Comment
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function set_canceled($user, $close_code = '', $close_note = '')
{
@ -3095,7 +3095,7 @@ class Facture extends CommonInvoice
* @param User $user Object user making change
* @param string $close_code Code of closing invoice (CLOSECODE_REPLACED, CLOSECODE_...)
* @param string $close_note Comment
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setCanceled($user, $close_code = '', $close_note = '')
{
@ -3641,7 +3641,7 @@ class Facture extends CommonInvoice
*
* @param User $user Object user that modify
* @param int $idwarehouse Id warehouse to use for stock change.
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setDraft($user, $idwarehouse = -1)
{
@ -4341,7 +4341,7 @@ class Facture extends CommonInvoice
*
* @param int $rowid Id of line to delete
* @param int $id Id of object (for a check)
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function deleteline($rowid, $id = 0)
{
@ -4403,7 +4403,7 @@ class Facture extends CommonInvoice
* @param User $user User that set discount
* @param double $remise 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($user, $remise, $notrigger = 0)
{
@ -4418,7 +4418,7 @@ class Facture extends CommonInvoice
* @param User $user User that set discount
* @param double $remise 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
*/
public function setDiscount($user, $remise, $notrigger = 0)
@ -4483,7 +4483,7 @@ class Facture extends CommonInvoice
* @param User $user User that set discount
* @param double $remise 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)
@ -5144,7 +5144,7 @@ class Facture extends CommonInvoice
/**
* Load indicators for dashboard (this->nbtodo and this->nbtodolate)
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function load_state_board()
{
@ -5198,7 +5198,7 @@ class Facture extends CommonInvoice
* @param int $hidedesc Hide description
* @param int $hideref Hide ref
* @param null|array $moreparams Array to provide more information
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function generateDocument($modele, $outputlangs, $hidedetails = 0, $hidedesc = 0, $hideref = 0, $moreparams = null)
{
@ -5301,7 +5301,7 @@ class Facture extends CommonInvoice
*
* @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 setFinal(User $user, $notrigger = 0)
{
@ -6096,7 +6096,7 @@ class FactureLigne extends CommonInvoiceLine
* Load invoice line from database
*
* @param int $rowid id of invoice line to get
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($rowid)
{
@ -6194,7 +6194,7 @@ class FactureLigne extends CommonInvoiceLine
*
* @param int $notrigger 1 no triggers
* @param int $noerrorifdiscountalreadylinked 1=Do not make error if lines is linked to a discount and discount already linked to another
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function insert($notrigger = 0, $noerrorifdiscountalreadylinked = 0)
{
@ -6430,7 +6430,7 @@ class FactureLigne extends CommonInvoiceLine
*
* @param User $user User object
* @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)
{
@ -6602,7 +6602,7 @@ class FactureLigne extends CommonInvoiceLine
*
* @param User $tmpuser User that deletes
* @param bool $notrigger false=launch triggers after, true=disable triggers
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function delete($tmpuser = null, $notrigger = false)
{
@ -6669,7 +6669,7 @@ class FactureLigne extends CommonInvoiceLine
* Update DB line fields total_xxx
* Used by migration
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update_total()
{

View file

@ -85,7 +85,7 @@ class PaymentTerm // extends CommonObject
*
* @param User $user User that create
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create($user, $notrigger = 0)
{
@ -179,7 +179,7 @@ class PaymentTerm // extends CommonObject
*
* @param int $id Id object
* @param string $code Code object
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($id, $code = '')
{
@ -232,7 +232,7 @@ class PaymentTerm // extends CommonObject
/**
* Return id of default payment term
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function getDefaultId()
{
@ -269,7 +269,7 @@ class PaymentTerm // 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 = null, $notrigger = 0)
{
@ -350,7 +350,7 @@ class PaymentTerm // extends CommonObject
*
* @param User $user User that delete
* @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 delete($user, $notrigger = 0)
{

View file

@ -102,7 +102,7 @@ class Localtax extends CommonObject
* Create in database
*
* @param User $user User that create
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function create($user)
{
@ -171,7 +171,7 @@ class Localtax extends CommonObject
*
* @param User $user User that modify
* @param int $notrigger 0=no, 1=yes (no update trigger)
* @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)
{
@ -230,7 +230,7 @@ class Localtax extends CommonObject
* Load object in memory from database
*
* @param int $id Object id
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($id)
{
@ -290,7 +290,7 @@ class Localtax extends CommonObject
* Delete object in database
*
* @param User $user User that delete
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function delete($user)
{
@ -573,7 +573,7 @@ class Localtax extends CommonObject
* Update the link betwen localtax payment and the line into llx_bank
*
* @param int $id Id bank account
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update_fk_bank($id)
{

View file

@ -142,7 +142,7 @@ class RemiseCheque extends CommonObject
* @param int $account_id Bank account for cheque receipt
* @param int $limit Limit ref of cheque to this
* @param array $toRemise array with cheques to remise
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function create($user, $account_id, $limit, $toRemise)
{
@ -339,7 +339,7 @@ class RemiseCheque extends CommonObject
* Validate a receipt
*
* @param User $user User
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function validate($user)
{
@ -568,7 +568,7 @@ class RemiseCheque extends CommonObject
*
* @param string $model Model name
* @param Translate $outputlangs Object langs
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function generatePdf($model, $outputlangs)
{
@ -815,7 +815,7 @@ class RemiseCheque extends CommonObject
*
* @param User $user Object user
* @param int $date Date creation
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function set_date($user, $date)
{
@ -845,7 +845,7 @@ class RemiseCheque extends CommonObject
*
* @param User $user Object user
* @param int $ref ref of bordereau
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function set_number($user, $ref)
{

View file

@ -73,7 +73,7 @@ class Cpaiement extends CommonDict
* @param User $user User that creates
* @param bool $notrigger false=launch triggers after, true=disable triggers
*
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create(User $user, $notrigger = false)
{
@ -170,7 +170,7 @@ class Cpaiement extends CommonDict
* @param int $id Id object
* @param string $ref Ref
*
* @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($id, $ref = null)
{
@ -229,7 +229,7 @@ class Cpaiement extends CommonDict
* @param User $user User that modifies
* @param bool $notrigger false=launch triggers after, true=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 = false)
{
@ -314,7 +314,7 @@ class Cpaiement extends CommonDict
* @param User $user User that deletes
* @param bool $notrigger false=launch triggers after, true=disable 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 = false)
{

View file

@ -176,7 +176,7 @@ class Paiement extends CommonObject
* @param int $id Id of payment to get
* @param string $ref Ref of payment to get (currently ref = id but this may change in future)
* @param int $fk_bank Id of bank line associated to payment
* @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($id, $ref = '', $fk_bank = '')
{
@ -548,7 +548,7 @@ class Paiement extends CommonObject
* @TODO Add first param User $user
*
* @param int $notrigger No trigger
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function delete($notrigger = 0)
{
@ -843,7 +843,7 @@ class Paiement extends CommonObject
* Mise a jour du lien entre le paiement et la ligne generee dans llx_bank
*
* @param int $id_bank Id compte bancaire
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update_fk_bank($id_bank)
{
@ -951,7 +951,7 @@ class Paiement extends CommonObject
* Validate payment
*
* @param User|null $user User making validation
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
* @deprecated
*/
public function valide(User $user = null)
@ -963,7 +963,7 @@ class Paiement extends CommonObject
* Validate payment
*
* @param User|null $user User making validation
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function validate(User $user = null)
{
@ -984,7 +984,7 @@ class Paiement extends CommonObject
* Reject payment
*
* @param User|null $user User making reject
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function reject(User $user = null)
{
@ -1382,7 +1382,7 @@ class Paiement extends CommonObject
* For payments, take the thirdparty linked to the first invoice found. This is enough because payments are done on invoices of the same thirdparty.
*
* @param int $force_thirdparty_id Force thirdparty id
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch_thirdparty($force_thirdparty_id = 0)
{

View file

@ -441,7 +441,7 @@ class BonPrelevement extends CommonObject
*
* @param User $user User that modifies
* @param bool $notrigger false=launch triggers after, true=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 = false)
{

View file

@ -95,7 +95,7 @@ class Cchargesociales
* @param User $user User that creates
* @param bool $notrigger false=launch triggers after, true=disable triggers
*
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create(User $user, $notrigger = false)
{
@ -179,7 +179,7 @@ class Cchargesociales
* @param int $id Id object
* @param string $ref Ref
*
* @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($id, $ref = null)
{
@ -239,7 +239,7 @@ class Cchargesociales
* @param User $user User that modifies
* @param bool $notrigger false=launch triggers after, true=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 = false)
{
@ -313,7 +313,7 @@ class Cchargesociales
* @param User $user User that deletes
* @param bool $notrigger false=launch triggers after, true=disable 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 = false)
{

View file

@ -286,7 +286,7 @@ class ChargeSociales extends CommonObject
* Delete a social contribution
*
* @param User $user Object user making delete
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function delete($user)
{
@ -347,7 +347,7 @@ class ChargeSociales 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, $notrigger = 0)
{
@ -438,7 +438,7 @@ class ChargeSociales extends CommonObject
* @deprecated
* @see setPaid()
* @param User $user Object user making change
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function set_paid($user)
{
@ -451,7 +451,7 @@ class ChargeSociales extends CommonObject
* Tag social contribution as paid completely
*
* @param User $user Object user making change
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setPaid($user)
{
@ -477,7 +477,7 @@ class ChargeSociales extends CommonObject
* @deprecated
* @see setUnpaid()
* @param User $user Object user making change
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function set_unpaid($user)
{
@ -490,7 +490,7 @@ class ChargeSociales extends CommonObject
* Remove tag paid on social contribution
*
* @param User $user Object user making change
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setUnpaid($user)
{
@ -693,7 +693,7 @@ class ChargeSociales extends CommonObject
* Charge les informations d'ordre info dans l'objet entrepot
*
* @param int $id Id of social contribution
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function info($id)
{

View file

@ -277,7 +277,7 @@ class PaymentSocialContribution extends CommonObject
* Load object in memory from database
*
* @param int $id Id object
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($id)
{
@ -344,7 +344,7 @@ class PaymentSocialContribution 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 = null, $notrigger = 0)
{
@ -427,7 +427,7 @@ class PaymentSocialContribution extends CommonObject
*
* @param User $user User that delete
* @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 delete($user, $notrigger = 0)
{
@ -557,7 +557,7 @@ class PaymentSocialContribution extends CommonObject
* @param int $accountid Id of bank account to do link with
* @param string $emetteur_nom Name of transmitter
* @param string $emetteur_banque Name of bank
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function addPaymentToBank($user, $mode, $label, $accountid, $emetteur_nom, $emetteur_banque)
{

View file

@ -281,7 +281,7 @@ class PaymentVAT extends CommonObject
* Load object in memory from database
*
* @param int $id Id object
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($id)
{
@ -349,7 +349,7 @@ class PaymentVAT 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 = null, $notrigger = 0)
{
@ -430,7 +430,7 @@ class PaymentVAT extends CommonObject
*
* @param User $user User that delete
* @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 delete($user, $notrigger = 0)
{
@ -559,7 +559,7 @@ class PaymentVAT extends CommonObject
* @param int $accountid Id of bank account to do link with
* @param string $emetteur_nom Name of transmitter
* @param string $emetteur_banque Name of bank
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function addPaymentToBank($user, $mode, $label, $accountid, $emetteur_nom, $emetteur_banque)
{

View file

@ -136,7 +136,7 @@ class Tva extends CommonObject
* Create in database
*
* @param User $user User that create
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function create($user)
{
@ -217,7 +217,7 @@ class Tva extends CommonObject
*
* @param User $user User that modify
* @param int $notrigger 0=no, 1=yes (no update trigger)
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update($user, $notrigger = 0)
{
@ -278,7 +278,7 @@ class Tva extends CommonObject
* Tag TVA as payed completely
*
* @param User $user Object user making change
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setPaid($user)
{
@ -298,7 +298,7 @@ class Tva extends CommonObject
* Remove tag payed on TVA
*
* @param User $user Object user making change
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setUnpaid($user)
{
@ -320,7 +320,7 @@ class Tva extends CommonObject
*
* @param int $id id object
* @param string $ref Ref of VAT (not used yet)
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($id, $ref = '')
{
@ -379,7 +379,7 @@ class Tva extends CommonObject
* Delete object in database
*
* @param User $user User that delete
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function delete($user)
{
@ -705,7 +705,7 @@ class Tva extends CommonObject
* Update link between payment tva and line generate into llx_bank
*
* @param int $id_bank Id bank account
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update_fk_bank($id_bank)
{
@ -826,7 +826,7 @@ class Tva extends CommonObject
* Informations of vat payment object
*
* @param int $id Id of vat payment
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function info($id)
{

View file

@ -406,7 +406,7 @@ class Contact extends CommonObject
/**
* Load indicators into this->nb for board
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function load_state_board()
{
@ -455,7 +455,7 @@ class Contact extends CommonObject
*
* @param User $user Object 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)
{
@ -569,7 +569,7 @@ class Contact extends CommonObject
* @param int $notrigger 0=no, 1=yes
* @param string $action Current action for hookmanager
* @param int $nosyncuser No sync linked user (external users and contacts are linked)
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update($id, $user = null, $notrigger = 0, $action = 'update', $nosyncuser = 0)
{
@ -1221,7 +1221,7 @@ class Contact extends CommonObject
*
* @param User $user User making the delete
* @param int $notrigger Disable all trigger
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function delete($user, $notrigger = 0)
{
@ -1729,7 +1729,7 @@ class Contact extends CommonObject
* Existing categories are left untouch.
*
* @param int[]|int $categories Category or categories IDs
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setCategories($categories)
{
@ -1923,7 +1923,7 @@ class Contact extends CommonObject
* Load array of prospect status
*
* @param int $active 1=Active only, 0=Not active only, -1=All
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function loadCacheOfProspStatus($active = 1)
{
@ -1977,7 +1977,7 @@ class Contact extends CommonObject
* Set prospect level
*
* @param User $user User who defines the discount
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
* @deprecated Use update function instead
*/
public function setProspectLevel(User $user)
@ -2069,7 +2069,7 @@ class Contact extends CommonObject
* Set "blacklist" mailing status
*
* @param int $no_email 1=Do not send mailing, 0=Ok to receive mailing
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setNoEmail($no_email)
{
@ -2126,7 +2126,7 @@ class Contact extends CommonObject
* get "blacklist" mailing status
* set no_email attribut to 1 or 0
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function getNoEmail()
{

View file

@ -343,7 +343,7 @@ class Contrat extends CommonObject
* @param int $date_start Opening date
* @param int|string $date_end Expected end date
* @param string $comment A comment typed by user
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function active_line($user, $line_id, $date_start, $date_end = '', $comment = '')
{
@ -365,7 +365,7 @@ class Contrat extends CommonObject
* @param int $line_id Id of line to close
* @param int $date_end End date
* @param string $comment A comment typed by user
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function close_line($user, $line_id, $date_end, $comment = '')
{
@ -387,7 +387,7 @@ class Contrat extends CommonObject
* @param int $notrigger 1=Does not execute triggers, 0=Execute triggers
* @param string $comment Comment
* @param int|string $date_end Date end
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
* @see ()
*/
public function activateAll($user, $date_start = '', $notrigger = 0, $comment = '', $date_end = '')
@ -440,7 +440,7 @@ class Contrat extends CommonObject
* @param User $user Object User making action
* @param int $notrigger 1=Does not execute triggers, 0=Execute triggers
* @param string $comment Comment
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
* @see activateAll()
*/
public function closeAll(User $user, $notrigger = 0, $comment = '')
@ -493,7 +493,7 @@ class Contrat extends CommonObject
* @param User $user Objet User
* @param string $force_number Reference to force on contract (not implemented yet)
* @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 validate(User $user, $force_number = '', $notrigger = 0)
{
@ -616,7 +616,7 @@ class Contrat extends CommonObject
*
* @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 reopen($user, $notrigger = 0)
{
@ -1331,7 +1331,7 @@ class Contrat extends CommonObject
*
* @param User $user User that modifies
* @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, $notrigger = 0)
{
@ -1473,7 +1473,7 @@ class Contrat extends CommonObject
* @param array $array_options extrafields array
* @param string $fk_unit Code of the unit to use. Null to use the default one
* @param string $rang Position
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function addline($desc, $pu_ht, $qty, $txtva, $txlocaltax1, $txlocaltax2, $fk_product, $remise_percent, $date_start, $date_end, $price_base_type = 'HT', $pu_ttc = 0.0, $info_bits = 0, $fk_fournprice = null, $pa_ht = 0, $array_options = 0, $fk_unit = null, $rang = 0)
{
@ -1705,7 +1705,7 @@ class Contrat extends CommonObject
* @param array $array_options extrafields array
* @param string $fk_unit Code of the unit to use. Null to use the default one
* @param string $rang Position
* @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, $tvatx, $localtax1tx = 0.0, $localtax2tx = 0.0, $date_start_real = '', $date_end_real = '', $price_base_type = 'HT', $info_bits = 0, $fk_fournprice = null, $pa_ht = 0, $array_options = 0, $fk_unit = null, $rang = 0)
{
@ -1936,7 +1936,7 @@ class Contrat extends CommonObject
* Update statut of contract according to services
*
* @param User $user Object user
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
* @deprecated This function will never be used. Status of a contract is status of its lines.
*/
public function update_statut($user)
@ -3265,7 +3265,7 @@ class ContratLigne extends CommonObjectLine
*
* @param int $id Id object
* @param string $ref Ref of contract line
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($id, $ref = '')
{
@ -3402,7 +3402,7 @@ class ContratLigne extends CommonObjectLine
*
* @param User $user User that modify
* @param int $notrigger 0=no, 1=yes (no update trigger)
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update($user, $notrigger = 0)
{
@ -3611,7 +3611,7 @@ class ContratLigne extends CommonObjectLine
* Mise a jour en base des champs total_xxx de ligne
* Used by migration process
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update_total()
{
@ -3645,7 +3645,7 @@ class ContratLigne extends CommonObjectLine
* Inserts a contrat line into database
*
* @param int $notrigger Set to 1 if you don't want triggers to be fired
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function insert($notrigger = 0)
{
@ -3741,7 +3741,7 @@ class ContratLigne extends CommonObjectLine
* @param int $date Date real activation
* @param int|string $date_end Date planned end. Use '-1' to keep it unchanged.
* @param string $comment A comment typed by user
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function active_line($user, $date, $date_end = '', $comment = '')
{
@ -3801,7 +3801,7 @@ class ContratLigne extends CommonObjectLine
* @param int $date_end_real Date end
* @param string $comment A comment typed by 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 close_line($user, $date_end_real, $comment = '', $notrigger = 0)
{

View file

@ -142,7 +142,7 @@ class ModeleBoxes // Can't be abtract as it is instantiated to build "empty" box
*
* @param int $rowid Row id to load
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($rowid)
{

View file

@ -56,7 +56,7 @@ class Ccountry extends CommonDict
*
* @param User $user User that create
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create($user, $notrigger = 0)
{
@ -178,7 +178,7 @@ class Ccountry extends CommonDict
*
* @param User $user User that modify
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update($user = null, $notrigger = 0)
{
@ -239,7 +239,7 @@ class Ccountry extends CommonDict
*
* @param User $user User that delete
* @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 delete($user, $notrigger = 0)
{

View file

@ -74,7 +74,7 @@ class CGenericDic extends CommonDict
* @param User $user User that creates
* @param bool $notrigger false=launch triggers after, true=disable triggers
*
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create(User $user, $notrigger = false)
{
@ -154,7 +154,7 @@ class CGenericDic extends CommonDict
* @param string $code code
* @param string $label Label
*
* @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($id, $code = '', $label = '')
{
@ -227,7 +227,7 @@ class CGenericDic extends CommonDict
* @param array $filter filter array
* @param string $filtermode filter mode (AND or OR)
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetchAll($sortorder = '', $sortfield = '', $limit = 0, $offset = 0, array $filter = array(), $filtermode = 'AND')
{
@ -297,7 +297,7 @@ class CGenericDic extends CommonDict
* @param User $user User that modifies
* @param bool $notrigger false=launch triggers after, true=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 = false)
{
@ -373,7 +373,7 @@ class CGenericDic extends CommonDict
* @param User $user User that deletes
* @param bool $notrigger false=launch triggers after, true=disable 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 = false)
{

View file

@ -104,7 +104,7 @@ class Comment extends CommonObject
*
* @param User $user User that create
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create($user, $notrigger = 0)
{
@ -178,7 +178,7 @@ class Comment extends CommonObject
*
* @param int $id Id object
* @param int $ref ref object
* @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($id, $ref = '')
{
@ -304,7 +304,7 @@ class Comment extends CommonObject
*
* @param User $user User that delete
* @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 delete($user, $notrigger = 0)
{

View file

@ -107,7 +107,7 @@ trait CommonIncoterm
*
* @param int $id_incoterm Id of incoterm to set or '' to remove
* @param string $location location of incoterm
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setIncoterms($id_incoterm, $location)
{

View file

@ -1076,7 +1076,7 @@ abstract class CommonInvoice extends CommonObject
* @param User $fuser User asking the direct debit transfer
* @param int $id Invoice ID with remain to pay
* @param string $sourcetype Source ('facture' or 'supplier_invoice')
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function makeStripeCardRequest($fuser, $id, $sourcetype = 'facture')
{
@ -1093,7 +1093,7 @@ abstract class CommonInvoice extends CommonObject
* @param string $sourcetype Source ('facture' or 'supplier_invoice')
* @param string $service 'StripeTest', 'StripeLive', ...
* @param string $forcestripe To force another stripe env: 'cus_account@pk_...:sk_...'
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function makeStripeSepaRequest($fuser, $did, $type = 'direct-debit', $sourcetype = 'facture', $service = '', $forcestripe = '')
{

View file

@ -1700,7 +1700,7 @@ abstract class CommonObject
* Load object contact with id=$this->contact_id into $this->contact
*
* @param int $contactid Id du contact. Use this->contact_id if empty.
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch_contact($contactid = null)
{
@ -1725,7 +1725,7 @@ abstract class CommonObject
* Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty
*
* @param int $force_thirdparty_id Force thirdparty id
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch_thirdparty($force_thirdparty_id = 0)
{
@ -1912,7 +1912,7 @@ abstract class CommonObject
* Load the user with id $userid into this->user
*
* @param int $userid Id du contact
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch_user($userid)
{
@ -1961,7 +1961,7 @@ abstract class CommonObject
* @param string $field Field selected
* @param string $key Import key
* @param string $element Element name
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetchObjectFrom($table, $field, $key, $element = null)
{
@ -2003,7 +2003,7 @@ abstract class CommonObject
* @param string $table Table of element or element line
* @param int $id Element id
* @param string $field Field selected
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function getValueFrom($table, $id, $field)
{
@ -2035,7 +2035,7 @@ abstract class CommonObject
* @param User|string $fuser Update the user of last update field with this user. If not provided, current user is used except if value is 'none'
* @param string $trigkey Trigger key to run (in most cases something like 'XXX_MODIFY')
* @param string $fk_user_field Name of field to save user id making change
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
* @see updateExtraField()
*/
public function setValueFrom($field, $value, $table = '', $id = null, $format = '', $id_field = '', $fuser = null, $trigkey = '', $fk_user_field = 'fk_user_modif')
@ -2168,7 +2168,7 @@ abstract class CommonObject
* Use SQL and not Universal Search Filter. @TODO Replace this with an USF string after changing all ->next_prev_filter
* @param string $fieldid Name of field to use for the select MAX and MIN
* @param int $nodbprefix Do not include DB prefix to forge table name
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function load_previous_next_ref($filter, $fieldid, $nodbprefix = 0)
{
@ -2376,7 +2376,7 @@ abstract class CommonObject
*
* @param int $projectid Project id to link element to
* @param int $notrigger Disable the trigger
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setProject($projectid, $notrigger = 0)
{
@ -3014,7 +3014,7 @@ abstract class CommonObject
*
* @param User $user User object that make change
* @param string $modelpdf Modele name
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setDocModel($user, $modelpdf)
{
@ -3116,7 +3116,7 @@ abstract class CommonObject
* @param boolean $renum True to renum all already ordered lines, false to renum only not already ordered lines.
* @param string $rowidorder ASC or DESC
* @param boolean $fk_parent_line Table with fk_parent_line field or not
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function line_order($renum = false, $rowidorder = 'ASC', $fk_parent_line = true)
{
@ -3280,7 +3280,7 @@ abstract class CommonObject
*
* @param int $rowid Id of line
* @param int $rang Position
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function updateRangOfLine($rowid, $rang)
{
@ -3485,7 +3485,7 @@ abstract class CommonObject
* Update external ref of element
*
* @param string $ref_ext Update field ref_ext
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update_ref_ext($ref_ext)
{
@ -3516,7 +3516,7 @@ abstract class CommonObject
* @param string $note New value for note
* @param string $suffix '', '_public' or '_private'
* @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_note($note, $suffix = '', $notrigger = 0)
{
@ -3602,7 +3602,7 @@ abstract class CommonObject
* Update public note (kept for backward compatibility)
*
* @param string $note New value for note
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
* @deprecated
* @see update_note()
*/
@ -3621,7 +3621,7 @@ abstract class CommonObject
* @param string $roundingadjust 'none'=Do nothing, 'auto'=Use default method (MAIN_ROUNDOFTOTAL_NOT_TOTALOFROUND if defined, or '0'), '0'=Force mode Total of rounding, '1'=Force mode Rounding of total
* @param int $nodatabaseupdate 1=Do not update database total fields of the main object. Update only properties in memory. Can be used to save SQL when this method is called several times, so we can do it only once at end.
* @param Societe $seller If roundingadjust is '0' or '1' or maybe 'auto', it means we recalculate total for lines before calculating total for object and for this, we need seller object (used to analyze lines to check corrupted data).
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update_price($exclspec = 0, $roundingadjust = 'none', $nodatabaseupdate = 0, $seller = null)
{
@ -4010,7 +4010,7 @@ abstract class CommonObject
* @param int $alsosametype 0=Return only links to object that differs from source type. 1=Include also link to objects of same type.
* @param string $orderby SQL 'ORDER BY' clause
* @param int|string $loadalsoobjects Load also the array $this->linkedObjects. Use 0 to not load (increase performances), Use 1 to load all, Use value of type ('facture', 'facturerec', ...) to load only a type of object.
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
* @see add_object_linked(), updateObjectLinked(), deleteObjectLinked()
*/
public function fetchObjectLinked($sourceid = null, $sourcetype = '', $targetid = null, $targettype = '', $clause = 'OR', $alsosametype = 1, $orderby = 'sourcetype', $loadalsoobjects = 1)
@ -4232,7 +4232,7 @@ abstract class CommonObject
/**
* Clear the cache saying that all linked object were already loaded. So next fetchObjectLinked will reload all links.
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
* @see fetchObjectLinked()
*/
public function clearObjectLinkedCache()
@ -4492,7 +4492,7 @@ abstract class CommonObject
* @param string $elementType Type of element to force (use this->table_element by default)
* @param string $trigkey Trigger key to use for trigger. Use '' means automatic but it is not recommended and is deprecated.
* @param string $fieldstatus Name of status field in this->table_element
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setStatut($status, $elementId = null, $elementType = '', $trigkey = '', $fieldstatus = 'fk_statut')
{
@ -4945,7 +4945,7 @@ abstract class CommonObject
/**
* Set extra parameters
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setExtraParameters()
{
@ -5739,7 +5739,7 @@ abstract class CommonObject
* @param int $update_main_doc_field Update field main_doc fied into the table of object.
* This param is set when called for a document generation if document generator hase
* ->update_main_doc_field set and returns ->result['fullpath'].
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function indexFile($destfull, $update_main_doc_field)
{
@ -6299,7 +6299,7 @@ abstract class CommonObject
/**
* Delete all extra fields values for the current object.
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
* @see deleteExtraLanguages(), insertExtraField(), updateExtraField(), setValueFrom()
*/
public function deleteExtraFields()
@ -9545,7 +9545,7 @@ abstract class CommonObject
*
* @param User $user User that creates
* @param bool $notrigger false=launch triggers after, true=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function createCommon(User $user, $notrigger = false)
{
@ -9719,7 +9719,7 @@ abstract class CommonObject
* @param string $ref Ref
* @param string $morewhere More SQL filters (' AND ...')
* @param int $noextrafields 0=Default to load extrafields, 1=No extrafields
* @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 fetchCommon($id, $ref = null, $morewhere = '', $noextrafields = 0)
{
@ -9783,7 +9783,7 @@ abstract class CommonObject
*
* @param string $morewhere More SQL filters (' AND ...')
* @param int $noextrafields 0=Default to load extrafields, 1=No extrafields
* @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 fetchLinesCommon($morewhere = '', $noextrafields = 0)
{
@ -9839,7 +9839,7 @@ abstract class CommonObject
*
* @param User $user User that modifies
* @param bool $notrigger false=launch triggers after, true=disable triggers
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function updateCommon(User $user, $notrigger = false)
{
@ -10079,7 +10079,7 @@ abstract class CommonObject
* @param string $parentField Name of Foreign key parent column
* @param array $filter an array filter
* @param string $filtermode AND or OR
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
* @throws Exception
*/
public function deleteByParentField($parentId = 0, $parentField = '', $filter = array(), $filtermode = "AND")
@ -10215,7 +10215,7 @@ abstract class CommonObject
* @param int $status New status to set (often a constant like self::STATUS_XXX)
* @param int $notrigger 1=Does not execute triggers, 0=Execute triggers
* @param string $triggercode Trigger code to use
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setStatusCommon($user, $status, $notrigger = 0, $triggercode = '')
{
@ -10392,7 +10392,7 @@ abstract class CommonObject
* @param int[]|int $categories Category ID or array of Categories IDs
* @param string $type_categ Category type ('customer', 'supplier', 'website_page', ...) definied into const class Categorie type
* @param boolean $remove_existing True: Remove existings categories from Object if not supplies by $categories, False: let them
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setCategoriesCommon($categories, $type_categ = '', $remove_existing = true)
{

View file

@ -203,7 +203,7 @@ abstract class CommonObjectLine extends CommonObject
* @param int $offset offset limit
* @param array $filter filter array
* @param string $filtermode filter mode (AND or OR)
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetchAll($sortorder = '', $sortfield = '', $limit = 0, $offset = 0, array $filter = array(), $filtermode = 'AND')
{

View file

@ -63,7 +63,7 @@ class CProductNature extends CommonDict
*
* @param User $user User that create
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create($user, $notrigger = 0)
{
@ -105,7 +105,7 @@ class CProductNature extends CommonDict
*
* @param int $id Id of CUnit object to fetch (rowid)
* @param string $code Code
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($id, $code = '')
{
@ -228,7 +228,7 @@ class CProductNature extends CommonDict
*
* @param User $user User that modify
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update($user = null, $notrigger = 0)
{
@ -263,7 +263,7 @@ class CProductNature extends CommonDict
*
* @param User $user User that delete
* @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 delete($user, $notrigger = 0)
{

View file

@ -64,7 +64,7 @@ class Cregion extends CommonDict
*
* @param User $user User that create
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create($user, $notrigger = 0)
{
@ -194,7 +194,7 @@ class Cregion extends CommonDict
*
* @param User $user User that modify
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update($user = null, $notrigger = 0)
{
@ -260,7 +260,7 @@ class Cregion extends CommonDict
*
* @param User $user User that delete
* @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 delete($user, $notrigger = 0)
{

View file

@ -66,7 +66,7 @@ class Cstate extends CommonDict
*
* @param User $user User that create
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create($user, $notrigger = 0)
{
@ -132,7 +132,7 @@ class Cstate extends CommonDict
*
* @param int $id Id object
* @param string $code Code
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($id, $code = '')
{
@ -176,7 +176,7 @@ class Cstate extends CommonDict
*
* @param User $user User that modify
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update($user = null, $notrigger = 0)
{
@ -233,7 +233,7 @@ class Cstate extends CommonDict
*
* @param User $user User that delete
* @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 delete($user, $notrigger = 0)
{

View file

@ -54,7 +54,7 @@ class Ctypent extends CommonDict
*
* @param User $user User that create
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create($user, $notrigger = 0)
{
@ -131,7 +131,7 @@ class Ctypent extends CommonDict
* @param int $id Id object
* @param string $code Code
* @param string $label Label
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($id, $code = '', $label = '')
{
@ -178,7 +178,7 @@ class Ctypent extends CommonDict
*
* @param User $user User that modify
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update($user = null, $notrigger = 0)
{
@ -240,7 +240,7 @@ class Ctypent extends CommonDict
*
* @param User $user User that delete
* @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 delete($user, $notrigger = 0)
{

View file

@ -64,7 +64,7 @@ class Ctyperesource extends CommonDict
* @param User $user User that creates
* @param bool $notrigger false=launch triggers after, true=disable triggers
*
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create(User $user, $notrigger = false)
{
@ -137,7 +137,7 @@ class Ctyperesource extends CommonDict
* @param string $code code
* @param string $label Label
*
* @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($id, $code = '', $label = '')
{
@ -201,7 +201,7 @@ class Ctyperesource extends CommonDict
* @param array $filter filter array
* @param string $filtermode filter mode (AND or OR)
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetchAll($sortorder = '', $sortfield = '', $limit = 0, $offset = 0, array $filter = array(), $filtermode = 'AND')
{
@ -262,7 +262,7 @@ class Ctyperesource extends CommonDict
* @param User $user User that modifies
* @param bool $notrigger false=launch triggers after, true=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 = false)
{
@ -329,7 +329,7 @@ class Ctyperesource extends CommonDict
* @param User $user User that deletes
* @param bool $notrigger false=launch triggers after, true=disable 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 = false)
{

View file

@ -64,7 +64,7 @@ class CUnits extends CommonDict
*
* @param User $user User that create
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create($user, $notrigger = 0)
{
@ -149,7 +149,7 @@ class CUnits extends CommonDict
* @param string $code Code
* @param string $short_label Short Label ('g', 'kg', ...)
* @param string $unit_type Unit type ('size', 'surface', 'volume', 'weight', ...)
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($id, $code = '', $short_label = '', $unit_type = '')
{
@ -292,7 +292,7 @@ class CUnits extends CommonDict
*
* @param User $user User that modify
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update($user = null, $notrigger = 0)
{
@ -364,7 +364,7 @@ class CUnits extends CommonDict
*
* @param User $user User that delete
* @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 delete($user, $notrigger = 0)
{

View file

@ -176,7 +176,7 @@ class DefaultValues extends CommonObject
*
* @param User $user User that creates
* @param bool $notrigger false=launch triggers after, true=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create(User $user, $notrigger = false)
{
@ -232,7 +232,7 @@ class DefaultValues extends CommonObject
* Load object in memory from the database
*
* @param int $id Id object
* @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($id)
{
@ -323,7 +323,7 @@ class DefaultValues extends CommonObject
*
* @param User $user User that modifies
* @param bool $notrigger false=launch triggers after, true=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 = false)
{
@ -335,7 +335,7 @@ class DefaultValues extends CommonObject
*
* @param User $user User that deletes
* @param bool $notrigger false=launch triggers after, true=disable 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 = false)
{

View file

@ -242,7 +242,7 @@ class DiscountAbsolute
* Create a discount into database
*
* @param User $user User that create
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function create($user)
{
@ -317,7 +317,7 @@ class DiscountAbsolute
* Delete object in database. If fk_facture_source is defined, we delete all familiy with same fk_facture_source. If not, only with id is removed
*
* @param User $user Object of user asking to delete
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function delete($user)
{
@ -441,7 +441,7 @@ class DiscountAbsolute
*
* @param int $rowidline Invoice line id (To use discount into invoice lines)
* @param int $rowidinvoice Invoice id (To use discount as a credit note to reduce payment of invoice)
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function link_to_invoice($rowidline, $rowidinvoice)
{
@ -497,7 +497,7 @@ class DiscountAbsolute
* Link the discount to a particular invoice line or a particular invoice.
* Do not call this if discount is linked to a reconcialiated invoice
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function unlink_invoice()
{

View file

@ -159,7 +159,7 @@ class EmailSenderProfile extends CommonObject
*
* @param User $user User that creates
* @param bool $notrigger false=launch triggers after, true=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create(User $user, $notrigger = false)
{
@ -222,7 +222,7 @@ class EmailSenderProfile extends CommonObject
*
* @param int $id Id object
* @param string $ref Ref
* @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($id, $ref = null)
{
@ -236,7 +236,7 @@ class EmailSenderProfile extends CommonObject
/**
* Load object lines in memory from the database
*
* @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 fetchLines()
{
@ -252,7 +252,7 @@ class EmailSenderProfile extends CommonObject
*
* @param User $user User that modifies
* @param bool $notrigger false=launch triggers after, true=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 = false)
{
@ -264,7 +264,7 @@ class EmailSenderProfile extends CommonObject
*
* @param User $user User that deletes
* @param bool $notrigger false=launch triggers after, true=disable 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 = false)
{

View file

@ -145,7 +145,7 @@ class Events // extends CommonObject
* Create in database
*
* @param User $user User that create
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function create($user)
{
@ -201,7 +201,7 @@ class Events // extends CommonObject
*
* @param User $user User that modify
* @param int $notrigger 0=no, 1=yes (no update trigger)
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update($user = null, $notrigger = 0)
{
@ -235,7 +235,7 @@ class Events // extends CommonObject
*
* @param int $id Id object
* @param User $user User that load
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($id, $user = null)
{
@ -282,7 +282,7 @@ class Events // extends CommonObject
* Delete object in database
*
* @param User $user User that delete
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function delete($user)
{

View file

@ -131,7 +131,7 @@ class Fiscalyear extends CommonObject
* Create object in database
*
* @param User $user User making creation
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function create($user)
{
@ -186,7 +186,7 @@ class Fiscalyear extends CommonObject
* Update record
*
* @param User $user User making update
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update($user)
{
@ -223,7 +223,7 @@ class Fiscalyear extends CommonObject
* Load an object from database
*
* @param int $id Id of record to load
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($id)
{
@ -255,7 +255,7 @@ class Fiscalyear extends CommonObject
* Delete record
*
* @param int $id Id of record to delete
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function delete($id)
{

View file

@ -81,7 +81,7 @@ class FormFile
* @param int $capture 1=Add tag capture="capture" to force use of micro or video recording to generate file. When setting this to 1, you must also provide a value for $accept.
* @param int $disablemulti 0=Default, 1=Disable multiple file upload
* @param int $nooutput 0=Output result with print, 1=Return result
* @return int|string <0 if KO, >0 if OK, or string if $noouput=1
* @return int|string Return integer <0 if KO, >0 if OK, or string if $noouput=1
*/
public function form_attach_new_file($url, $title = '', $addcancel = 0, $sectionid = 0, $perm = 1, $size = 50, $object = null, $options = '', $useajax = 1, $savingdocmask = '', $linkfiles = 1, $htmlname = 'formuserfile', $accept = '', $sectiondir = '', $usewithoutform = 0, $capture = 0, $disablemulti = 0, $nooutput = 0)
{

View file

@ -79,7 +79,7 @@ class FormOrder extends Form
* @param string $selected Id of preselected input method
* @param string $htmlname Name of HTML select list
* @param int $addempty 0=list with no empty value, 1=list with empty value
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function selectInputMethod($selected = '', $htmlname = 'source_id', $addempty = 0)
{

View file

@ -524,7 +524,7 @@ class Ldap
* @param string $dn DN entry key
* @param array $info Attributes array
* @param User $user Objet user that create
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function add($dn, $info, $user)
{
@ -572,7 +572,7 @@ class Ldap
* @param string $dn DN entry key
* @param array $info Attributes array
* @param User $user Objet user that modify
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function modify($dn, $info, $user)
{
@ -630,7 +630,7 @@ class Ldap
* @param string $newparent New parent (ou=xxx,dc=aaa,dc=bbb)
* @param User $user Objet user that modify
* @param bool $deleteoldrdn If true the old RDN value(s) is removed, else the old RDN value(s) is retained as non-distinguished values of the entry.
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function rename($dn, $newrdn, $newparent, $user, $deleteoldrdn = true)
{
@ -674,7 +674,7 @@ class Ldap
* @param string $olddn Old DN entry key (before update)
* @param string $newrdn New RDN entry key (uid=qqq) (for ldap_rename)
* @param string $newparent New parent (ou=xxx,dc=aaa,dc=bbb) (for ldap_rename)
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update($dn, $info, $user, $olddn, $newrdn = false, $newparent = false)
{
@ -724,7 +724,7 @@ class Ldap
* Ldap object connect and bind must have been done
*
* @param string $dn DN entry key
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function delete($dn)
{
@ -794,7 +794,7 @@ class Ldap
*
* @param string $dn DN entry key
* @param array $info Attributes array
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function dump($dn, $info)
{
@ -871,7 +871,7 @@ class Ldap
* @param string $dn DN entry key
* @param array $info Attributes array
* @param User $user Objet user that create
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function addAttribute($dn, $info, $user)
{
@ -917,7 +917,7 @@ class Ldap
* @param string $dn DN entry key
* @param array $info Attributes array
* @param User $user Objet user that create
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function updateAttribute($dn, $info, $user)
{
@ -963,7 +963,7 @@ class Ldap
* @param string $dn DN entry key
* @param array $info Attributes array
* @param User $user Objet user that create
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function deleteAttribute($dn, $info, $user)
{

View file

@ -325,7 +325,7 @@ class Menubase
*
* @param User $user User that modify
* @param int $notrigger 0=no, 1=yes (no update trigger)
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function update($user = null, $notrigger = 0)
{
@ -390,7 +390,7 @@ class Menubase
*
* @param int $id Id object
* @param User $user User that load
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function fetch($id, $user = null)
{
@ -462,7 +462,7 @@ class Menubase
* Delete object in database
*
* @param User $user User that delete
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function delete($user)
{

View file

@ -197,7 +197,7 @@ class RssParser
* @param int $maxNb Max nb of records to get (0 for no limit)
* @param int $cachedelay 0=No cache, nb of seconds we accept cache files (cachedir must also be defined)
* @param string $cachedir Directory where to save cache file (For example $conf->externalrss->dir_temp)
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function parser($urlRSS, $maxNb = 0, $cachedelay = 60, $cachedir = '')
{

View file

@ -201,7 +201,7 @@ class TimeSpent extends CommonObject
*
* @param User $user User that creates
* @param bool $notrigger false=launch triggers after, true=disable triggers
* @return int <0 if KO, Id of created object if OK
* @return int Return integer <0 if KO, Id of created object if OK
*/
public function create(User $user, $notrigger = false)
{
@ -310,7 +310,7 @@ class TimeSpent extends CommonObject
*
* @param int $id Id object
* @param string $ref Ref
* @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($id, $ref = null)
{
@ -404,7 +404,7 @@ class TimeSpent extends CommonObject
*
* @param User $user User that modifies
* @param bool $notrigger false=launch triggers after, true=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 = false)
{
@ -416,7 +416,7 @@ class TimeSpent extends CommonObject
*
* @param User $user User that deletes
* @param bool $notrigger false=launch triggers, true=disable 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 = false)
{
@ -579,7 +579,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 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function setDraft($user, $notrigger = 0)
{

View file

@ -765,7 +765,7 @@ class Utils
* Generate documentation of a Module
*
* @param string $module Module name
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function generateDoc($module)
{
@ -1082,7 +1082,7 @@ class Utils
*
* @param string $outputfile Output file name
* @param string $tables Table name or '*' for all
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function backupTables($outputfile, $tables = '*')
{

View file

@ -362,7 +362,7 @@ interface Database
* @param string $field_name Name of field to add
* @param string $field_desc Associative array of description of the field to insert [parameter name][parameter value]
* @param string $field_position Optional ex .: "after field stuff"
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function DDLAddField($table, $field_name, $field_desc, $field_position = "");
// phpcs:enable
@ -373,7 +373,7 @@ interface Database
*
* @param string $table Name of table
* @param string $field_name Name of field to drop
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function DDLDropField($table, $field_name);
// phpcs:enable
@ -385,7 +385,7 @@ interface Database
* @param string $table Name of table
* @param string $field_name Name of field to modify
* @param string $field_desc Array with description of field format
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function DDLUpdateField($table, $field_name, $field_desc);
// phpcs:enable

View file

@ -925,7 +925,7 @@ class DoliDBMysqli extends DoliDB
* @param string $field_name Name of field to add
* @param string $field_desc Tableau associatif de description du champ a inserer[nom du parametre][valeur du parametre]
* @param string $field_position Optionnel ex.: "after champtruc"
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function DDLAddField($table, $field_name, $field_desc, $field_position = "")
{
@ -971,7 +971,7 @@ class DoliDBMysqli extends DoliDB
* @param string $table Name of table
* @param string $field_name Name of field to modify
* @param string $field_desc Array with description of field format
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function DDLUpdateField($table, $field_name, $field_desc)
{
@ -1016,7 +1016,7 @@ class DoliDBMysqli extends DoliDB
*
* @param string $table Name of table
* @param string $field_name Name of field to drop
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function DDLDropField($table, $field_name)
{

View file

@ -1207,7 +1207,7 @@ class DoliDBPgsql extends DoliDB
* @param string $field_name Name of field to add
* @param string $field_desc Tableau associatif de description du champ a inserer[nom du parametre][valeur du parametre]
* @param string $field_position Optionnel ex.: "after champtruc"
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function DDLAddField($table, $field_name, $field_desc, $field_position = "")
{
@ -1253,7 +1253,7 @@ class DoliDBPgsql extends DoliDB
* @param string $table Name of table
* @param string $field_name Name of field to modify
* @param string $field_desc Array with description of field format
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function DDLUpdateField($table, $field_name, $field_desc)
{
@ -1298,7 +1298,7 @@ class DoliDBPgsql extends DoliDB
*
* @param string $table Name of table
* @param string $field_name Name of field to drop
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function DDLDropField($table, $field_name)
{

View file

@ -1079,7 +1079,7 @@ class DoliDBSqlite3 extends DoliDB
* @param string $field_name Name of field to add
* @param string $field_desc Tableau associatif de description du champ a inserer[nom du parametre][valeur du parametre]
* @param string $field_position Optionnel ex.: "after champtruc"
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function DDLAddField($table, $field_name, $field_desc, $field_position = "")
{
@ -1125,7 +1125,7 @@ class DoliDBSqlite3 extends DoliDB
* @param string $table Name of table
* @param string $field_name Name of field to modify
* @param string $field_desc Array with description of field format
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function DDLUpdateField($table, $field_name, $field_desc)
{
@ -1149,7 +1149,7 @@ class DoliDBSqlite3 extends DoliDB
*
* @param string $table Name of table
* @param string $field_name Name of field to drop
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function DDLDropField($table, $field_name)
{

View file

@ -555,7 +555,7 @@ function run_sql($sqlfile, $silent = 1, $entity = 0, $usesavepoint = 1, $handler
* @param DoliDB $db Database handler
* @param string|int $name Name of constant or rowid of line
* @param int $entity Multi company id, -1 for all entities
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*
* @see dolibarr_get_const(), dolibarr_set_const(), dol_set_user_param()
*/
@ -1913,7 +1913,7 @@ function showModulesExludedForExternal($modules)
* @param string $type Model type
* @param string $label Model label
* @param string $description Model description
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
function addDocumentModel($name, $type, $label = '', $description = '')
{
@ -1944,7 +1944,7 @@ function addDocumentModel($name, $type, $label = '', $description = '')
*
* @param string $name Model name
* @param string $type Model type
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
function delDocumentModel($name, $type)
{

View file

@ -2167,7 +2167,7 @@ function dol_convert_file($fileinput, $ext = 'png', $fileoutput = '', $page = ''
* @param string $outputfile Target file name
* @param string $mode 'gz' or 'bz' or 'zip'
* @param string $errorstring Error string
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
* @see dol_uncompress(), dol_compress_dir()
*/
function dol_compress_file($inputfile, $outputfile, $mode = "gz", &$errorstring = null)
@ -2420,7 +2420,7 @@ function dol_uncompress($inputfile, $outputdir)
* @param string $excludefiles A regex pattern. For example: '/\.log$|\/temp\//'
* @param string $rootdirinzip Add a root dir level in zip file
* @param string $newmask Mask for new file (0 by default means $conf->global->MAIN_UMASK). Example: '0666'
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
* @see dol_uncompress(), dol_compress_file()
*/
function dol_compress_dir($inputdir, $outputfile, $mode = "zip", $excludefiles = '', $rootdirinzip = '', $newmask = 0)

View file

@ -1775,7 +1775,7 @@ function weight_convert($weight, &$from_unit, $to_unit)
* @param Conf $conf Object conf
* @param User $user Object user
* @param array $tab Array (key=>value) with all parameters to save/update
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*
* @see dolibarr_get_const(), dolibarr_set_const(), dolibarr_del_const()
*/

View file

@ -377,7 +377,7 @@ function makesalt($type = CRYPT_SALT_LENGTH)
* Encode or decode database password in config file
*
* @param int $level Encode level: 0 no encoding, 1 encoding
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
function encodedecode_dbpassconf($level = 0)
{

View file

@ -229,7 +229,7 @@ function delivery_prepare_head($object)
* @param string $origin Origin ('commande', ...)
* @param int $origin_id Origin id
* @param string $filter Filter
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
function show_list_sending_receive($origin, $origin_id, $filter = '')
{

View file

@ -441,7 +441,7 @@ function dolWebsiteOutput($content, $contenttype = 'html', $containerid = '')
* @param int $websiteid ID of website
* @param string $websitepagetype Type of page ('blogpost', 'page', ...)
* @param int $websitepageid ID of page
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
function dolWebsiteIncrementCounter($websiteid, $websitepagetype, $websitepageid)
{

View file

@ -131,7 +131,7 @@ class modPhpbarcode extends ModeleBarCode
* @param string $readable Code can be read (What is this ? is this used ?)
* @param integer $scale Scale
* @param integer $nooutputiferror No output if error
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function buildBarCode($code, $encoding, $readable = 'Y', $scale = 1, $nooutputiferror = 0)
{
@ -181,7 +181,7 @@ class modPhpbarcode extends ModeleBarCode
* @param string $readable Code can be read
* @param integer $scale Scale
* @param integer $nooutputiferror No output if error
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function writeBarCode($code, $encoding, $readable = 'Y', $scale = 1, $nooutputiferror = 0)
{

View file

@ -101,7 +101,7 @@ class modTcpdfbarcode extends ModeleBarCode
* @param string $readable Code can be read (What is this ? is this used ?)
* @param integer $scale Scale (not used with this engine)
* @param integer $nooutputiferror No output if error (not used with this engine)
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function buildBarCode($code, $encoding, $readable = 'Y', $scale = 1, $nooutputiferror = 0)
{
@ -149,7 +149,7 @@ class modTcpdfbarcode extends ModeleBarCode
* @param string $readable Code can be read
* @param integer $scale Scale (not used with this engine)
* @param integer $nooutputiferror No output if error (not used with this engine)
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function writeBarCode($code, $encoding, $readable = 'Y', $scale = 1, $nooutputiferror = 0)
{

View file

@ -81,7 +81,7 @@ abstract class ModeleChequeReceipts extends CommonDocGenerator
* @param string $message Message
* @param string $modele Force le modele a utiliser ('' to not force)
* @param Translate $outputlangs Object lang a utiliser pour traduction
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
* TODO Use commonDocGenerator
*/
function chequereceipt_pdf_create($db, $id, $message, $modele, $outputlangs)

View file

@ -669,7 +669,7 @@ class pdf_einstein extends ModelePDFCommandes
* @param Commande $object Object order
* @param int $posy Position y in PDF
* @param Translate $outputlangs Object langs for output
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
protected function _tableau_versements(&$pdf, $object, $posy, $outputlangs)
{

View file

@ -874,7 +874,7 @@ class pdf_eratosthene extends ModelePDFCommandes
* @param Commande $object Object order
* @param int $posy Position y in PDF
* @param Translate $outputlangs Object langs for output
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
protected function drawPaymentsTable(&$pdf, $object, $posy, $outputlangs)
{

View file

@ -1008,7 +1008,7 @@ class pdf_standard extends ModeleExpenseReport
* @param ExpenseReport $object Object expensereport
* @param int $posy Position y in PDF
* @param Translate $outputlangs Object langs for output
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
protected function tablePayments(&$pdf, $object, $posy, $outputlangs)
{

View file

@ -71,7 +71,7 @@ class ExportCsvIso extends ExportCsv
* @param array $array_selected_sorted Array with list of field to export
* @param Translate $outputlangs Object lang to translate values
* @param array $array_types Array with types of fields
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function write_title($array_export_fields_label, $array_selected_sorted, $outputlangs, $array_types)
{
@ -89,7 +89,7 @@ class ExportCsvIso extends ExportCsv
* @param resource $objp A record from a fetch with all fields from select
* @param Translate $outputlangs Object lang to translate values
* @param array $array_types Array with types of fields
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function write_record($array_selected_sorted, $objp, $outputlangs, $array_types)
{

View file

@ -69,7 +69,7 @@ class ExportCsvUtf8 extends ExportCsv
* @param array $array_selected_sorted Array with list of field to export
* @param Translate $outputlangs Object lang to translate values
* @param array $array_types Array with types of fields
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function write_title($array_export_fields_label, $array_selected_sorted, $outputlangs, $array_types)
{
@ -87,7 +87,7 @@ class ExportCsvUtf8 extends ExportCsv
* @param resource $objp A record from a fetch with all fields from select
* @param Translate $outputlangs Object lang to translate values
* @param array $array_types Array with types of fields
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function write_record($array_selected_sorted, $objp, $outputlangs, $array_types)
{

View file

@ -224,7 +224,7 @@ class ExportExcel2007 extends ModeleExports
* Write header
*
* @param Translate $outputlangs Object lang to translate values
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function write_header($outputlangs)
{
@ -243,7 +243,7 @@ class ExportExcel2007 extends ModeleExports
* @param array $array_selected_sorted Array with list of field to export
* @param Translate $outputlangs Object lang to translate values
* @param array $array_types Array with types of fields
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function write_title($array_export_fields_label, $array_selected_sorted, $outputlangs, $array_types)
{
@ -303,7 +303,7 @@ class ExportExcel2007 extends ModeleExports
* @param resource $objp A record from a fetch with all fields from select
* @param Translate $outputlangs Object lang to translate values
* @param array $array_types Array with types of fields
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function write_record($array_selected_sorted, $objp, $outputlangs, $array_types)
{
@ -407,7 +407,7 @@ class ExportExcel2007 extends ModeleExports
* Write footer
*
* @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 write_footer($outputlangs)
{
@ -420,7 +420,7 @@ class ExportExcel2007 extends ModeleExports
/**
* Close Excel file
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function close_file()
{

View file

@ -183,7 +183,7 @@ class ExportTsv extends ModeleExports
* Output header into file
*
* @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 write_header($outputlangs)
{
@ -200,7 +200,7 @@ class ExportTsv extends ModeleExports
* @param array $array_selected_sorted Array with list of field to export
* @param Translate $outputlangs Object lang to translate values
* @param array $array_types Array with types of fields
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function write_title($array_export_fields_label, $array_selected_sorted, $outputlangs, $array_types)
{
@ -233,7 +233,7 @@ class ExportTsv extends ModeleExports
* @param Resource $objp A record from a fetch with all fields from select
* @param Translate $outputlangs Object lang to translate values
* @param array $array_types Array with types of fields
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function write_record($array_selected_sorted, $objp, $outputlangs, $array_types)
{
@ -288,7 +288,7 @@ class ExportTsv extends ModeleExports
* Output footer into file
*
* @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 write_footer($outputlangs)
{
@ -300,7 +300,7 @@ class ExportTsv extends ModeleExports
/**
* Close file handle
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function close_file()
{

View file

@ -161,7 +161,7 @@ class ExportCsv extends ModeleExports
* Output header into file
*
* @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 write_header($outputlangs)
{
@ -178,7 +178,7 @@ class ExportCsv extends ModeleExports
* @param array $array_selected_sorted Array with list of field to export
* @param Translate $outputlangs Object lang to translate values
* @param array $array_types Array with types of fields
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function write_title($array_export_fields_label, $array_selected_sorted, $outputlangs, $array_types)
{
@ -216,7 +216,7 @@ class ExportCsv extends ModeleExports
* @param Resource $objp A record from a fetch with all fields from select
* @param Translate $outputlangs Object lang to translate values
* @param array $array_types Array with types of fields
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function write_record($array_selected_sorted, $objp, $outputlangs, $array_types)
{
@ -277,7 +277,7 @@ class ExportCsv extends ModeleExports
* Output footer into file
*
* @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 write_footer($outputlangs)
{
@ -289,7 +289,7 @@ class ExportCsv extends ModeleExports
/**
* Close file handle
*
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function close_file()
{

View file

@ -907,7 +907,7 @@ class pdf_crabe extends ModelePDFFactures
* @param int $posy Position y in PDF
* @param Translate $outputlangs Object langs for output
* @param int $heightforfooter Height for footer
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
protected function _tableau_versements(&$pdf, $object, $posy, $outputlangs, $heightforfooter = 0)
{

View file

@ -1056,7 +1056,7 @@ class pdf_sponge extends ModelePDFFactures
* @param Facture $object Object invoice
* @param int $posy Position y in PDF
* @param Translate $outputlangs Object langs for output
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function drawPaymentsTable(&$pdf, $object, $posy, $outputlangs)
{

View file

@ -301,7 +301,7 @@ class ImportCsv extends ModeleImports
* @param int $maxfields Max number of fields to use
* @param string $importid Import key
* @param array $updatekeys Array of keys to use to try to do an update first before insert. This field are defined into the module descriptor.
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function import_insert($arrayrecord, $array_match_file_to_database, $objimport, $maxfields, $importid, $updatekeys)
{

View file

@ -344,7 +344,7 @@ class ImportXlsx extends ModeleImports
* @param int $maxfields Max number of fields to use
* @param string $importid Import key
* @param array $updatekeys Array of keys to use to try to do an update first before insert. This field are defined into the module descriptor.
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
public function import_insert($arrayrecord, $array_match_file_to_database, $objimport, $maxfields, $importid, $updatekeys)
{

View file

@ -73,7 +73,7 @@ class ModelePDFCards
* @param string $outputdir Output directory
* @param string $template pdf generenate document class to use default 'standard'
* @param string $filename Name of output file (without extension)
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
function members_card_pdf_create($db, $arrayofmembers, $modele, $outputlangs, $outputdir = '', $template = 'standard', $filename = 'tmp_cards')
{

View file

@ -661,7 +661,7 @@ class pdf_vinci extends ModelePDFMo
* @param CommandeFournisseur $object Object order
* @param int $posy Position y in PDF
* @param Translate $outputlangs Object langs for output
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
protected function _tableau_versements(&$pdf, $object, $posy, $outputlangs)
{

View file

@ -73,7 +73,7 @@ class ModelePDFLabels
* @param string $outputdir Output directory
* @param string $template pdf generenate document class to use default 'standardlabel'
* @param string $filename Short file name of PDF output file
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
function doc_label_pdf_create($db, $arrayofrecords, $modele, $outputlangs, $outputdir = '', $template = 'standardlabel', $filename = 'tmp_address_sheet.pdf')
{

View file

@ -856,7 +856,7 @@ class pdf_azur extends ModelePDFPropales
* @param Propal $object Object proposal
* @param int $posy Position y in PDF
* @param Translate $outputlangs Object langs for output
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
protected function _tableau_versements(&$pdf, $object, $posy, $outputlangs)
{

View file

@ -975,7 +975,7 @@ class pdf_cyan extends ModelePDFPropales
* @param Propal $object Object proposal
* @param int $posy Position y in PDF
* @param Translate $outputlangs Object langs for output
* @return int <0 if KO, >0 if OK
* @return int Return integer <0 if KO, >0 if OK
*/
protected function drawPaymentsTable(&$pdf, $object, $posy, $outputlangs)
{

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