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

Revert "Scrutinizer Auto-Fixes"

Browse Source
This commit is contained in:
Laurent Destailleur 2014-07-21 19:07:56 +02:00
parent d5ab896782
commit 161f5eadd4
189 changed files with 479 additions and 530 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
htdocs/adherents/class/adherent.class.php
View File

@ -1241,7 +1241,7 @@ class Adherent extends CommonObject
* @param string $num_chq Numero cheque (if Id bank account provided)
* @param string $emetteur_nom Name of cheque writer
* @param string $emetteur_banque Name of bank of cheque
* @param integer $datesubend Date end subscription
* @param timestamp $datesubend Date end subscription
* @return int rowid of record added, <0 if KO
*/
function cotisation($date, $montant, $accountid=0, $operation='', $label='', $num_chq='', $emetteur_nom='', $emetteur_banque='', $datesubend=0)

6
htdocs/cashdesk/class/Facturation.class.php
View File

@ -266,7 +266,7 @@ class Facturation
* Getter for id
*
* @param int $aId Id
* @return null|integer
* @return id
*/
public function id($aId=null)
{
@ -390,7 +390,7 @@ class Facturation
* Getter for montant_remise
*
* @param int $aMontantRemise Amount
* @return null|integer Amount
* @return string Amount
*/
public function montantRemise($aMontantRemise=null)
{
@ -415,7 +415,7 @@ class Facturation
* Getter for prix
*
* @param int $aPrix Price
* @return null|integer Stock
* @return string Stock
*/
public function prix ( $aPrix=null )
{

2
htdocs/categories/categorie.php
View File

@ -609,7 +609,7 @@ else if ($id || $ref)
* @param Object $object Object we want to see categories it can be classified into
* @param int $typeid Type of category (0, 1, 2, 3)
* @param int $socid Id thirdparty
* @param integer $showclassifyform 1=Add form to 'Classify', 0=Do not show form to 'Classify'
* @param string $showclassifyform 1=Add form to 'Classify', 0=Do not show form to 'Classify'
* @return int 0
*/
function formCategory($db,$object,$typeid,$socid=0,$showclassifyform=1)

4
htdocs/categories/class/categorie.class.php
View File

@ -327,7 +327,7 @@ class Categorie extends CommonObject
* Delete a category from database
*
* @param User $user Object user that ask to delete
* @return integer
* @return void
*/
function delete($user)
{
@ -980,7 +980,7 @@ class Categorie extends CommonObject
/**
* Check if no category with same label already exists for this cat's parent or root and for this cat's type
*
* @return integer 1 if already exist, 0 otherwise, -1 if error
* @return boolean 1 if already exist, 0 otherwise, -1 if error
*/
function already_exists()
{

2
htdocs/comm/action/class/cactioncomm.class.php
View File

@ -100,7 +100,7 @@ class CActionComm
* @param int $active 1 or 0 to filter on event state active or not ('' by default = no filter)
* @param string $idorcode 'id' or 'code'
* @param string $excludetype Type to exclude
* @param integer $onlyautoornot Group list by auto events or not
* @param string $onlyautoornot Group list by auto events or not
* @return array Array of all event types if OK, <0 if KO
*/
function liste_array($active='',$idorcode='id',$excludetype='',$onlyautoornot=0)

2
htdocs/comm/action/class/ical.class.php
View File

@ -257,7 +257,7 @@ class ICal
* Parse RRULE return array
*
* @param string $value string
* @return string
* @return array
*/
function ical_rrule($value)
{

16
htdocs/comm/propal/class/propal.class.php
View File

@ -292,12 +292,12 @@ class Propal extends CommonObject
* @param double $pu_ht Prix unitaire
* @param double $qty Quantite
* @param double $txtva Taux de tva
* @param integer $txlocaltax1 Local tax 1 rate
* @param integer $txlocaltax2 Local tax 2 rate
* @param double $txlocaltax1 Local tax 1 rate
* @param double $txlocaltax2 Local tax 2 rate
* @param int $fk_product Id du produit/service predefini
* @param integer $remise_percent Pourcentage de remise de la ligne
* @param double $remise_percent Pourcentage de remise de la ligne
* @param string $price_base_type HT or TTC
* @param integer $pu_ttc Prix unitaire TTC
* @param double $pu_ttc Prix unitaire TTC
* @param int $info_bits Bits de type de lignes
* @param int $type Type of line (product, service)
* @param int $rang Position of line
@ -308,7 +308,7 @@ class Propal extends CommonObject
* @param string $label ???
* @param int $date_start Start date of the line
* @param int $date_end End date of the line
* @param integer $array_option extrafields array
* @param array $array_option extrafields array
* @return int >0 if OK, <0 if KO
*
* @see add_product
@ -466,8 +466,8 @@ class Propal extends CommonObject
* @param double $qty Quantity
* @param double $remise_percent Remise effectuee sur le produit
* @param double $txtva Taux de TVA
* @param integer $txlocaltax1 Local tax 1 rate
* @param integer $txlocaltax2 Local tax 2 rate
* @param double $txlocaltax1 Local tax 1 rate
* @param double $txlocaltax2 Local tax 2 rate
* @param string $desc Description
* @param double $price_base_type HT ou TTC
* @param int $info_bits Miscellaneous informations
@ -480,7 +480,7 @@ class Propal extends CommonObject
* @param int $type 0/1=Product/service
* @param int $date_start Start date of the line
* @param int $date_end End date of the line
* @param integer $array_option extrafields array
* @param array $array_option extrafields array
* @return int 0 if OK, <0 if KO
*/
function updateline($rowid, $pu, $qty, $remise_percent, $txtva, $txlocaltax1=0, $txlocaltax2=0, $desc='', $price_base_type='HT', $info_bits=0, $special_code=0, $fk_parent_line=0, $skip_update_total=0, $fk_fournprice=0, $pa_ht=0, $label='', $type=0, $date_start='', $date_end='', $array_option=0)

20
htdocs/commande/class/commande.class.php
View File

@ -1037,14 +1037,14 @@ class Commande extends CommonOrder
* @param double $pu_ht Unit price (without tax)
* @param double $qty Quantite
* @param double $txtva Taux de tva force, sinon -1
* @param integer $txlocaltax1 Local tax 1 rate
* @param integer $txlocaltax2 Local tax 2 rate
* @param double $txlocaltax1 Local tax 1 rate
* @param double $txlocaltax2 Local tax 2 rate
* @param int $fk_product Id du produit/service predefini
* @param integer $remise_percent Pourcentage de remise de la ligne
* @param double $remise_percent Pourcentage de remise de la ligne
* @param int $info_bits Bits de type de lignes
* @param int $fk_remise_except Id remise
* @param string $price_base_type HT or TTC
* @param integer $pu_ttc Prix unitaire TTC
* @param double $pu_ttc Prix unitaire TTC
* @param timestamp $date_start Start date of the line - Added by Matelli (See http://matelli.fr/showcases/patchs-dolibarr/add-dates-in-order-lines.html)
* @param timestamp $date_end End date of the line - Added by Matelli (See http://matelli.fr/showcases/patchs-dolibarr/add-dates-in-order-lines.html)
* @param int $type Type of line (0=product, 1=service)
@ -1054,7 +1054,7 @@ class Commande extends CommonOrder
* @param int $fk_fournprice Id supplier price
* @param int $pa_ht Buying price (without tax)
* @param string $label Label
* @param integer $array_option extrafields array
* @param array $array_option extrafields array
* @return int >0 if OK, <0 if KO
*
* @see add_product
@ -1233,7 +1233,7 @@ class Commande extends CommonOrder
*
* @param int $idproduct Product Id
* @param double $qty Quantity
* @param integer $remise_percent Product discount relative
* @param double $remise_percent Product discount relative
* @param timestamp $date_start Start date of the line - Added by Matelli (See http://matelli.fr/showcases/patchs-dolibarr/add-dates-in-order-lines.html)
* @param timestamp $date_end End date of the line - Added by Matelli (See http://matelli.fr/showcases/patchs-dolibarr/add-dates-in-order-lines.html)
* @return void
@ -2273,8 +2273,8 @@ class Commande extends CommonOrder
* @param double $qty Quantity
* @param double $remise_percent Pourcentage de remise de la ligne
* @param double $txtva Taux TVA
* @param integer $txlocaltax1 Local tax 1 rate
* @param integer $txlocaltax2 Local tax 2 rate
* @param double $txlocaltax1 Local tax 1 rate
* @param double $txlocaltax2 Local tax 2 rate
* @param string $price_base_type HT or TTC
* @param int $info_bits Miscellaneous informations on line
* @param timestamp $date_start Start date of the line
@ -2286,7 +2286,7 @@ class Commande extends CommonOrder
* @param int $pa_ht Price (without tax) of product when it was bought
* @param string $label Label
* @param int $special_code Special code (also used by externals modules!)
* @param integer $array_option extrafields array
* @param array $array_option extrafields array
* @return int < 0 if KO, > 0 if OK
*/
function updateline($rowid, $desc, $pu, $qty, $remise_percent, $txtva, $txlocaltax1=0,$txlocaltax2=0, $price_base_type='HT', $info_bits=0, $date_start='', $date_end='', $type=0, $fk_parent_line=0, $skip_update_total=0, $fk_fournprice=null, $pa_ht=0, $label='', $special_code=0, $array_option=0)
@ -2932,7 +2932,7 @@ class Commande extends CommonOrder
/**
* Return an array of order lines
*
* @return integer Lines of order
* @return array Lines of order
*/
function getLinesArray()
{

4
htdocs/compta/bank/class/account.class.php
View File

@ -1142,7 +1142,7 @@ class AccountLine extends CommonObject
/**
* Delete transaction bank line record
*
* @param integer $user User object that delete
* @param User $user User object that delete
* @return int <0 if KO, >0 if OK
*/
function delete($user=0)
@ -1191,7 +1191,7 @@ class AccountLine extends CommonObject
/**
* Delete bank line records
*
* @param integer $user User object that delete
* @param User $user User object that delete
* @return int <0 if KO, >0 if OK
*/
function delete_urls($user=0)

2
htdocs/compta/bank/class/bankcateg.class.php
View File

@ -168,7 +168,7 @@ class BankCateg // extends CommonObject
/**
* Update database
*
* @param integer $user User that modify
* @param User $user User that modify
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, >0 if OK
*/

4
htdocs/compta/facture/class/facture-rec.class.php
View File

@ -401,11 +401,11 @@ class FactureRec extends Facture
* @param double $qty Quantite
* @param double $txtva Taux de tva force, sinon -1
* @param int $fk_product Id du produit/service predefini
* @param integer $remise_percent Pourcentage de remise de la ligne
* @param double $remise_percent Pourcentage de remise de la ligne
* @param string $price_base_type HT or TTC
* @param int $info_bits Bits de type de lignes
* @param int $fk_remise_except Id remise
* @param integer $pu_ttc Prix unitaire TTC (> 0 even for credit note)
* @param double $pu_ttc Prix unitaire TTC (> 0 even for credit note)
* @param int $type Type of line (0=product, 1=service)
* @param int $rang Position of line
* @param int $special_code Special code

18
htdocs/compta/facture/class/facture.class.php
View File

@ -1018,7 +1018,7 @@ class Facture extends CommonInvoice
/**
* Update database
*
* @param integer $user User that modify
* @param User $user User that modify
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, >0 if OK
*/
@ -1885,17 +1885,17 @@ class Facture extends CommonInvoice
* @param double $pu_ht Unit price without tax (> 0 even for credit note)
* @param double $qty Quantity
* @param double $txtva Force vat rate, -1 for auto
* @param integer $txlocaltax1 Local tax 1 rate
* @param integer $txlocaltax2 Local tax 2 rate
* @param double $txlocaltax1 Local tax 1 rate
* @param double $txlocaltax2 Local tax 2 rate
* @param int $fk_product Id of predefined product/service
* @param integer $remise_percent Percent of discount on line
* @param double $remise_percent Percent of discount on line
* @param timestamp $date_start Date start of service
* @param timestamp $date_end Date end of service
* @param int $ventil Code of dispatching into accountancy
* @param int $info_bits Bits de type de lignes
* @param int $fk_remise_except Id discount used
* @param string $price_base_type 'HT' or 'TTC'
* @param integer $pu_ttc Unit price with tax (> 0 even for credit note)
* @param double $pu_ttc Unit price with tax (> 0 even for credit note)
* @param int $type Type of line (0=product, 1=service)
* @param int $rang Position of line
* @param int $special_code Special code (also used by externals modules!)
@ -1905,7 +1905,7 @@ class Facture extends CommonInvoice
* @param int $fk_fournprice Supplier price id (to calculate margin) or ''
* @param int $pa_ht Buying price of line (to calculate margin) or ''
* @param string $label Label of the line (deprecated, do not use)
* @param integer $array_option extrafields array
* @param array $array_option extrafields array
* @return int <0 if KO, Id of line if OK
*/
function addline($desc, $pu_ht, $qty, $txtva, $txlocaltax1=0, $txlocaltax2=0, $fk_product=0, $remise_percent=0, $date_start='', $date_end='', $ventil=0, $info_bits=0, $fk_remise_except='', $price_base_type='HT', $pu_ttc=0, $type=self::TYPE_STANDARD, $rang=-1, $special_code=0, $origin='', $origin_id=0, $fk_parent_line=0, $fk_fournprice=null, $pa_ht=0, $label='', $array_option=0)
@ -2068,8 +2068,8 @@ class Facture extends CommonInvoice
* @param date $date_start Date de debut de validite du service
* @param date $date_end Date de fin de validite du service
* @param double $txtva VAT Rate
* @param integer $txlocaltax1 Local tax 1 rate
* @param integer $txlocaltax2 Local tax 2 rate
* @param double $txlocaltax1 Local tax 1 rate
* @param double $txlocaltax2 Local tax 2 rate
* @param string $price_base_type HT or TTC
* @param int $info_bits Miscellaneous informations
* @param int $type Type of line (0=product, 1=service)
@ -2079,7 +2079,7 @@ class Facture extends CommonInvoice
* @param int $pa_ht Price (without tax) of product when it was bought
* @param string $label Label of the line (deprecated, do not use)
* @param int $special_code Special code (also used by externals modules!)
* @param integer $array_option extrafields array
* @param array $array_option extrafields array
* @return int < 0 if KO, > 0 if OK
*/
function updateline($rowid, $desc, $pu, $qty, $remise_percent, $date_start, $date_end, $txtva, $txlocaltax1=0, $txlocaltax2=0, $price_base_type='HT', $info_bits=0, $type= self::TYPE_STANDARD, $fk_parent_line=0, $skip_update_total=0, $fk_fournprice=null, $pa_ht=0, $label='', $special_code=0, $array_option=0)

2
htdocs/compta/facture/class/paymentterm.class.php
View File

@ -257,7 +257,7 @@ class PaymentTerm // extends CommonObject
/**
* Update database
*
* @param integer $user User that modify
* @param User $user User that modify
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, >0 if OK
*/

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

@ -123,7 +123,7 @@ class Localtax extends CommonObject
/**
* Update database
*
* @param integer $user User that modify
* @param User $user User that modify
* @param int $notrigger 0=no, 1=yes (no update trigger)
* @return int <0 if KO, >0 if OK
*/

2
htdocs/compta/paiement/cheque/class/remisecheque.class.php
View File

@ -274,7 +274,7 @@ class RemiseCheque extends CommonObject
* Supprime la remise en base
*
* @param User $user Utilisateur qui effectue l'operation
* @return integer
* @return void
*/
function delete($user='')
{

7
htdocs/compta/prelevement/class/bonprelevement.class.php
View File

@ -172,7 +172,6 @@ class BonPrelevement extends CommonObject
* @param string $code_guichet code of bank's office
* @param string $number bank account number
* @param string $number_key number key of account number
* @param integer $line_id
* @return int >0 if OK, <0 if KO
*/
function addline(&$line_id, $client_id, $client_nom, $amount, $code_banque, $code_guichet, $number, $number_key)
@ -248,7 +247,7 @@ class BonPrelevement extends CommonObject
* Read errors
*
* @param int $error id of error
* @return string Array of errors
* @return array Array of errors
*/
function ReadError($error)
{
@ -1505,7 +1504,7 @@ class BonPrelevement extends CommonObject
* @param string $row_bic rib.bic AS bic,
* @param string $row_datec soc.datec,
* @param string $row_drum soc.rowid AS drum
* @return string
* @return void
*/
function EnregDestinataireSEPA($row_code_client, $row_nom, $row_address, $row_zip, $row_town, $row_country_code, $row_cb, $row_cg, $row_cc, $row_somme, $row_facnumber, $row_idfac, $row_iban, $row_bic, $row_datec, $row_drum)
{
@ -1627,7 +1626,7 @@ class BonPrelevement extends CommonObject
* @param int $nombre 0 or 1
* @param float $total Total
* @param string $CrLf End of line character
* @return string
* @return SEPA
*/
function EnregEmetteurSEPA($configuration, $ladate, $nombre, $total, $CrLf='\n')
{ // SEPA INITIALISATION

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

@ -61,7 +61,7 @@ class LignePrelevement
* Recupere l'objet prelevement
*
* @param int $rowid id de la facture a recuperer
* @return integer
* @return void
*/
function fetch($rowid)
{

2
htdocs/compta/prelevement/class/rejetprelevement.class.php
View File

@ -317,7 +317,7 @@ class RejetPrelevement
* Retrieve withdrawal object
*
* @param int $rowid id of invoice to retrieve
* @return integer
* @return void
*/
function fetch($rowid)
{

4
htdocs/compta/salaries/class/paymentsalary.class.php
View File

@ -69,7 +69,7 @@ class PaymentSalary extends CommonObject
/**
* Update database
*
* @param integer $user User that modify
* @param User $user User that modify
* @param int $notrigger 0=no, 1=yes (no update trigger)
* @return int <0 if KO, >0 if OK
*/
@ -141,7 +141,7 @@ class PaymentSalary extends CommonObject
* Load object in memory from database
*
* @param int $id id object
* @param integer $user User that load
* @param User $user User that load
* @return int <0 if KO, >0 if OK
*/
function fetch($id, $user=0)

6
htdocs/compta/sociales/class/chargesociales.class.php
View File

@ -63,7 +63,7 @@ class ChargeSociales extends CommonObject
* Retrouve et charge une charge sociale
*
* @param int $id 1 si trouve, 0 sinon
* @return integer|null
* @return void
*/
function fetch($id)
{
@ -320,7 +320,7 @@ class ChargeSociales extends CommonObject
* Retourne le libelle du statut d'une charge (impaye, payee)
*
* @param int $mode 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long
* @param integer $alreadypaid 0=No payment already done, >0=Some payments were already done (we recommand to put here amount payed if you have it, 1 otherwise)
* @param double $alreadypaid 0=No payment already done, >0=Some payments were already done (we recommand to put here amount payed if you have it, 1 otherwise)
* @return string Label
*/
function getLibStatut($mode=0,$alreadypaid=-1)
@ -333,7 +333,7 @@ class ChargeSociales extends CommonObject
*
* @param int $statut Id statut
* @param int $mode 0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto
* @param integer $alreadypaid 0=No payment already done, >0=Some payments were already done (we recommand to put here amount payed if you have it, 1 otherwise)
* @param double $alreadypaid 0=No payment already done, >0=Some payments were already done (we recommand to put here amount payed if you have it, 1 otherwise)
* @return string Label
*/
function LibStatut($statut,$mode=0,$alreadypaid=-1)

2
htdocs/compta/sociales/class/paymentsocialcontribution.class.php
View File

@ -216,7 +216,7 @@ class PaymentSocialContribution extends CommonObject
/**
* Update database
*
* @param integer $user User that modify
* @param User $user User that modify
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, >0 if OK
*/

4
htdocs/compta/tva/class/tva.class.php
View File

@ -139,7 +139,7 @@ class Tva extends CommonObject
/**
* Update database
*
* @param integer $user User that modify
* @param User $user User that modify
* @param int $notrigger 0=no, 1=yes (no update trigger)
* @return int <0 if KO, >0 if OK
*/
@ -202,7 +202,7 @@ class Tva extends CommonObject
* Load object in memory from database
*
* @param int $id id object
* @param integer $user User that load
* @param User $user User that load
* @return int <0 if KO, >0 if OK
*/
function fetch($id, $user=0)

6
htdocs/contact/class/contact.class.php
View File

@ -215,7 +215,7 @@ class Contact extends CommonObject
* Update informations into database
*
* @param int $id Id of contact/address to update
* @param integer $user Objet user making change
* @param User $user Objet user making change
* @param int $notrigger 0=no, 1=yes
* @param string $action Current action for hookmanager
* @return int <0 if KO, >0 if OK
@ -424,7 +424,7 @@ class Contact extends CommonObject
* Update field alert birthday
*
* @param int $id Id of contact
* @param integer $user User asking to change alert or birthday
* @param User $user User asking to change alert or birthday
* @return int <0 if KO, >=0 if OK
*/
function update_perso($id, $user=0)
@ -489,7 +489,7 @@ class Contact extends CommonObject
* Load object contact
*
* @param int $id id du contact
* @param integer $user Utilisateur (abonnes aux alertes) qui veut les alertes de ce contact
* @param User $user Utilisateur (abonnes aux alertes) qui veut les alertes de ce contact
* @return int -1 if KO, 0 if OK but not found, 1 if OK
*/
function fetch($id, $user=0)

8
htdocs/contrat/class/contrat.class.php
View File

@ -953,7 +953,7 @@ class Contrat extends CommonObject
/**
* Update object into database
*
* @param integer $user User that modifies
* @param User $user User that modifies
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, >0 if OK
*/
@ -1061,7 +1061,7 @@ class Contrat extends CommonObject
* @param timestamp $date_start Date de debut prevue
* @param timestamp $date_end Date de fin prevue
* @param float $price_base_type HT or TTC
* @param integer $pu_ttc Prix unitaire TTC
* @param float $pu_ttc Prix unitaire TTC
* @param int $info_bits Bits de type de lignes
* @param int $fk_fournprice Fourn price id
* @param int $pa_ht Buying price HT
@ -1218,8 +1218,8 @@ class Contrat extends CommonObject
* @param timestamp $date_start Date de debut prevue
* @param timestamp $date_end Date de fin prevue
* @param float $tvatx Taux TVA
* @param integer $localtax1tx Local tax 1 rate
* @param integer $localtax2tx Local tax 2 rate
* @param float $localtax1tx Local tax 1 rate
* @param float $localtax2tx Local tax 2 rate
* @param timestamp $date_debut_reel Date de debut reelle
* @param timestamp $date_fin_reel Date de fin reelle
* @param float $price_base_type HT or TTC

10
htdocs/core/class/CMailFile.class.php
View File

@ -356,7 +356,7 @@ class CMailFile
/**
* Send mail that was prepared by constructor
*
* @return string|boolean True if mail sent, false otherwise
* @return boolean True if mail sent, false otherwise
*/
function sendfile()
{
@ -518,10 +518,6 @@ class CMailFile
// Encode subject according to RFC 2822 - http://en.wikipedia.org/wiki/MIME#Encoded-Word
/**
* @param string $stringtoencode
*/
function encodetorfc2822($stringtoencode)
{
global $conf;
@ -645,7 +641,7 @@ class CMailFile
/**
* Create SMTP headers (mode = 'mail')
*
* @return string headers
* @return smtp headers
*/
function write_smtpheaders()
{
@ -696,7 +692,7 @@ class CMailFile
*
* @param array $filename_list Array of filenames
* @param array $mimefilename_list Array of mime types
* @return string mime headers
* @return array mime headers
*/
function write_mimeheaders($filename_list, $mimefilename_list)
{

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

@ -207,7 +207,7 @@ abstract class CommonDocGenerator
/**
* Define array with couple subtitution key => subtitution value
*
* @param Contact $object contact
* @param Object $object contact
* @param Translate $outputlangs object for output
* @param array_key $array_key Name of the key for return array
* @return array of substitution key->code
@ -426,7 +426,7 @@ abstract class CommonDocGenerator
/**
* Define array with couple substitution key => substitution value
*
* @param Expedition $object Main object to use as data source
* @param Object $object Main object to use as data source
* @param Translate $outputlangs Lang object to use for output
* @param array_key $array_key Name of the key for return array
* @return array Array of substitution

6
htdocs/core/class/commoninvoice.class.php
View File

@ -155,7 +155,7 @@ abstract class CommonInvoice extends CommonObject
* Return label of object status
*
* @param int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=short label + picto
* @param integer $alreadypaid 0=No payment already done, >0=Some payments were already done (we recommand to put here amount payed if you have it, 1 otherwise)
* @param double $alreadypaid 0=No payment already done, >0=Some payments were already done (we recommand to put here amount payed if you have it, 1 otherwise)
* @return string Label
*/
function getLibStatut($mode=0,$alreadypaid=-1)
@ -169,7 +169,7 @@ abstract class CommonInvoice extends CommonObject
* @param int $paye Status field paye
* @param int $status Id status
* @param int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=short label + picto
* @param integer $alreadypaid 0=No payment already done, >0=Some payments were already done (we recommand to put here amount payed if you have it, 1 otherwise)
* @param double $alreadypaid 0=No payment already done, >0=Some payments were already done (we recommand to put here amount payed if you have it, 1 otherwise)
* @param int $type Type facture
* @return string Libelle du statut
*/
@ -293,7 +293,7 @@ abstract class CommonInvoice extends CommonObject
* Renvoi une date limite de reglement de facture en fonction des
* conditions de reglements de la facture et date de facturation
*
* @param integer $cond_reglement Condition of payment (code or id) to use. If 0, we use current condition.
* @param string $cond_reglement Condition of payment (code or id) to use. If 0, we use current condition.
* @return date Date limite de reglement si ok, <0 si ko
*/
function calculate_date_lim_reglement($cond_reglement=0)

20
htdocs/core/class/commonobject.class.php
View File

@ -476,8 +476,8 @@ abstract class CommonObject
*
* @param string $source 'internal', 'external' or 'all'
* @param string $order Sort order by : 'code' or 'rowid'
* @param integer $option 0=Return array id->label, 1=Return array code->label
* @param integer $activeonly 0=all type of contact, 1=only the active
* @param string $option 0=Return array id->label, 1=Return array code->label
* @param string $activeonly 0=all type of contact, 1=only the active
* @return array Array list of type of contacts (id->label if option=0, code->label if option=1)
*/
function liste_type_contact($source='internal', $order='code', $option=0, $activeonly=0)
@ -1117,7 +1117,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 integer|null
* @return void
*/
function line_order($renum=false, $rowidorder='ASC', $fk_parent_line=true)
{
@ -2293,7 +2293,7 @@ abstract class CommonObject
*
* @param object $extrafields Extrafield Object
* @param string $mode Show output (view) or input (edit) for extrafield
* @param integer $params Optionnal parameters
* @param array $params Optionnal parameters
* @param string $keyprefix Prefix string to add into name and id of field (can be used to avoid duplicate names)
*
* @return string
@ -2525,7 +2525,7 @@ abstract class CommonObject
/**
* Set extra parameters
*
* @return integer
* @return void
*/
function setExtraParameters()
{
@ -2612,7 +2612,7 @@ abstract class CommonObject
* TODO Move this into html.class.php
* But for the moment we don't know if it's possible as we keep a method available on overloaded objects.
*
* @return integer|null
* @return void
*/
function showLinkedObjectBlock()
{
@ -2731,7 +2731,7 @@ abstract class CommonObject
* @param string $action Action code
* @param string $seller Object of seller third party
* @param string $buyer Object of buyer third party
* @param integer $selected Object line selected
* @param string $selected Object line selected
* @param int $dateSelector 1=Show also date range input fields
* @return void
*/
@ -2829,8 +2829,8 @@ abstract class CommonObject
* @param int $dateSelector 1=Show also date range input fields
* @param string $seller Object of seller third party
* @param string $buyer Object of buyer third party
* @param integer $selected Object line selected
* @param integer $extrafieldsline Object of extrafield line attribute
* @param string $selected Object line selected
* @param object $extrafieldsline Object of extrafield line attribute
* @return void
*/
function printObjectLine($action,$line,$var,$num,$i,$dateSelector,$seller,$buyer,$selected=0,$extrafieldsline=0)
@ -3105,7 +3105,7 @@ abstract class CommonObject
* get Margin info
*
* @param string $force_price True of not
* @return integer Array with info
* @return mixed Array with info
*/
function getMarginInfos($force_price=false)
{

2
htdocs/core/class/cookie.class.php
View File

@ -109,7 +109,7 @@ class DolCookie
*
* @param string $cookie Cookie name
* @param string $value Cookie value
* @param integer $expire Expiration
* @param string $expire Expiration
* @param string $path Path of cookie
* @param string $domain Domain name
* @param int $secure 0 or 1

2
htdocs/core/class/cpays.class.php
View File

@ -187,7 +187,7 @@ class Cpays // extends CommonObject
/**
* Update object into database
*
* @param integer $user User that modify
* @param User $user User that modify
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, >0 if OK
*/

2
htdocs/core/class/ctypent.class.php
View File

@ -194,7 +194,7 @@ class Ctypent // extends CommonObject
/**
* Update object into database
*
* @param integer $user User that modify
* @param User $user User that modify
* @param int $notrigger 0=launch triggers after, 1=disable triggers
* @return int <0 if KO, >0 if OK
*/

2
htdocs/core/class/doleditor.class.php
View File

@ -142,7 +142,7 @@ class DolEditor
*
* @param int $noprint 1=Return HTML string instead of printing it to output
* @param string $morejs Add more js. For example: ".on( \'saveSnapshot\', function(e) { alert(\'ee\'); });"
* @return string|null
* @return void
*/
function Create($noprint=0,$morejs='')
{

2
htdocs/core/class/dolgeoip.class.php
View File

@ -40,7 +40,7 @@ class DolGeoIP
*
* @param string $type 'country' or 'city'
* @param string $datfile Data file
* @return integer|null
* @return GeoIP
*/
function __construct($type,$datfile)
{

10
htdocs/core/class/dolgraph.class.php
View File

@ -115,7 +115,7 @@ class DolGraph
* Set Y precision
*
* @param float $which_prec Precision
* @return boolean
* @return string
*/
function SetPrecisionY($which_prec)
{
@ -187,7 +187,7 @@ class DolGraph
* Set y label
*
* @param string $label Y label
* @return boolean|null True
* @return boolean True
*/
function SetYLabel($label)
{
@ -198,7 +198,7 @@ class DolGraph
* Set width
*
* @param int $w Width
* @return boolean|null True
* @return boolean True
*/
function SetWidth($w)
{
@ -554,7 +554,7 @@ class DolGraph
/**
* Return min value of all data
*
* @return double Max value of all data
* @return int Max value of all data
*/
function GetFloorMinValue()
{
@ -578,7 +578,7 @@ class DolGraph
*
* @param string $file Image file name to use to save onto disk (also used as javascript unique id)
* @param string $fileurl Url path to show image if saved onto disk
* @return integer|null
* @return void
*/
function draw($file,$fileurl='')
{

4
htdocs/core/class/events.class.php
View File

@ -150,7 +150,7 @@ class Events // extends CommonObject
/**
* Update database
*
* @param integer $user User that modify
* @param User $user User that modify
* @param int $notrigger 0=no, 1=yes (no update trigger)
* @return int <0 if KO, >0 if OK
*/
@ -188,7 +188,7 @@ class Events // extends CommonObject
* Load object in memory from database
*
* @param int $id Id object
* @param integer $user User that load
* @param User $user User that load
* @return int <0 if KO, >0 if OK
*/
function fetch($id, $user=0)

2
htdocs/core/class/extrafields.class.php
View File

@ -102,7 +102,7 @@ class ExtraFields
* @param int $unique Is field unique or not
* @param int $required Is field required or not
* @param string $default_value Defaulted value
* @param integer $param Params for field
* @param array $param Params for field
* @return int <=0 if KO, >0 if OK
*/
function addExtraField($attrname, $label, $type, $pos, $size, $elementtype, $unique=0, $required=0,$default_value='', $param=0)

14
htdocs/core/class/fileupload.class.php
View File

@ -261,7 +261,7 @@ class FileUpload
*
* @param string $file_name Filename
* @param string $options is array('max_width', 'max_height')
* @return boolean
* @return void
*/
protected function createScaledImage($file_name, $options)
{
@ -296,7 +296,7 @@ class FileUpload
* @param string $file File
* @param string $error Error
* @param string $index Index
* @return boolean
* @return unknown|string
*/
protected function validate($uploaded_file, $file, $error, $index)
{
@ -378,10 +378,10 @@ class FileUpload
/**
* Enter description here ...
*
* @param string $name Filename
* @param string $type ???
* @param string $index ???
* @return string
* @param unknown_type $name Filename
* @param unknown_type $type ???
* @param unknown_type $index ???
* @return void
*/
protected function trimFileName($name, $type, $index)
{
@ -408,7 +408,7 @@ class FileUpload
* Enter description here ...
*
* @param unknown_type $file_path ???
* @return boolean Success or not
* @return int Success or not
*/
protected function orientImage($file_path)
{

36
htdocs/core/class/html.form.class.php
View File

@ -468,7 +468,7 @@ class Form
* @param string $selected Id or Code or Label of preselected country
* @param string $htmlname Name of html select object
* @param string $htmloption Options html on select object
* @param integer $maxlength Max length for labels (0=no limit)
* @param string $maxlength Max length for labels (0=no limit)
* @return string HTML string with select
*/
function select_country($selected='',$htmlname='country_id',$htmloption='',$maxlength=0)
@ -544,7 +544,7 @@ class Form
* @param string $htmlname Name of field in html form
* @param int $showempty Add an empty field
* @param int $hidetext Do not show label 'Type' before combo box (used only if there is at least 2 choices to select)
* @param integer $forceall 1=Force to show products and services in combo list, whatever are activated modules, 0=No force, -1=Force none (and set hidden field to 'service')
* @param string $forceall 1=Force to show products and services in combo list, whatever are activated modules, 0=No force, -1=Force none (and set hidden field to 'service')
* @return void
*/
function select_type_of_lines($selected='',$htmlname='type',$showempty=0,$hidetext=0,$forceall=0)
@ -947,9 +947,9 @@ class Form
* @param int $showempty 0=no empty value, 1=add an empty value
* @param string $exclude List of contacts id to exclude
* @param string $limitto Disable answers that are not id in this array list
* @param integer $showfunction Add function into label
* @param string $showfunction Add function into label
* @param string $moreclass Add more class to class style
* @param integer $showsoc Add company into label
* @param string $showsoc Add company into label
* @param int $forcecombo Force to use combo box
* @param array $events Event options. Example: array(array('method'=>'getContacts', 'url'=>dol_buildpath('/core/ajax/contacts.php',1), 'htmlname'=>'contactid', 'params'=>array('add-customer-contact'=>'disabled')))
* @param bool $options_only Return options only (for ajax treatment)
@ -970,10 +970,10 @@ class Form
* @param int $showempty 0=no empty value, 1=add an empty value, 2=add line 'Internal' (used by user edit)
* @param string $exclude List of contacts id to exclude
* @param string $limitto Disable answers that are not id in this array list
* @param integer $showfunction Add function into label
* @param string $showfunction Add function into label
* @param string $moreclass Add more class to class style
* @param bool $options_only Return options only (for ajax treatment)
* @param integer $showsoc Add company into label
* @param string $showsoc Add company into label
* @param int $forcecombo Force to use combo box
* @param array $events Event options. Example: array(array('method'=>'getContacts', 'url'=>dol_buildpath('/core/ajax/contacts.php',1), 'htmlname'=>'contactid', 'params'=>array('add-customer-contact'=>'disabled')))
* @return int <0 if KO, Nb of contact in list if OK
@ -1907,7 +1907,7 @@ class Form
*
* @param int $productid Id of product
* @param string $htmlname Name of HTML field
* @return string|null
* @return void
*/
function select_product_fourn_price($productid,$htmlname='productfournpriceid')
{
@ -2001,7 +2001,7 @@ class Form
* @param int $socid Id of company
* @param string $htmlname Name of HTML field
* @param int $showempty Add an empty field
* @return integer|null
* @return void
*/
function select_address($selected, $socid, $htmlname='address_id',$showempty=0)
{
@ -2286,7 +2286,7 @@ class Form
*
* @param string $selected Id du type de paiement pre-selectionne
* @param string $htmlname Nom de la zone select
* @param integer $filtertype Pour filtre
* @param string $filtertype Pour filtre
* @param int $addempty Ajoute entree vide
* @return void
*/
@ -2389,7 +2389,7 @@ class Form
*
* @param string $selected Id pre-selectionne
* @param string $htmlname Nom de la zone select
* @return string
* @return void
*/
function load_PriceBaseType($selected='',$htmlname='price_base_type')
{
@ -2527,7 +2527,7 @@ class Form
* @param string $htmlname HTML field name
* @param int $maxlength Maximum length for labels
* @param int $excludeafterid Exclude all categories after this leaf in category tree.
* @return string
* @return void
*/
function select_all_categories($type, $selected='', $htmlname="parent", $maxlength=64, $excludeafterid=0)
{
@ -3299,7 +3299,7 @@ class Form
*
* @param string $selected preselected currency code
* @param string $htmlname name of HTML select list
* @return string
* @return void
*/
function selectCurrency($selected='',$htmlname='currency_id')
{
@ -3398,7 +3398,7 @@ class Form
* Si vendeur et acheteur dans Communauté européenne et acheteur= entreprise alors TVA par défaut=0. Fin de règle.
* Sinon la TVA proposee par defaut=0. Fin de regle.
* @param bool $options_only Return options only (for ajax treatment)
* @return string
* @return void
*/
function load_tva($htmlname='tauxtva', $selectedrate='', $societe_vendeuse='', $societe_acheteuse='', $idprod=0, $info_bits=0, $type='', $options_only=false)
{
@ -3550,7 +3550,7 @@ class Form
* @param int $nooutput Do not output html string but return it
* @param int $disabled Disable input fields
* @param int $fullday When a checkbox with this html name is on, hour and day are set with 00:00 or 23:59
* @return string|null Nothing or string if nooutput is 1
* @return mixed Nothing or string if nooutput is 1
* @see form_date
*/
function select_date($set_time='', $prefix='re', $h=0, $m=0, $empty=0, $form_name="", $d=1, $addnowbutton=0, $nooutput=0, $disabled=0, $fullday='')
@ -3777,7 +3777,7 @@ class Form
* @param int $iSecond Default preselected duration (number of seconds)
* @param int $disabled Disable the combo box
* @param string $typehour If 'select' then input hour and input min is a combo, if 'text' input hour is in text and input min is a combo
* @param integer $minunderhours If 1, show minutes selection under the hours
* @param string $minunderhours If 1, show minutes selection under the hours
* @return void
*/
function select_duration($prefix, $iSecond='', $disabled=0, $typehour='select', $minunderhours=0)
@ -3977,7 +3977,7 @@ class Form
* @param string $value Pre-selected value
* @param int $option 0 return yes/no, 1 return 1/0
* @param bool $disabled true or false
* @return string See option
* @return mixed See option
*/
function selectyesno($htmlname,$value='',$option=0,$disabled=false)
{
@ -4072,7 +4072,7 @@ class Form
* @param string $morehtmlref Code html supplementaire a afficher apres ref
* @param string $moreparam More param to add in nav link url.
* @param int $nodbprefix Do not include DB prefix to forge table name
* @return string Portion HTML avec ref + boutons nav
* @return tring Portion HTML avec ref + boutons nav
*/
function showrefnav($object,$paramid,$morehtml='',$shownav=1,$fieldid='rowid',$fieldref='ref',$morehtmlref='',$moreparam='',$nodbprefix=0)
{
@ -4235,7 +4235,7 @@ class Form
* @param string $include Array list of groups id to include
* @param int $enableonly Array list of groups id to be enabled. All other must be disabled
* @param int $force_entity 0 or Id of environment to force
* @return string
* @return void
* @see select_dolusers
*/
function select_dolgroups($selected='', $htmlname='groupid', $show_empty=0, $exclude='', $disabled=0, $include='', $enableonly='', $force_entity=0)

6
htdocs/core/class/html.formactions.class.php
View File

@ -52,8 +52,8 @@ class FormActions
* @param string $selected Preselected value (-1..100)
* @param int $canedit 1=can edit, 0=read only
* @param string $htmlname Name of html prefix for html fields (selectX and valX)
* @param integer $showempty Show an empty line if select is used
* @param integer $onlyselect 0=Standard, 1=Hide percent of completion and force usage of a select list, 2=Same than 1 and add "Incomplete (Todo+Running)
* @param string $showempty Show an empty line if select is used
* @param string $onlyselect 0=Standard, 1=Hide percent of completion and force usage of a select list, 2=Same than 1 and add "Incomplete (Todo+Running)
* @return void
*/
function form_select_status_action($formname,$selected,$canedit=1,$htmlname='complete',$showempty=0,$onlyselect=0)
@ -229,7 +229,7 @@ class FormActions
* @param string $selected Type pre-selected (can be 'manual', 'auto' or 'AC_xxx'
* @param string $htmlname Nom champ formulaire
* @param string $excludetype Type to exclude
* @param integer $onlyautoornot Group list by auto events or not: We keep only the 2 generic lines (AC_OTH and AC_OTH_AUTO)
* @param string $onlyautoornot Group list by auto events or not: We keep only the 2 generic lines (AC_OTH and AC_OTH_AUTO)
* @param int $hideinfohelp 1=Do not show info help
* @return void
*/

6
htdocs/core/class/html.formadmin.class.php
View File

@ -50,7 +50,7 @@ class FormAdmin
* @param string $selected Langue pre-selectionnee
* @param string $htmlname Nom de la zone select
* @param int $showauto Affiche choix auto
* @param integer $filter Array of keys to exclude in list
* @param array $filter Array of keys to exclude in list
* @param int $showempty Add empty value
* @param int $showwarning Show a warning if language is not complete
* @return string Return HTML select string with list of languages
@ -114,7 +114,7 @@ class FormAdmin
* @param string $htmlname Name of html select
* @param array $dirmenuarray Array of directories to scan
* @param string $moreattrib More attributes on html select tag
* @return integer|null
* @return void
*/
function select_menu($selected, $htmlname, $dirmenuarray, $moreattrib='')
{
@ -324,7 +324,7 @@ class FormAdmin
*
* @param string $selected Paper format pre-selected
* @param string $htmlname Name of HTML select field
* @param integer $filter Value to filter on code
* @param string $filter Value to filter on code
* @param int $showempty Add empty value
* @return string Return HTML output
*/

2
htdocs/core/class/html.formbank.class.php
View File

@ -44,7 +44,7 @@ class FormBank
/**
* Retourne la liste des types de comptes financiers
*
* @param integer $selected Type pre-selectionne
* @param string $selected Type pre-selectionne
* @param string $htmlname Nom champ formulaire
* @return void
*/

6
htdocs/core/class/html.formcompany.class.php
View File

@ -207,7 +207,7 @@ class FormCompany
* Ainsi les liens avec les departements se font sur un departement independemment de son nom.
*
* @param string $selected Code state preselected (mus be state id)
* @param integer $country_codeid Country code or id: 0=list for all countries, otherwise country code or country rowid to show
* @param string $country_codeid Country code or id: 0=list for all countries, otherwise country code or country rowid to show
* @param string $htmlname Id of department
* @return string String with HTML select
*/
@ -413,7 +413,7 @@ class FormCompany
* Dans le cas d'une liste tous pays confondu, on affiche une rupture sur le pays.
*
* @param string $selected Code forme juridique a pre-selectionne
* @param integer $country_codeid 0=liste tous pays confondus, sinon code du pays a afficher
* @param mixed $country_codeid 0=liste tous pays confondus, sinon code du pays a afficher
* @param string $filter Add a SQL filter on list
* @return void
* @deprecated Use print xxx->select_juridicalstatus instead
@ -711,7 +711,7 @@ class FormCompany
* @param string $fields Fields
* @param int $fieldsize Field size
* @param int $disableautocomplete 1 To disable autocomplete features
* @return string
* @return void
*/
function select_ziptown($selected='', $htmlname='zipcode', $fields='', $fieldsize=0, $disableautocomplete=0)
{

4
htdocs/core/class/html.formcron.class.php
View File

@ -46,8 +46,8 @@ class FormCron extends Form
* Display On Off selector
*
* @param string $htmlname Html control name
* @param integer $selected selected value
* @param integer $readonly Select is read only or not
* @param string $selected selected value
* @param string $readonly Select is read only or not
* @return string HTML select field
*/
function select_typejob($htmlname,$selected=0,$readonly=0)

16
htdocs/core/class/html.formfile.class.php
View File

@ -62,9 +62,9 @@ class FormFile
* @param int $size Length of input file area
* @param Object $object Object to use (when attachment is done on an element)
* @param string $options Add an option column
* @param integer $useajax Use fileupload ajax (0=never, 1=if enabled, 2=always whatever is option). 2 should never be used.
* @param boolean $useajax Use fileupload ajax (0=never, 1=if enabled, 2=always whatever is option). 2 should never be used.
* @param string $savingdocmask Mask to use to define output filename. For example 'XXXXX-__YYYYMMDD__-__file__'
* @param integer $linkfiles 1=Also add form to link files, 0=Do not show form to link files
* @param string $linkfiles 1=Also add form to link files, 0=Do not show form to link files
* @param string $htmlname Name and id of HTML form
* @return int <0 if KO, >0 if OK
*/
@ -215,11 +215,11 @@ class FormFile
* @param int $genallowed Generation is allowed (1/0 or array of formats)
* @param int $delallowed Remove is allowed (1/0)
* @param string $modelselected Model to preselect by default
* @param integer $allowgenifempty Show warning if no model activated
* @param integer $forcenomultilang Do not show language option (even if MAIN_MULTILANGS defined)
* @param string $allowgenifempty Show warning if no model activated
* @param string $forcenomultilang Do not show language option (even if MAIN_MULTILANGS defined)
* @param int $iconPDF Show only PDF icon with link (1/0)
* @param int $maxfilenamelength Max length for filename shown
* @param integer $noform Do not output html form tags
* @param string $noform Do not output html form tags
* @param string $param More param on http links
* @param string $title Title to show on top of form
* @param string $buttonlabel Label on submit button
@ -244,11 +244,11 @@ class FormFile
* @param int $genallowed Generation is allowed (1/0 or array list of templates)
* @param int $delallowed Remove is allowed (1/0)
* @param string $modelselected Model to preselect by default
* @param integer $allowgenifempty Allow generation even if list of template ($genallowed) is empty (show however a warning)
* @param integer $forcenomultilang Do not show language option (even if MAIN_MULTILANGS defined)
* @param string $allowgenifempty Allow generation even if list of template ($genallowed) is empty (show however a warning)
* @param string $forcenomultilang Do not show language option (even if MAIN_MULTILANGS defined)
* @param int $iconPDF Obsolete, see getDocumentsLink
* @param int $maxfilenamelength Max length for filename shown
* @param integer $noform Do not output html form tags
* @param string $noform Do not output html form tags
* @param string $param More param on http links
* @param string $title Title to show on top of form
* @param string $buttonlabel Label on submit button

2
htdocs/core/class/html.formmailing.class.php
View File

@ -48,7 +48,7 @@ class FormMailing extends Form
*
* @param string $selectedid the selected id
* @param string $htmlname name of controm
* @param integer $show_empty show empty option
* @param number $show_empty show empty option
* @return string HTML select
*/
public function selectDestinariesStatus($selectedid='',$htmlname='dest_status', $show_empty=0) {

2
htdocs/core/class/html.formorder.class.php
View File

@ -102,7 +102,7 @@ class FormOrder
* @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 integer Tableau des sources de commandes
* @return array Tableau des sources de commandes
*/
function selectInputMethod($selected='',$htmlname='source_id',$addempty=0)
{

15
htdocs/core/class/html.formother.class.php
View File

@ -157,7 +157,7 @@ class FormOther
*
* @param string $selected Preselected ecotaxes
* @param string $htmlname Name of combo list
* @return integer
* @return void
*/
function select_ecotaxes($selected='',$htmlname='ecotaxe_id')
{
@ -268,7 +268,7 @@ class FormOther
/**
* Return a HTML select list to select a percent
*
* @param integer $selected pourcentage pre-selectionne
* @param string $selected pourcentage pre-selectionne
* @param string $htmlname nom de la liste deroulante
* @param int $disabled Disabled or not
* @param int $increment increment value
@ -303,7 +303,7 @@ class FormOther
* Return select list for categories (to use in form search selectors)
*
* @param int $type Type of categories (0=product, 1=suppliers, 2=customers, 3=members)
* @param integer $selected Preselected value
* @param string $selected Preselected value
* @param string $htmlname Name of combo list
* @param int $nocateg Show also an entry "Not categorized"
* @return string Html combo list code
@ -469,7 +469,6 @@ class FormOther
* @param int $selectedtask Id selected task
* @param int $selectedproject Id selected project
* @param int $disablechildoftaskid 1=Disable task that are child of the provided task id
* @param integer $inc
* @return void
*/
private function _pLineSelect(&$inc, $parent, $lines, $level=0, $selectedtask=0, $selectedproject=0, $disablechildoftaskid=0)
@ -580,7 +579,7 @@ class FormOther
* @param int $showcolorbox 1=Show color code and color box, 0=Show only color code
* @param array $arrayofcolors Array of colors. Example: array('29527A','5229A3','A32929','7A367A','B1365F','0D7813')
* @param string $morecss Add css style into input field
* @return string
* @return void
*/
function selectColor($set_color='', $prefix='f_color', $form_name='objForm', $showcolorbox=1, $arrayofcolors='', $morecss='')
{
@ -710,7 +709,7 @@ class FormOther
* @param string $selected Preselected value
* @param string $htmlname Nom de la zone select
* @param int $useempty Affiche valeur vide dans liste
* @return string
* @return void
*/
function select_dayofweek($selected='',$htmlname='weekid',$useempty=0)
{
@ -751,7 +750,7 @@ class FormOther
* @param string $selected Preselected value
* @param string $htmlname Nom de la zone select
* @param int $useempty Affiche valeur vide dans liste
* @return string
* @return void
*/
function select_month($selected='',$htmlname='monthid',$useempty=0)
{
@ -811,7 +810,7 @@ class FormOther
* @param int $offset Offset
* @param int $invert Invert
* @param string $option Option
* @return string
* @return void
*/
function selectyear($selected='',$htmlname='yearid',$useempty=0, $min_year=10, $max_year=5, $offset=0, $invert=0, $option='')
{

6
htdocs/core/class/ldap.class.php
View File

@ -345,7 +345,7 @@ class Ldap
/**
* Change ldap protocol version to use.
*
* @return boolean version
* @return string version
*/
function setVersion() {
// LDAP_OPT_PROTOCOL_VERSION est une constante qui vaut 17
@ -356,7 +356,7 @@ class Ldap
/**
* changement du referrals.
*
* @return boolean referrals
* @return string referrals
*/
function setReferrals() {
// LDAP_OPT_REFERRALS est une constante qui vaut ?
@ -1308,7 +1308,7 @@ class Ldap
* Convertit le temps ActiveDirectory en Unix timestamp
*
* @param string $value AD time to convert
* @return integer Unix timestamp
* @return string Unix timestamp
*/
function convert_time($value)
{

4
htdocs/core/class/menu.class.php
View File

@ -53,7 +53,7 @@ class Menu
*
* @param string $url Url to follow on click
* @param string $titre Label of menu to add
* @param integer $level Level of menu to add
* @param string $level Level of menu to add
* @param int $enabled Menu active or not (0=Not active, 1=Active, 2=Active but grey)
* @param string $target Target lien
* @param string $mainmenu Main menu ('home', 'companies', 'products', ...)
@ -71,7 +71,7 @@ class Menu
* @param int $idafter Array key after which inserting new entry
* @param string $url Url to follow on click
* @param string $titre Label of menu to add
* @param integer $level Level of menu to add
* @param string $level Level of menu to add
* @param int $enabled Menu active or not
* @param string $target Target lien
* @param string $mainmenu Main menu ('home', 'companies', 'products', ...)

6
htdocs/core/class/menubase.class.php
View File

@ -71,7 +71,7 @@ class Menubase
/**
* Create menu entry into database
*
* @param integer $user User that create
* @param User $user User that create
* @return int <0 if KO, Id of record if OK
*/
function create($user=0)
@ -181,7 +181,7 @@ class Menubase
/**
* Update menu entry into database.
*
* @param integer $user User that modify
* @param User $user User that modify
* @param int $notrigger 0=no, 1=yes (no update trigger)
* @return int <0 if KO, >0 if OK
*/
@ -247,7 +247,7 @@ class Menubase
* Load object in memory from database
*
* @param int $id Id object
* @param integer $user User that load
* @param User $user User that load
* @return int <0 if KO, >0 if OK
*/
function fetch($id, $user=0)

13
htdocs/core/class/openid.class.php
View File

@ -150,7 +150,7 @@ class SimpleOpenID
/**
* GetIdentity
*
* @return string
* @return void
*/
function GetIdentity()
{ // Get Identity
@ -187,7 +187,7 @@ class SimpleOpenID
/**
* IsError
*
* @return boolean
* @return void
*/
function IsError()
{
@ -225,7 +225,7 @@ class SimpleOpenID
* OpenID_Standarize
*
* @param string $openid_identity Server
* @return string
* @return void
*/
function OpenID_Standarize($openid_identity = null)
{
@ -283,9 +283,6 @@ class SimpleOpenID
}
}
/**
* @param string $url
*/
function CURL_Request($url, $method="GET", $params = "")
{ // Remember, SSL MUST BE SUPPORTED
if (is_array($params)) $params = $this->array2url($params);
@ -359,7 +356,7 @@ class SimpleOpenID
/**
* GetRedirectURL
*
* @return string
* @return void
*/
function GetRedirectURL()
{
@ -403,7 +400,7 @@ class SimpleOpenID
/**
* ValidateWithServer
*
* @return boolean
* @return void
*/
function ValidateWithServer()
{

2
htdocs/core/class/rssparser.class.php
View File

@ -151,7 +151,7 @@ class RssParser
/**
* getLastFetchDate
*
* @return integer
* @return string
*/
public function getLastFetchDate()
{

26
htdocs/core/class/smtps.class.php
View File

@ -362,7 +362,7 @@ class SMTPs
/**
* Attempt mail server authentication for a secure connection
*
* @return boolean|null $_retVal Boolean indicating success or failure of authentication
* @return mixed $_retVal Boolean indicating success or failure of authentication
*/
function _server_authenticate()
{
@ -399,7 +399,7 @@ class SMTPs
*
* @param boolean $_bolTestMsg whether to run this method in 'Test' mode.
* @param boolean $_bolDebug whether to log all communication between this Class and the Mail Server.
* @return boolean|null void
* @return mixed void
* $_strMsg If this is run in 'Test' mode, the actual message structure will be returned
*/
function sendMsg($_bolTestMsg = false, $_bolDebug = false)
@ -499,7 +499,7 @@ class SMTPs
* defined.
*
* @param mixed $_strConfigPath path to config file or VOID
* @return boolean
* @return void
*/
function setConfig ( $_strConfigPath = null )
{
@ -573,7 +573,7 @@ class SMTPs
* Path to the sendmail execuable
*
* @param string $_path Path to the sendmail execuable
* @return boolean
* @return void
*
*/
function setMailPath($_path)
@ -949,8 +949,8 @@ class SMTPs
/**
* Returns an array of addresses for a specific type; TO, CC or BCC
*
* @param string $_which Which collection of adresses to return
* @return string|false Array of emaill address
* @param mixed $_which Which collection of adresses to return
* @return array Array of emaill address
*/
function get_email_list($_which = null)
{
@ -1000,7 +1000,7 @@ class SMTPs
/**
* TO Address[es] inwhich to send mail to
*
* @param string $_addrTo TO Address[es] inwhich to send mail to
* @param mixed $_addrTo TO Address[es] inwhich to send mail to
* @return void
*/
function setTO($_addrTo)
@ -1370,7 +1370,7 @@ class SMTPs
* - [2] Private
* - [3] Company Confidential
*
* @param integer $_value Message Sensitivity
* @param string $_value Message Sensitivity
* @return void
*/
function setSensitivity($_value = 0)
@ -1405,7 +1405,7 @@ class SMTPs
* - [4] 'Low'
* - [5] 'Lowest'
*
* @param integer $_value Message Priority
* @param string $_value Message Priority
* @return void
*/
function setPriority ( $_value = 3 )
@ -1425,7 +1425,7 @@ class SMTPs
* - [4] 'Low'
* - [5] 'Lowest'
*
* @return string
* @return void
*/
function getPriority()
{
@ -1448,7 +1448,7 @@ class SMTPs
/**
* Gets flag which determines whether to calculate message MD5 checksum.
*
* @return boolean Message Priority
* @return string Message Priority
*/
function getMD5flag()
{
@ -1472,7 +1472,7 @@ class SMTPs
/**
* Retrieves the Message X-Header Content
*
* @return string[] $_msgContent Message X-Header Content
* @return string $_msgContent Message X-Header Content
*/
function getXheader()
{
@ -1546,7 +1546,7 @@ class SMTPs
* @param string $_strSend String to send
* @param string $_returnCode Return code
* @param string $CRLF CRLF
* @return boolean|null True or false
* @return boolean True or false
*/
function socket_send_str( $_strSend, $_returnCode = null, $CRLF = "\r\n" )
{

8
htdocs/core/class/translate.class.php
View File

@ -154,7 +154,7 @@ class Translate
* If $domain is "file@module" instead of "file" then we look for module lang file
* in htdocs/custom/modules/mymodule/langs/code_CODE/file.lang
* then in htdocs/module/langs/code_CODE/file.lang instead of htdocs/langs/code_CODE/file.lang
* @param integer $alt 0 (try xx_ZZ then 1), 1 (try xx_XX then 2), 2 (try en_US or fr_FR or es_ES)
* @param string $alt 0 (try xx_ZZ then 1), 1 (try xx_XX then 2), 2 (try en_US or fr_FR or es_ES)
* @param int $stopafterdirection Stop when the DIRECTION tag is found (optimize speed)
* @param int $forcelangdir To force a different lang directory
* @return int <0 if KO, 0 if already loaded or loading not required, >0 if OK
@ -543,7 +543,7 @@ class Translate
* Return list of all available languages
*
* @param string $langdir Directory to scan
* @param integer $maxlength Max length for each value in combo box (will be truncated)
* @param string $maxlength Max length for each value in combo box (will be truncated)
* @param int $usecode Show code instead of country name for language variant
* @return array List of languages
*/
@ -578,7 +578,7 @@ class Translate
* Return if a filename $filename exists for current language (or alternate language)
*
* @param string $filename Language filename to search
* @param integer $searchalt Search also alernate language file
* @param string $searchalt Search also alernate language file
* @return boolean true if exists and readable
*/
function file_exists($filename,$searchalt=0)
@ -714,7 +714,7 @@ class Translate
* Return a currency code into its symbol
*
* @param string $currency_code Currency code
* @param integer $forceloadall 1=Force to load all currencies into cache. We know we need to use all of them. By default read and cache only required currency.
* @param string $forceloadall 1=Force to load all currencies into cache. We know we need to use all of them. By default read and cache only required currency.
* @return string Currency symbol encoded into UTF8
*/
function getCurrencySymbol($currency_code, $forceloadall=0)

2
htdocs/core/class/vcard.class.php
View File

@ -306,7 +306,7 @@ class vCard
/**
* permet d'obtenir une vcard
*
* @return string
* @return void
*/
function getVCard()
{

2
htdocs/core/datepicker.php
View File

@ -119,7 +119,7 @@ print '</body></html>'."\n";
* Convert date to timestamp
*
* @param string $mysqldate Date YYYMMDD
* @return integer Timestamp
* @return timestamp Timestamp
*/
function xyzToUnixTimestamp($mysqldate)
{

8
htdocs/core/db/Database.interface.php
View File

@ -137,8 +137,8 @@ interface Database
/**
* Define sort criteria of request
*
* @param integer $sortfield List of sort fields
* @param integer $sortorder Sort order
* @param string $sortfield List of sort fields
* @param string $sortorder Sort order
* @return string String to provide syntax of a sort sql string
*/
function order($sortfield = 0, $sortorder = 0);
@ -216,7 +216,7 @@ interface Database
* @param string $login login
* @param string $passwd password
* @param string $name name of database (not used for mysql, used for pgsql)
* @param integer $port Port of database server
* @param string $port Port of database server
* @return resource Database access handler
* @see close
*/
@ -421,7 +421,7 @@ interface Database
/**
* Free last resultset used.
*
* @param integer $resultset Curseur de la requete voulue
* @param resource $resultset Curseur de la requete voulue
* @return void
*/
function free($resultset = 0);

6
htdocs/core/db/DoliDB.class.php
View File

@ -223,8 +223,8 @@ abstract class DoliDB implements Database
/**
* Define sort criteria of request
*
* @param integer $sortfield List of sort fields
* @param integer $sortorder Sort order
* @param string $sortfield List of sort fields
* @param string $sortorder Sort order
* @return string String to provide syntax of a sort sql string
*/
function order($sortfield=0,$sortorder=0)
@ -266,7 +266,7 @@ abstract class DoliDB implements Database
*
* @param string $string Date in a string (YYYYMMDDHHMMSS, YYYYMMDD, YYYY-MM-DD HH:MM:SS)
* @param int $gm 1=Input informations are GMT values, otherwise local to server TZ
* @return integer Date TMS
* @return date Date TMS
*/
function jdate($string, $gm=false)
{

16
htdocs/core/db/mssql.class.php
View File

@ -155,7 +155,7 @@ class DoliDBMssql extends DoliDB
* @param string $login login
* @param string $passwd password
* @param string $name name of database (not used for mysql, used for pgsql)
* @param integer $port Port of database server
* @param string $port Port of database server
* @return resource Database access handler
* @see close
*/
@ -399,7 +399,7 @@ class DoliDBMssql extends DoliDB
/**
* Return datas as an array
*
* @param resource $resultset Resultset of request
* @param Resultset $resultset Resultset of request
* @return array Array
*/
function fetch_array($resultset)
@ -413,7 +413,7 @@ class DoliDBMssql extends DoliDB
/**
* Return datas as an array
*
* @param resource $resultset Resultset of request
* @param Resultset $resultset Resultset of request
* @return array Array
*/
function fetch_row($resultset)
@ -441,7 +441,7 @@ class DoliDBMssql extends DoliDB
* Renvoie le nombre de lignes dans le resultat d'une requete INSERT, DELETE ou UPDATE
*
* @param resultset $resultset Curseur de la requete voulue
* @return string Nombre de lignes
* @return int Nombre de lignes
* @see num_rows
*/
function affected_rows($resultset)
@ -459,7 +459,7 @@ class DoliDBMssql extends DoliDB
/**
* Free last resultset used.
*
* @param integer $resultset Curseur de la requete voulue
* @param resultset $resultset Curseur de la requete voulue
* @return void
*/
function free($resultset=0)
@ -588,7 +588,7 @@ class DoliDBMssql extends DoliDB
*
* @param string $fieldorvalue Field name or value to encrypt
* @param int $withQuotes Return string with quotes
* @return string XXX(field) or XXX('value') or field or 'value'
* @return return XXX(field) or XXX('value') or field or 'value'
*/
function encrypt($fieldorvalue, $withQuotes=0)
{
@ -903,7 +903,7 @@ class DoliDBMssql extends DoliDB
/**
* Return list of available charset that can be used to store data in database
*
* @return string List of Charset
* @return array List of Charset
*/
function getListOfCharacterSet()
{
@ -932,7 +932,7 @@ class DoliDBMssql extends DoliDB
/**
* Return list of available collation that can be used for database
*
* @return string Liste of Collation
* @return array Liste of Collation
*/
function getListOfCollation()
{

6
htdocs/core/db/mysql.class.php
View File

@ -182,7 +182,7 @@ class DoliDBMysql extends DoliDB
* @param string $login login
* @param string $passwd password
* @param string $name name of database (not used for mysql, used for pgsql)
* @param integer $port Port of database server
* @param string $port Port of database server
* @return resource Database access handler
* @see close
*/
@ -314,7 +314,7 @@ class DoliDBMysql extends DoliDB
/**
* Return datas as an array
*
* @param resource $resultset Resultset of request
* @param Resultset $resultset Resultset of request
* @return array Array
*/
function fetch_row($resultset)
@ -358,7 +358,7 @@ class DoliDBMysql extends DoliDB
/**
* Free last resultset used.
*
* @param integer $resultset Curseur de la requete voulue
* @param resultset $resultset Curseur de la requete voulue
* @return void
*/
function free($resultset=0)

8
htdocs/core/db/mysqli.class.php
View File

@ -185,7 +185,7 @@ class DoliDBMysqli extends DoliDB
* @param string $login login
* @param string $passwd password
* @param string $name name of database (not used for mysql, used for pgsql)
* @param integer $port Port of database server
* @param string $port Port of database server
* @return resource Database access handler
* @see close
*/
@ -316,7 +316,7 @@ class DoliDBMysqli extends DoliDB
/**
* Return datas as an array
*
* @param resource $resultset Resultset of request
* @param Resultset $resultset Resultset of request
* @return array Array
*/
function fetch_row($resultset)
@ -369,7 +369,7 @@ class DoliDBMysqli extends DoliDB
/**
* Libere le dernier resultset utilise sur cette connexion
*
* @param integer $resultset Curseur de la requete voulue
* @param resultset $resultset Curseur de la requete voulue
* @return void
*/
function free($resultset=0)
@ -716,7 +716,7 @@ class DoliDBMysqli extends DoliDB
*
* @param string $table Name of table
* @param string $field Optionnel : Name of field if we want description of field
* @return resource Resultset x (x->Field, x->Type, ...)
* @return resultset Resultset x (x->Field, x->Type, ...)
*/
function DDLDescTable($table,$field="")
{

22
htdocs/core/db/pgsql.class.php
View File

@ -145,7 +145,7 @@ class DoliDBPgsql extends DoliDB
*
* @param string $line SQL request line to convert
* @param string $type Type of SQL order ('ddl' for insert, update, select, delete or 'dml' for create, alter...)
* @param integer $unescapeslashquot Unescape slash quote with quote quote
* @param string $unescapeslashquot Unescape slash quote with quote quote
* @return string SQL request line converted
*/
static function convertSQLFromMysql($line,$type='auto',$unescapeslashquot=0)
@ -361,7 +361,7 @@ class DoliDBPgsql extends DoliDB
* @param string $login Login
* @param string $passwd Password
* @param string $name Name of database (not used for mysql, used for pgsql)
* @param integer $port Port of database server
* @param string $port Port of database server
* @return resource Database access handler
* @see close
*/
@ -539,7 +539,7 @@ class DoliDBPgsql extends DoliDB
/**
* Return datas as an array
*
* @param resource $resultset Resultset of request
* @param Resultset $resultset Resultset of request
* @return array Array
*/
function fetch_array($resultset)
@ -552,7 +552,7 @@ class DoliDBPgsql extends DoliDB
/**
* Return datas as an array
*
* @param resource $resultset Resultset of request
* @param Resultset $resultset Resultset of request
* @return array Array
*/
function fetch_row($resultset)
@ -596,7 +596,7 @@ class DoliDBPgsql extends DoliDB
/**
* Libere le dernier resultset utilise sur cette connexion
*
* @param integer $resultset Result set of request
* @param Resultset $resultset Result set of request
* @return void
*/
function free($resultset=0)
@ -664,7 +664,7 @@ class DoliDBPgsql extends DoliDB
/**
* Renvoie le code erreur generique de l'operation precedente.
*
* @return string (Exemples: DB_ERROR_TABLE_ALREADY_EXISTS, DB_ERROR_RECORD_ALREADY_EXISTS...)
* @return error_num (Exemples: DB_ERROR_TABLE_ALREADY_EXISTS, DB_ERROR_RECORD_ALREADY_EXISTS...)
*/
function errno()
{
@ -730,7 +730,7 @@ class DoliDBPgsql extends DoliDB
/**
* Renvoie le texte de l'erreur pgsql de l'operation precedente
*
* @return string
* @return error_text
*/
function error()
{
@ -742,7 +742,7 @@ class DoliDBPgsql extends DoliDB
*
* @param string $tab Table name concerned by insert. Ne sert pas sous MySql mais requis pour compatibilite avec Postgresql
* @param string $fieldid Field name
* @return null|string Id of row
* @return int Id of row
*/
function last_insert_id($tab,$fieldid='rowid')
{
@ -764,7 +764,7 @@ class DoliDBPgsql extends DoliDB
*
* @param string $fieldorvalue Field name or value to encrypt
* @param int $withQuotes Return string with quotes
* @return string XXX(field) or XXX('value') or field or 'value'
* @return return XXX(field) or XXX('value') or field or 'value'
*/
function encrypt($fieldorvalue, $withQuotes=0)
{
@ -785,7 +785,7 @@ class DoliDBPgsql extends DoliDB
* Decrypt sensitive data in database
*
* @param int $value Value to decrypt
* @return integer Decrypted value if used
* @return string Decrypted value if used
*/
function decrypt($value)
{
@ -1002,7 +1002,7 @@ class DoliDBPgsql extends DoliDB
*
* @param string $table Name of table
* @param string $field Optionnel : Name of field if we want description of field
* @return resource Resultset x (x->attname)
* @return resultset Resultset x (x->attname)
*/
function DDLDescTable($table,$field="")
{

8
htdocs/core/db/sqlite.class.php
View File

@ -294,7 +294,7 @@ class DoliDBSqlite extends DoliDB
* @param string $login login
* @param string $passwd password
* @param string $name name of database (not used for mysql, used for pgsql)
* @param integer $port Port of database server
* @param string $port Port of database server
* @return resource Database access handler
* @see close
*/
@ -457,7 +457,7 @@ class DoliDBSqlite extends DoliDB
/**
* Return datas as an array
*
* @param resource $resultset Resultset of request
* @param Resultset $resultset Resultset of request
* @return array Array
*/
function fetch_row($resultset)
@ -509,7 +509,7 @@ class DoliDBSqlite extends DoliDB
/**
* Free last resultset used.
*
* @param integer $resultset Curseur de la requete voulue
* @param resultset $resultset Curseur de la requete voulue
* @return void
*/
function free($resultset=0)
@ -627,7 +627,7 @@ class DoliDBSqlite extends DoliDB
*
* @param string $fieldorvalue Field name or value to encrypt
* @param int $withQuotes Return string with quotes
* @return string XXX(field) or XXX('value') or field or 'value'
* @return return XXX(field) or XXX('value') or field or 'value'
*/
function encrypt($fieldorvalue, $withQuotes=0)
{

5
htdocs/core/filemanagerdol/connectors/php/basexml.php
View File

@ -47,9 +47,6 @@ function SetXmlHeaders()
header('Content-Type: text/xml; charset=utf-8');
}
/**
* @param string $currentFolder
*/
function CreateXmlHeader( $command, $resourceType, $currentFolder )
{
SetXmlHeaders();
@ -74,7 +71,7 @@ function CreateXmlFooter()
/**
* SendError
*
* @param integer $number Number
* @param unknown_type $number Number
* @param unknown_type $text Text
* @return void
*/

12
htdocs/core/filemanagerdol/connectors/php/commands.php
View File

@ -22,9 +22,6 @@
* This is the File Manager Connector for PHP.
*/
/**
* @param string $currentFolder
*/
function GetFolders( $resourceType, $currentFolder )
{
// Map the virtual path to the local server path.
@ -56,9 +53,6 @@ function GetFolders( $resourceType, $currentFolder )
echo "</Folders>" ;
}
/**
* @param string $currentFolder
*/
function GetFoldersAndFiles( $resourceType, $currentFolder )
{
// Map the virtual path to the local server path.
@ -117,9 +111,6 @@ function GetFoldersAndFiles( $resourceType, $currentFolder )
echo '</Files>' ;
}
/**
* @param string $currentFolder
*/
function CreateFolder( $resourceType, $currentFolder )
{
if (!isset($_GET)) {
@ -173,9 +164,6 @@ function CreateFolder( $resourceType, $currentFolder )
// DOL_CHANGE
//function FileUpload( $resourceType, $currentFolder, $sCommand )
/**
* @param string $currentFolder
*/
function FileUpload($resourceType, $currentFolder, $sCommand, $CKEcallback = '')
{
if (!isset($_FILES)) {

19
htdocs/core/filemanagerdol/connectors/php/io.php
View File

@ -21,9 +21,6 @@
*
* This is the File Manager Connector for PHP.
*/
/**
* @param string $sBasePath
*/
function CombinePaths( $sBasePath, $sFolder )
{
return RemoveFromEnd($sBasePath, '/') . '/' . RemoveFromStart($sFolder, '/');
@ -48,8 +45,8 @@ function GetResourceTypePath($resourceType, $sCommand)
/**
* GetResourceTypeDirectory
*
* @param string $resourceType Resource type
* @param string $sCommand Command
* @param unknown_type $resourceType Resource type
* @param unknown_type $sCommand Command
* @return string
*/
function GetResourceTypeDirectory($resourceType, $sCommand)
@ -97,7 +94,7 @@ function RemoveExtension($fileName)
* @param string $resourceType Resource type
* @param string $folderPath Folder
* @param string $sCommand Command
* @return string
* @return void
*/
function ServerMapFolder($resourceType, $folderPath, $sCommand)
{
@ -113,9 +110,6 @@ function ServerMapFolder($resourceType, $folderPath, $sCommand)
return CombinePaths($sResourceTypePath, $folderPath);
}
/**
* @param string $folderPath
*/
function GetParentFolder( $folderPath )
{
$sPattern = "-[/\\\\][^/\\\\]+[/\\\\]?$-" ;
@ -230,9 +224,6 @@ function Server_MapPath( $path )
return GetRootPath() . $path ;
}
/**
* @param string $sExtension
*/
function IsAllowedExt($sExtension, $resourceType)
{
global $Config ;
@ -360,10 +351,6 @@ EOF;
// DOL_CHANGE
// This is the function that sends the results of the uploading process to CKE.
/**
* @param string $callback
* @param string $sFileUrl
*/
function SendCKEditorResults ($callback, $sFileUrl, $customMsg = '')
{
echo '<script type="text/javascript">';

4
htdocs/core/filemanagerdol/connectors/php/util.php
View File

@ -130,7 +130,7 @@ function IsHtmlExtension( $ext, $formExtensions )
* Returns true if file contain insecure HTML code at the beginning.
*
* @param string $filePath absolute path to file
* @return string
* @return boolean
*/
function DetectHtml( $filePath )
{
@ -200,7 +200,7 @@ function DetectHtml( $filePath )
*
* @param string $filePath Absolute path to file
* @param string $extension File extension
* @return string True or false
* @return boolean True or false
*/
function IsImageValid( $filePath, $extension )
{

4
htdocs/core/lib/ajax.lib.php
View File

@ -268,7 +268,7 @@ function ajax_multiautocompleter($htmlname,$fields,$url,$option='',$minLength=2,
* @param string $message Message of dialog box
* @param int $w Width of dialog box
* @param int $h height of dialog box
* @return string
* @return void
*/
function ajax_dialog($title,$message,$w=350,$h=150)
{
@ -391,7 +391,7 @@ function ajax_combobox($htmlname, $events=array(), $minLengthToAutocomplete=0)
* @param array $input Array of type->list of CSS element to switch. Example: array('disabled'=>array(0=>'cssid'))
* @param int $entity Entity to set
* @param int $revertonoff Revert on/off
* @return string
* @return void
*/
function ajax_constantonoff($code, $input=array(), $entity=null, $revertonoff=0)
{

2
htdocs/core/lib/bank.lib.php
View File

@ -94,7 +94,7 @@ function bank_prepare_head($object)
* Check account number informations for a bank account
*
* @param Account $account A bank account
* @return boolean True if informations are valid, false otherwise
* @return int True if informations are valid, false otherwise
*/
function checkBanForAccount($account)
{

6
htdocs/core/lib/barcode.lib.php
View File

@ -62,7 +62,7 @@ else $genbarcode_loc = $conf->global->GENBARCODE_LOCATION;
*
* @param string $code Code
* @param string $encoding Encoding
* @param integer $scale Scale
* @param string $scale Scale
* @param string $mode 'png' or 'jpg' ...
*
*
@ -160,7 +160,7 @@ function barcode_encode($code,$encoding)
* Calculate EAN sum
*
* @param string $ean EAN to encode
* @return integer Sum
* @return string Sum
*/
function barcode_gen_ean_sum($ean)
{
@ -300,7 +300,7 @@ function barcode_encode_genbarcode($code,$encoding)
* @param string $mode png,gif,jpg (default='png')
* @param int $total_y the total height of the image ( default: scale * 60 )
* @param array $space default: $space[top] = 2 * $scale; $space[bottom]= 2 * $scale; $space[left] = 2 * $scale; $space[right] = 2 * $scale;
* @return string|null
* @return void
*/
function barcode_outimage($text, $bars, $scale = 1, $mode = "png", $total_y = 0, $space = '')
{

20
htdocs/core/lib/company.lib.php
View File

@ -243,7 +243,7 @@ function societe_admin_prepare_head($object)
* '2'=Return code from id,
* '3'=Return id from code,
* 'all'=Return array('id'=>,'code'=>,'label'=>)
* @param integer $dbtouse Database handler (using in global way may fail because of conflicts with some autoload features)
* @param DoliDB $dbtouse Database handler (using in global way may fail because of conflicts with some autoload features)
* @param Translate $outputlangs Langs object for output translation
* @param int $entconv 0=Return value without entities and not converted to output charset, 1=Ready for html output
* @param int $searchlabel Label of country to search (warning: searching on label is not reliable)
@ -305,7 +305,7 @@ function getCountry($searchkey,$withcode='',$dbtouse=0,$outputlangs='',$entconv=
* '1'=Return string code + label,
* '2'=Return code,
* 'all'=return array('id'=>,'code'=>,'label'=>)
* @param integer $dbtouse Database handler (using in global way may fail because of conflicts with some autoload features)
* @param DoliDB $dbtouse Database handler (using in global way may fail because of conflicts with some autoload features)
* @return string String with state code or state name (Return value is always utf8 encoded and without entities)
*/
function getState($id,$withcode='',$dbtouse=0)
@ -424,7 +424,7 @@ function getFormeJuridiqueLabel($code)
* @param DoliDB $db Database handler
* @param Object $object Third party object
* @param string $backtopage Url to go once contact is created
* @return integer
* @return void
*/
function show_projects($conf,$langs,$db,$object,$backtopage='')
{
@ -526,7 +526,7 @@ function show_projects($conf,$langs,$db,$object,$backtopage='')
* @param DoliDB $db Database handler
* @param Object $object Third party object
* @param string $backtopage Url to go once contact is created
* @return integer
* @return void
*/
function show_contacts($conf,$langs,$db,$object,$backtopage='')
{
@ -790,7 +790,7 @@ function show_contacts($conf,$langs,$db,$object,$backtopage='')
* @param DoliDB $db Database handler
* @param Object $object Third party object
* @param string $backtopage Url to go once address is created
* @return integer|null
* @return void
*/
function show_addresses($conf,$langs,$db,$object,$backtopage='')
{
@ -883,10 +883,10 @@ function show_addresses($conf,$langs,$db,$object,$backtopage='')
* @param Conf $conf Object conf
* @param Translate $langs Object langs
* @param DoliDB $db Object db
* @param Societe $object Object third party or member
* @param Object $object Object third party or member
* @param Contact $objcon Object contact
* @param int $noprint Return string but does not output it
* @return string|null Return html part or void if noprint is 1
* @return mixed Return html part or void if noprint is 1
*/
function show_actions_todo($conf,$langs,$db,$object,$objcon='',$noprint=0)
{
@ -1045,10 +1045,10 @@ function show_actions_todo($conf,$langs,$db,$object,$objcon='',$noprint=0)
* @param Conf $conf Object conf
* @param Translate $langs Object langs
* @param DoliDB $db Object db
* @param Societe $object Object third party or member
* @param Object $object Object third party or member
* @param Contact $objcon Object contact
* @param int $noprint Return string but does not output it
* @return string|null Return html part or void if noprint is 1
* @return mixed Return html part or void if noprint is 1
* TODO change function to be able to list event linked to an object.
*/
function show_actions_done($conf,$langs,$db,$object,$objcon='',$noprint=0)
@ -1318,7 +1318,7 @@ function show_actions_done($conf,$langs,$db,$object,$objcon='',$noprint=0)
* @param Translate $langs Object langs
* @param DoliDB $db Database handler
* @param Societe $object Third party object
* @return integer
* @return void
*/
function show_subsidiaries($conf,$langs,$db,$object)
{

12
htdocs/core/lib/date.lib.php
View File

@ -27,7 +27,7 @@
/**
* Return an array with timezone values
*
* @return string[] Array with timezone values
* @return array Array with timezone values
*/
function get_tz_array()
{
@ -76,7 +76,7 @@ function getServerTimeZoneString()
* Return server timezone int.
*
* @param string $refgmtdate Reference period for timezone (timezone differs on winter and summer. May be 'now', 'winter' or 'summer')
* @return double An offset in hour (+1 for Europe/Paris on winter and +2 for Europe/Paris on summer)
* @return int An offset in hour (+1 for Europe/Paris on winter and +2 for Europe/Paris on summer)
*/
function getServerTimeZoneInt($refgmtdate='now')
{
@ -168,7 +168,7 @@ function convertTime2Seconds($iHours=0,$iMinutes=0,$iSeconds=0)
* @param string $format Output format (all: total delay days hour:min like "2 days 12:30"", allhourmin: total delay hours:min like "60:30", allhour: total delay hours without min/sec like "60:30", fullhour: total delay hour decimal like "60.5" for 60:30, hour: only hours part "12", min: only minutes part "30", sec: only seconds part, month: only month part, year: only year part);
* @param int $lengthOfDay Length of day (default 86400 seconds for 1 day, 28800 for 8 hour)
* @param int $lengthOfWeek Length of week (default 7)
* @return string Formated text of duration
* @return sTime Formated text of duration
* Example: 0 return 00:00, 3600 return 1:00, 86400 return 1d, 90000 return 1 Day 01:00
*/
function convertSecondToTime($iSecond, $format='all', $lengthOfDay=86400, $lengthOfWeek=7)
@ -439,7 +439,7 @@ function dol_get_next_week($day, $week, $month, $year)
*
* @param int $year Year
* @param int $month Month
* @param boolean $gm False or 0 or 'server' = Return date to compare with server TZ, True or 1 to compare with GM date.
* @param mixed $gm False or 0 or 'server' = Return date to compare with server TZ, True or 1 to compare with GM date.
* Exemple: dol_get_first_day(1970,1,false) will return -3600 with TZ+1, after a dol_print_date will return 1970-01-01 00:00:00
* Exemple: dol_get_first_day(1970,1,true) will return 0 whatever is TZ, after a dol_print_date will return 1970-01-01 00:00:00
* @return int Date for first day
@ -482,7 +482,7 @@ function dol_get_last_day($year,$month=12,$gm=false)
* @param int $month Month
* @param int $year Year
* @param int $gm False or 0 or 'server' = Return date to compare with server TZ, True or 1 to compare with GM date.
* @return integer year,month, week,first_day,prev_year,prev_month,prev_day
* @return array year,month, week,first_day,prev_year,prev_month,prev_day
*/
function dol_get_first_day_week($day,$month,$year,$gm=false)
{
@ -798,7 +798,7 @@ function num_open_day($timestampStart, $timestampEnd, $inhour=0, $lastday=0, $ha
* This replace old function monthArrayOrSelected.
*
* @param Translate $outputlangs Object langs
* @return string[] Month string or array if selected < 0
* @return array Month string or array if selected < 0
*/
function monthArray($outputlangs)
{

6
htdocs/core/lib/files.lib.php
View File

@ -450,7 +450,7 @@ function dol_count_nb_of_line($file)
* Return size of a file
*
* @param string $pathoffile Path of file
* @return integer File size
* @return string File size
*/
function dol_filesize($pathoffile)
{
@ -527,7 +527,7 @@ function dol_copy($srcfile, $destfile, $newmask=0, $overwriteifexists=1)
*
* @param string $srcfile Source file (can't be a directory)
* @param string $destfile Destination file (can't be a directory)
* @param integer $newmask Mask for new file (0 by default means $conf->global->MAIN_UMASK)
* @param string $newmask Mask for new file (0 by default means $conf->global->MAIN_UMASK)
* @param int $overwriteifexists Overwrite file if exists (1 by default)
* @return boolean True if OK, false if KO
*/
@ -586,7 +586,7 @@ function dol_unescapefile($filename)
* @param string $dest_file Target full path filename ($_FILES['field']['name'])
* @param int $allowoverwrite 1=Overwrite target file if it already exists
* @param int $disablevirusscan 1=Disable virus scan
* @param integer $uploaderrorcode Value of PHP upload error code ($_FILES['field']['error'])
* @param string $uploaderrorcode Value of PHP upload error code ($_FILES['field']['error'])
* @param int $nohook Disable all hooks
* @param string $varfiles _FILES var name
* @return int >0 if OK, <0 or string if KO

48
htdocs/core/lib/functions.lib.php
View File

@ -45,7 +45,7 @@ if (! function_exists('json_encode'))
*
* @param string $class Class name
* @param string $member Name of property
* @return string|null Return value of static property
* @return mixed Return value of static property
*/
function getStaticMember($class, $member)
{
@ -321,7 +321,7 @@ function dol_buildpath($path, $type=0)
* This function works for both PHP4 and PHP5
*
* @param object $object Object to clone
* @return CommonObject Object clone
* @return object Object clone
* @deprecated Dolibarr no longer supports PHP4, you can now use native function
*/
function dol_clone($object)
@ -355,7 +355,7 @@ function dol_size($size,$type='')
*
* @param string $str String to clean
* @param string $newstr String to replace bad chars with
* @param integer $unaccent 1=Remove also accent (default), 0 do not remove them
* @param string $unaccent 1=Remove also accent (default), 0 do not remove them
* @return string String cleaned (a-zA-Z_)
*
* @see dol_string_nospecial, dol_string_unaccent
@ -440,7 +440,7 @@ function dol_string_nospecial($str,$newstr='_',$badchars='')
* Returns text escaped for inclusion into javascript code
*
* @param string $stringtoescape String to escape
* @param integer $mode 0=Escape also ' and " into ', 1=Escape ' but not " for usage into 'string', 2=Escape " but not ' for usage into "string", 3=Escape ' and " with \
* @param string $mode 0=Escape also ' and " into ', 1=Escape ' but not " for usage into 'string', 2=Escape " but not ' for usage into "string", 3=Escape ' and " with \
* @return string Escaped string. Both ' and " are escaped into ' if they are escaped.
*/
function dol_escape_js($stringtoescape, $mode=0)
@ -516,7 +516,7 @@ function dol_strtoupper($utf8_string)
* On Linux LOG_ERR=3, LOG_WARNING=4, LOG_INFO=6, LOG_DEBUG=7
* @param int $ident 1=Increase ident of 1, -1=Decrease ident of 1
* @param string $suffixinfilename When output is a file, append this suffix into default log filename.
* @return false|null
* @return void
*/
function dol_syslog($message, $level = LOG_INFO, $ident = 0, $suffixinfilename='')
{
@ -608,7 +608,7 @@ function dol_fiche_head($links=array(), $active='0', $title='', $notab=0, $picto
* @param int $notab 0=Add tab header, 1=no tab header. If you set this to 1, using dol_fiche_end() to close tab is not required.
* @param string $picto Add a picto on tab title
* @param int $pictoisfullpath If 1, image path is a full path. If you set this to 1, you can use url returned by dol_buildpath('/mymodyle/img/myimg.png',1) for $picto.
* @return string
* @return void
*/
function dol_get_fiche_head($links=array(), $active='0', $title='', $notab=0, $picto='', $pictoisfullpath=0)
{
@ -690,7 +690,7 @@ function dol_fiche_end($notab=0)
* Return tab footer of a card
*
* @param int $notab 0=Add tab footer, 1=no tab footer
* @return string
* @return void
*/
function dol_get_fiche_end($notab=0)
{
@ -954,7 +954,7 @@ function dol_print_date($time,$format='',$tzoutput='tzserver',$outputlangs='',$e
*
* @param int $timestamp Timestamp
* @param boolean $fast Fast mode
* @return integer Array of informations
* @return array Array of informations
* If no fast mode:
* 'seconds' => $secs,
* 'minutes' => $min,
@ -1953,7 +1953,7 @@ function img_edit_remove($alt = 'default')
* Show logo editer/modifier fiche
*
* @param string $alt Texte sur le alt de l'image
* @param integer $float Si il faut y mettre le style "float: right"
* @param float $float Si il faut y mettre le style "float: right"
* @param string $other Add more attributes on img
* @return string Retourne tag img
*/
@ -1970,7 +1970,7 @@ function img_edit($alt = 'default', $float = 0, $other = '')
* Show logo view card
*
* @param string $alt Texte sur le alt de l'image
* @param integer $float Si il faut y mettre le style "float: right"
* @param float $float Si il faut y mettre le style "float: right"
* @param string $other Add more attributes on img
* @return string Retourne tag img
*/
@ -2018,8 +2018,8 @@ function img_printer($alt = "default", $other='')
/**
* Show help logo with cursor "?"
*
* @param integer $usehelpcursor Use help cursor
* @param integer $usealttitle Text to use as alt title
* @param string $usehelpcursor Use help cursor
* @param string $usealttitle Text to use as alt title
* @return string Retourne tag img
*/
function img_help($usehelpcursor = 1, $usealttitle = 1)
@ -2242,7 +2242,7 @@ function img_phone($alt = 'default', $option = 0)
* Show information for admin users
*
* @param string $text Text info
* @param integer $infoonimgalt Info is shown only on alt of star picto, otherwise it is show on output after the star picto
* @param string $infoonimgalt Info is shown only on alt of star picto, otherwise it is show on output after the star picto
* @param int $nodiv No div
* @return string String with info text
*/
@ -2422,7 +2422,7 @@ function print_liste_field_titre($name, $file="", $field="", $begin="", $morepar
* @param string $moreattrib Add more attributes on th ("" by defaut)
* @param string $sortfield Current field used to sort
* @param string $sortorder Current sort order
* @return string
* @return void
*/
function getTitleFieldOfList($name, $thead=0, $file="", $field="", $begin="", $moreparam="", $moreattrib="", $sortfield="", $sortorder="")
{
@ -2526,7 +2526,7 @@ function print_fiche_titre($title, $mesg='', $picto='title.png', $pictoisfullpat
* @param string $picto Icon to use before title (should be a 32x32 transparent png file)
* @param int $pictoisfullpath 1=Icon name is a full absolute url of image
* @param int $id To force an id on html objects
* @return string
* @return void
*/
function load_fiche_titre($titre, $mesg='', $picto='title.png', $pictoisfullpath=0, $id='')
{
@ -2656,7 +2656,7 @@ function print_barre_liste($titre, $page, $file, $options='', $sortfield='', $so
* @param int $page Number of page
* @param string $file Lien
* @param string $options Autres parametres d'url a propager dans les liens ("" par defaut)
* @param integer $nextpage Do we show a next page button
* @param boolean|int $nextpage Do we show a next page button
* @param string $betweenarrows HTML Content to show between arrows
* @return void
*/
@ -2713,7 +2713,7 @@ function vatrate($rate,$addpercent=false,$info_bits=0,$usestarfornpr=0)
* Function used into PDF and HTML pages
*
* @param float $amount Amount to format
* @param integer $form Type of format, HTML or not (not by default)
* @param string $form Type of format, HTML or not (not by default)
* @param Translate $outlangs Object langs for output
* @param int $trunc 1=Truncate if there is too much decimals (default), 0=Does not truncate
* @param int $rounding Minimum number of decimal to show. If 0, no change, if -1, we use min($conf->global->MAIN_MAX_DECIMALS_UNIT,$conf->global->MAIN_MAX_DECIMALS_TOTAL)
@ -3315,7 +3315,7 @@ function get_product_localtax_for_country($idprod, $local, $thirdparty_seller)
* @param Societe $thirdparty_buyer Objet societe acheteuse
* @param int $idprod Id product
* @param int $idprodfournprice Id product_fournisseur_price (for supplier order/invoice)
* @return integer Taux de tva a appliquer, -1 si ne peut etre determine
* @return float Taux de tva a appliquer, -1 si ne peut etre determine
* @see get_default_npr, get_default_localtax
*/
function get_default_tva($thirdparty_seller, $thirdparty_buyer, $idprod=0, $idprodfournprice=0)
@ -3435,7 +3435,7 @@ function get_default_npr($thirdparty_seller, $thirdparty_buyer, $idprod=0, $idpr
* @param Societe $thirdparty_buyer Thirdparty buyer
* @param int $local Localtax to process (1 or 2)
* @param int $idprod Id product
* @return integer localtax, -1 si ne peut etre determine
* @return float localtax, -1 si ne peut etre determine
* @see get_default_tva, get_default_npr
*/
function get_default_localtax($thirdparty_seller, $thirdparty_buyer, $local, $idprod=0)
@ -3477,7 +3477,7 @@ function get_default_localtax($thirdparty_seller, $thirdparty_buyer, $local, $id
* Return yes or no in current language
*
* @param string $yesno Value to test (1, 'yes', 'true' or 0, 'no', 'false')
* @param integer $case 1=Yes/No, 0=yes/no
* @param string $case 1=Yes/No, 0=yes/no
* @param int $color 0=texte only, 1=Text is formated with a color font style ('ok' or 'error'), 2=Text is formated with 'ok' color.
* @return string HTML string
*/
@ -3610,7 +3610,7 @@ function picto_required()
* Clean a string from all HTML tags and entities
*
* @param string $StringHtml String to clean
* @param integer $removelinefeed Replace also all lines feeds by a space, otherwise only last one are removed
* @param string $removelinefeed Replace also all lines feeds by a space, otherwise only last one are removed
* @param string $pagecodeto Encoding of input/output string
* @return string String cleaned
*
@ -3639,7 +3639,7 @@ function dol_string_nohtmltag($StringHtml,$removelinefeed=1,$pagecodeto='UTF-8')
* Replace CRLF in string with a HTML BR tag
*
* @param string $stringtoencode String to encode
* @param integer $nl2brmode 0=Adding br before \n, 1=Replacing \n by br
* @param string $nl2brmode 0=Adding br before \n, 1=Replacing \n by br
* @param string $forxml false=Use <br>, true=Use <br />
* @return string String encoded
*/
@ -3785,7 +3785,7 @@ function dol_string_is_good_iso($s)
* Return nb of lines of a clear text
*
* @param string $s String to check
* @param integer $maxchar Not yet used
* @param string $maxchar Not yet used
* @return int Number of lines
*/
function dol_nboflines($s,$maxchar=0)
@ -3804,7 +3804,7 @@ function dol_nboflines($s,$maxchar=0)
* @param string $text Text
* @param int $maxlinesize Largeur de ligne en caracteres (ou 0 si pas de limite - defaut)
* @param string $charset Give the charset used to encode the $text variable in memory.
* @return double Number of lines
* @return int Number of lines
*/
function dol_nboflines_bis($text,$maxlinesize=0,$charset='UTF-8')
{

8
htdocs/core/lib/functions2.lib.php
View File

@ -442,7 +442,7 @@ function isValidUrl($url,$http=0,$pass=0,$port=0,$path=0,$query=0,$anchor=0)
* Clean an url string
*
* @param string $url Url
* @param integer $http 1 = keep both http:// and https://, 0: remove http:// but not https://
* @param string $http 1 = keep both http:// and https://, 0: remove http:// but not https://
* @return string Cleaned url
*/
function clean_url($url,$http=1)
@ -1026,7 +1026,7 @@ function hexbin($hexa)
* Retourne le numero de la semaine par rapport a une date
*
* @param string $time Date au format 'timestamp'
* @return string Number of week
* @return int Number of week
*/
function numero_semaine($time)
{
@ -1142,7 +1142,7 @@ function weight_convert($weight,&$from_unit,$to_unit)
*
* @param DoliDB $db Handler database
* @param Conf $conf Object conf
* @param User User Object user
* @param User &$user Object user
* @param array $tab Tableau (cle=>valeur) des parametres a sauvegarder
* @return int <0 if KO, >0 if OK
*
@ -1364,7 +1364,7 @@ function getListOfModels($db,$type,$maxfilenamelength=0)
* This function evaluates a string that should be a valid IPv4
*
* @param string $ip IP Address
* @return integer returns 0 if $ip is not a valid IPv4
* @return It returns 0 if $ip is not a valid IPv4
* It returns 1 if $ip is a valid IPv4 and is a public IP
* It returns 2 if $ip is a valid IPv4 and is a private lan IP
*/

4
htdocs/core/lib/geturl.lib.php
View File

@ -27,8 +27,8 @@
* @param string $url URL to call.
* @param string $postorget 'POST', 'GET', 'HEAD'
* @param string $param Parameters of URL (x=value1&y=value2)
* @param integer $followlocation 1=Follow location, 0=Do not follow
* @param string[] $addheaders Array of string to add into header. Example: ('Accept: application/xrds+xml', ....)
* @param string $followlocation 1=Follow location, 0=Do not follow
* @param array $addheaders Array of string to add into header. Example: ('Accept: application/xrds+xml', ....)
* @return array Returns an associative array containing the response from the server array('content'=>response,'curl_error_no'=>errno,'curl_error_msg'=>errmsg...)
*/
function getURLContent($url,$postorget='GET',$param='',$followlocation=1,$addheaders=array())

2
htdocs/core/lib/json.lib.php
View File

@ -269,7 +269,7 @@ function dol_json_decode($json, $assoc=false)
/**
* Return text according to type
*
* @param string $val Value to decode
* @param mixed $val Value to decode
* @return string Formated value
*/
function _unval($val)

10
htdocs/core/lib/pdf.lib.php
View File

@ -901,7 +901,7 @@ function pdf_writeLinkedObjects(&$pdf,$object,$outputlangs,$posx,$posy,$w,$h,$al
* @param int $hideref Hide reference
* @param int $hidedesc Hide description
* @param int $issupplierline Is it a line for a supplier object ?
* @return string|null
* @return void
*/
function pdf_writelinedesc(&$pdf,$object,$i,$outputlangs,$w,$h,$posx,$posy,$hideref=0,$hidedesc=0,$issupplierline=0)
{
@ -1119,7 +1119,7 @@ function pdf_getlinedesc($object,$i,$outputlangs,$hideref=0,$hidedesc=0,$issuppl
* @param int $i Current line number
* @param Translate $outputlangs Object langs for output
* @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines)
* @return null|string
* @return void
*/
function pdf_getlinenum($object,$i,$outputlangs,$hidedetails=0)
{
@ -1145,7 +1145,7 @@ function pdf_getlinenum($object,$i,$outputlangs,$hidedetails=0)
* @param int $i Current line number
* @param Translate $outputlangs Object langs for output
* @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines)
* @return null|string
* @return void
*/
function pdf_getlineref($object,$i,$outputlangs,$hidedetails=0)
{
@ -1170,7 +1170,7 @@ function pdf_getlineref($object,$i,$outputlangs,$hidedetails=0)
* @param int $i Current line number
* @param Translate $outputlangs Object langs for output
* @param int $hidedetails Hide details (0=no, 1=yes, 2=just special lines)
* @return null|string
* @return void
*/
function pdf_getlineref_supplier($object,$i,$outputlangs,$hidedetails=0)
{
@ -1504,7 +1504,7 @@ function pdf_getlinetotalwithtax($object,$i,$outputlangs,$hidedetails=0)
* @param Object $object Object
* @param string $type Type
* @param Translate $outputlangs Object langs for output
* @return integer
* @return void
*/
function pdf_getTotalQty($object,$type,$outputlangs)
{

4
htdocs/core/lib/product.lib.php
View File

@ -27,7 +27,7 @@
/**
* Prepare array with list of tabs
*
* @param Product $object Object related to tabs
* @param Object $object Object related to tabs
* @param User $user Object user
* @return array Array of tabs to shoc
*/
@ -184,7 +184,7 @@ function product_admin_prepare_head($object=null)
*
* @param Product $product Product object
* @param int $socid Thirdparty id
* @return integer
* @return void
*/
function show_stats_for_company($product,$socid)
{

1
htdocs/core/lib/project.lib.php
View File

@ -587,7 +587,6 @@ function projectLinesb(&$inc, $parent, $lines, &$level, &$projectsrole, &$tasksr
* @param int $parent Id of parent task to start
* @param array &$lines Array of all tasks
* @param string &$taskrole Array of task filtered on a particular user
* @param integer $inc
* @return int 1 if there is
*/
function searchTaskInChild(&$inc, $parent, &$lines, &$taskrole)

2
htdocs/core/lib/treeview.lib.php
View File

@ -31,7 +31,7 @@
* @param array &$fulltree Array of entries in correct order
* @param string $key Key of entry into fulltree to show picto
* @param int $silent Do not output indent and picto, returns only value
* @return integer[] array(0 or 1 if at least one of this level after, 0 or 1 if at least one of higher level after, nbofdirinsub, nbofdocinsub)
* @return array array(0 or 1 if at least one of this level after, 0 or 1 if at least one of higher level after, nbofdirinsub, nbofdocinsub)
*/
function tree_showpad(&$fulltree,$key,$silent=0)
{

3
htdocs/core/lib/ws.lib.php
View File

@ -30,9 +30,6 @@
* @param int &$error Number of errors
* @param string &$errorcode Error string code
* @param string &$errorlabel Error string label
* @param integer $error
* @param string $errorcode
* @param string $errorlabel
* @return User Return user object identified by login/pass/entity into authentication array
*/
function check_authentication($authentication,&$error,&$errorcode,&$errorlabel)

2
htdocs/core/menus/standard/empty.php
View File

@ -61,7 +61,7 @@ class MenuManager
* Show menu
*
* @param string $mode 'top', 'left', 'jmobile'
* @return string
* @return void
*/
function showmenu($mode)
{

2
htdocs/core/modules/action/rapport.pdf.php
View File

@ -258,7 +258,7 @@ class CommActionRapport
* @param PDF &$pdf Object PDF
* @param Translate $outputlangs Object lang for output
* @param int $pagenb Page nb
* @return integer
* @return void
*/
function _pagehead(&$pdf, $outputlangs, $pagenb)
{

4
htdocs/core/modules/barcode/doc/phpbarcode.modules.php
View File

@ -108,7 +108,7 @@ class modPhpbarcode extends ModeleBarCode
* @param string $code Value to encode
* @param string $encoding Mode of encoding
* @param string $readable Code can be read
* @param integer $scale Scale
* @param string $scale Scale
* @return int <0 if KO, >0 if OK
*/
function buildBarCode($code,$encoding,$readable='Y',$scale=1)
@ -148,7 +148,7 @@ class modPhpbarcode extends ModeleBarCode
* @param string $code Value to encode
* @param string $encoding Mode of encoding
* @param string $readable Code can be read
* @param integer $scale Scale
* @param string $scale Scale
* @return int <0 if KO, >0 if OK
*/
function writeBarCode($code,$encoding,$readable='Y',$scale=1)

2
htdocs/core/modules/barcode/mod_barcode_product_standard.php
View File

@ -104,7 +104,7 @@ class mod_barcode_product_standard extends ModeleNumRefBarCode
* Return an example of result returned by getNextValue
*
* @param Translate $langs Object langs
* @param integer $objproduct Object product
* @param Product $objproduct Object product
* @return string Return string example
*/
function getExample($langs,$objproduct=0)

2
htdocs/core/modules/barcode/modules_barcode.class.php
View File

@ -87,7 +87,7 @@ abstract class ModeleNumRefBarCode
/**
* Return next value available
*
* @param integer $objsoc Object thirdparty
* @param Societe $objsoc Object thirdparty
* @param int $type Type
* @return string Value
*/

2
htdocs/core/modules/cheque/pdf/modules_chequereceipts.php
View File

@ -42,7 +42,7 @@ abstract class ModeleChequeReceipts extends CommonDocGenerator
* Return list of active generation modules
*
* @param DoliDB $db Database handler
* @param integer $maxfilenamelength Max length of value to show
* @param string $maxfilenamelength Max length of value to show
* @return array List of templates
*/
static function liste_modeles($db,$maxfilenamelength=0)

2
htdocs/core/modules/cheque/pdf/pdf_blochet.class.php
View File

@ -342,7 +342,7 @@ class BordereauChequeBlochet extends ModeleChequeReceipts
* Show footer of page. Need this->emetteur object
*
* @param PDF &$pdf PDF
* @param string $object Object to show
* @param Object $object Object to show
* @param Translate $outputlangs Object lang for output
* @param int $hidefreetext 1=Hide free text
* @return void

2
htdocs/core/modules/commande/mod_commande_marbre.php
View File

@ -96,7 +96,7 @@ class mod_commande_marbre extends ModeleNumRefCommandes
* Return next free value
*
* @param Societe $objsoc Object thirdparty
* @param string $object Object we need next value for
* @param Object $object Object we need next value for
* @return string Value if KO, <0 if KO
*/
function getNextValue($objsoc,$object)

2
htdocs/core/modules/commande/mod_commande_saphir.php
View File

@ -103,7 +103,7 @@ class mod_commande_saphir extends ModeleNumRefCommandes
* Return next free value
*
* @param Societe $objsoc Object thirdparty
* @param string $object Object we need next value for
* @param Object $object Object we need next value for
* @return string Value if KO, <0 if KO
*/
function getNextValue($objsoc,$object)

4
htdocs/core/modules/commande/modules_commande.php
View File

@ -44,7 +44,7 @@ abstract class ModelePDFCommandes extends CommonDocGenerator
* Return list of active generation modules
*
* @param DoliDB $db Database handler
* @param integer $maxfilenamelength Max length of value to show
* @param string $maxfilenamelength Max length of value to show
* @return array List of templates
*/
static function liste_modeles($db,$maxfilenamelength=0)
@ -152,7 +152,7 @@ abstract class ModeleNumRefCommandes
* Create a document onto disk accordign to template module.
*
* @param DoliDB $db Database handler
* @param Commande $object Object order
* @param Object $object Object order
* @param string $modele Force le modele a utiliser ('' to not force)
* @param Translate $outputlangs objet lang a utiliser pour traduction
* @param int $hidedetails Hide details of lines

6
htdocs/core/modules/contract/doc/pdf_strato.modules.php
View File

@ -424,7 +424,7 @@ class pdf_strato extends ModelePDFContract
* Show top header of page.
*
* @param PDF &$pdf Object PDF
* @param CommonObject $object Object to show
* @param Object $object Object to show
* @param int $showaddress 0=no, 1=yes
* @param Translate $outputlangs Object lang for output
* @return void
@ -603,10 +603,10 @@ class pdf_strato extends ModelePDFContract
* Show footer of page. Need this->emetteur object
*
* @param PDF &$pdf PDF
* @param CommonObject $object Object to show
* @param Object $object Object to show
* @param Translate $outputlangs Object lang for output
* @param int $hidefreetext 1=Hide free text
* @return integer
* @return void
*/
function _pagefoot(&$pdf,$object,$outputlangs,$hidefreetext=0)
{

2
htdocs/core/modules/contract/modules_contract.php
View File

@ -43,7 +43,7 @@ abstract class ModelePDFContract extends CommonDocGenerator
* Return list of active generation modules
*
* @param DoliDB $db Database handler
* @param integer $maxfilenamelength Max length of value to show
* @param string $maxfilenamelength Max length of value to show
* @return array List of templates
*/
static function liste_modeles($db,$maxfilenamelength=0)

2
htdocs/core/modules/dons/modules_don.php
View File

@ -40,7 +40,7 @@ abstract class ModeleDon extends CommonDocGenerator
* Return list of active generation modules
*
* @param DoliDB $db Database handler
* @param integer $maxfilenamelength Max length of value to show
* @param string $maxfilenamelength Max length of value to show
* @return array List of templates
*/
static function liste_modeles($db,$maxfilenamelength=0)

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

@ -42,7 +42,7 @@ class pdf_merou extends ModelePdfExpedition
/**
* Constructor
*
* @param integer $db Database handler
* @param DoliDB $db Database handler
*/
function __construct($db=0)
{

4
htdocs/core/modules/expedition/doc/pdf_rouget.modules.php
View File

@ -41,7 +41,7 @@ class pdf_rouget extends ModelePdfExpedition
/**
* Constructor
*
* @param integer $db Database handler
* @param DoliDB $db Database handler
*/
function __construct($db=0)
{
@ -653,7 +653,7 @@ class pdf_rouget extends ModelePdfExpedition
* @param Object $object Object to show
* @param Translate $outputlangs Object lang for output
* @param int $hidefreetext 1=Hide free text
* @return integer
* @return void
*/
function _pagefoot(&$pdf,$object,$outputlangs,$hidefreetext=0)
{

2
htdocs/core/modules/expedition/modules_expedition.php
View File

@ -42,7 +42,7 @@ abstract class ModelePdfExpedition extends CommonDocGenerator
* Return list of active generation modules
*
* @param DoliDB $db Database handler
* @param integer $maxfilenamelength Max length of value to show
* @param string $maxfilenamelength Max length of value to show
* @return array List of templates
*/
static function liste_modeles($db,$maxfilenamelength=0)

2
htdocs/core/modules/export/export_csv.modules.php
View File

@ -74,7 +74,7 @@ class ExportCsv extends ModeleExports
/**
* getDriverId
*
* @return string
* @return int
*/
function getDriverId()
{

2
htdocs/core/modules/export/export_excel.modules.php
View File

@ -76,7 +76,7 @@ class ExportExcel extends ModeleExports
/**
* getDriverId
*
* @return string
* @return int
*/
function getDriverId()
{

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