Merge pull request #2434 from Dolibarr/scrutinizer-patch-2

Scrutinizer Auto-Fixes
This commit is contained in:
Laurent Destailleur 2015-03-06 03:18:13 +01:00
commit d4e37431e9
25 changed files with 62 additions and 62 deletions

View File

@ -206,7 +206,7 @@ abstract class CommonDocGenerator
/**
* Define array with couple subtitution key => subtitution value
*
* @param Object $object contact
* @param Contact $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
@ -442,7 +442,7 @@ abstract class CommonDocGenerator
/**
* Define array with couple substitution key => substitution value
*
* @param Object $object Main object to use as data source
* @param Expedition $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

View File

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

View File

@ -480,7 +480,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 string $maxlength Max length for labels (0=no limit)
* @param integer $maxlength Max length for labels (0=no limit)
* @return string HTML string with select
*/
function select_country($selected='',$htmlname='country_id',$htmloption='',$maxlength=0)
@ -658,7 +658,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 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')
* @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')
* @return void
*/
function select_type_of_lines($selected='',$htmlname='type',$showempty=0,$hidetext=0,$forceall=0)
@ -1072,9 +1072,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 string $showfunction Add function into label
* @param integer $showfunction Add function into label
* @param string $moreclass Add more class to class style
* @param string $showsoc Add company into label
* @param integer $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)
@ -1095,10 +1095,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 string $showfunction Add function into label
* @param integer $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 string $showsoc Add company into label
* @param integer $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

View File

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

View File

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

View File

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

View File

@ -157,7 +157,7 @@ class FormOther
*
* @param string $selected Preselected ecotaxes
* @param string $htmlname Name of combo list
* @return void
* @return integer
*/
function select_ecotaxes($selected='',$htmlname='ecotaxe_id')
{
@ -268,7 +268,7 @@ class FormOther
/**
* Return a HTML select list to select a percent
*
* @param string $selected pourcentage pre-selectionne
* @param integer $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 string $selected Preselected value
* @param integer $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
@ -834,7 +834,7 @@ class FormOther
* @param int $offset Offset
* @param int $invert Invert
* @param string $option Option
* @return void
* @return string
*/
function selectyear($selected='',$htmlname='yearid',$useempty=0, $min_year=10, $max_year=5, $offset=0, $invert=0, $option='')
{

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 string $level Level of menu to add
* @param integer $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 string $level Level of menu to add
* @param integer $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', ...)

View File

@ -687,7 +687,7 @@ class MobileDetect
/**
* Retrieve the User-Agent.
*
* @return string|null The user agent if it's set.
* @return string The user agent if it's set.
*/
public function getUserAgent()
{
@ -879,7 +879,7 @@ class MobileDetect
*
* @param string $name Name
* @param array $arguments Arguments
* @return mixed
* @return null|boolean
*
* @throws BadMethodCallException when the method doesn't exist and doesn't start with 'is'
* @method boolean is[...]()
@ -926,7 +926,7 @@ class MobileDetect
*
* @param string $key Key
* @param string $userAgent deprecated
* @return mixed
* @return null|boolean
*/
protected function matchUAAgainstKey($key, $userAgent = null)
{
@ -1009,7 +1009,7 @@ class MobileDetect
* @param string $key key
* @param string $userAgent deprecated
* @param string $httpHeaders deprecated
* @return bool|int|null
* @return null|boolean
*
* @todo: The httpHeaders part is not yet used.
*/

View File

@ -150,7 +150,7 @@ class SimpleOpenID
/**
* GetIdentity
*
* @return void
* @return string
*/
function GetIdentity()
{ // Get Identity
@ -187,7 +187,7 @@ class SimpleOpenID
/**
* IsError
*
* @return void
* @return boolean
*/
function IsError()
{
@ -225,7 +225,7 @@ class SimpleOpenID
* OpenID_Standarize
*
* @param string $openid_identity Server
* @return void
* @return string
*/
function OpenID_Standarize($openid_identity = null)
{
@ -251,7 +251,7 @@ class SimpleOpenID
* array2url
*
* @param array $arr An array
* @return boolean|string false if KO, string of url if OK
* @return false|string false if KO, string of url if OK
*/
function array2url($arr)
{ // converts associated array to URL Query String
@ -303,7 +303,7 @@ class SimpleOpenID
* @param string $url URL
* @param string $method Method
* @param string $params Params
* @return boolean|unknown
* @return string
*/
function CURL_Request($url, $method="GET", $params = "")
{ // Remember, SSL MUST BE SUPPORTED
@ -384,7 +384,7 @@ class SimpleOpenID
/**
* GetRedirectURL
*
* @return void
* @return string
*/
function GetRedirectURL()
{
@ -428,7 +428,7 @@ class SimpleOpenID
/**
* ValidateWithServer
*
* @return void
* @return boolean
*/
function ValidateWithServer()
{

View File

@ -153,7 +153,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 string $alt 0 (try xx_ZZ then 1), 1 (try xx_XX then 2), 2 (try en_US)
* @param integer $alt 0 (try xx_ZZ then 1), 1 (try xx_XX then 2), 2 (try en_US)
* @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
@ -548,7 +548,7 @@ class Translate
* Return list of all available languages
*
* @param string $langdir Directory to scan
* @param string $maxlength Max length for each value in combo box (will be truncated)
* @param integer $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
*/
@ -583,7 +583,7 @@ class Translate
* Return if a filename $filename exists for current language (or alternate language)
*
* @param string $filename Language filename to search
* @param string $searchalt Search also alernate language file
* @param integer $searchalt Search also alernate language file
* @return boolean true if exists and readable
*/
function file_exists($filename,$searchalt=0)
@ -720,7 +720,7 @@ class Translate
* Return a currency code into its symbol
*
* @param string $currency_code Currency code
* @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.
* @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.
* @return string Currency symbol encoded into UTF8
*/
function getCurrencySymbol($currency_code, $forceloadall=0)

View File

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

View File

@ -183,7 +183,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 string $port Port of database server
* @param integer $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 Resultset $resultset Resultset of request
* @param resource $resultset Resultset of request
* @return array Array
*/
function fetch_row($resultset)

View File

@ -186,7 +186,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 string $port Port of database server
* @param integer $port Port of database server
* @return resource Database access handler
* @see close
*/
@ -317,7 +317,7 @@ class DoliDBMysqli extends DoliDB
/**
* Return datas as an array
*
* @param Resultset $resultset Resultset of request
* @param resource $resultset Resultset of request
* @return array Array
*/
function fetch_row($resultset)
@ -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 resultset Resultset x (x->Field, x->Type, ...)
* @return resource Resultset x (x->Field, x->Type, ...)
*/
function DDLDescTable($table,$field="")
{

View File

@ -368,7 +368,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 string $port Port of database server
* @param integer $port Port of database server
* @return resource Database access handler
* @see close
*/
@ -546,7 +546,7 @@ class DoliDBPgsql extends DoliDB
/**
* Return datas as an array
*
* @param Resultset $resultset Resultset of request
* @param resource $resultset Resultset of request
* @return array Array
*/
function fetch_array($resultset)
@ -559,7 +559,7 @@ class DoliDBPgsql extends DoliDB
/**
* Return datas as an array
*
* @param Resultset $resultset Resultset of request
* @param resource $resultset Resultset of request
* @return array Array
*/
function fetch_row($resultset)
@ -771,7 +771,7 @@ class DoliDBPgsql extends DoliDB
*
* @param string $fieldorvalue Field name or value to encrypt
* @param int $withQuotes Return string with quotes
* @return return XXX(field) or XXX('value') or field or 'value'
* @return string XXX(field) or XXX('value') or field or 'value'
*/
function encrypt($fieldorvalue, $withQuotes=0)
{
@ -1010,7 +1010,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 resultset Resultset x (x->attname)
* @return resource Resultset x (x->attname)
*/
function DDLDescTable($table,$field="")
{

View File

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

View File

@ -43,7 +43,7 @@ abstract class ModelePDFAskPriceSupplier extends CommonDocGenerator
* Return list of active generation modules
*
* @param DoliDB $db Database handler
* @param string $maxfilenamelength Max length of value to show
* @param integer $maxfilenamelength Max length of value to show
* @return array List of templates
*/
static function liste_modeles($db,$maxfilenamelength=0)
@ -149,7 +149,7 @@ abstract class ModeleNumRefAskPriceSupplier
* Create a document onto disk according to template module.
*
* @param DoliDB $db Database handler
* @param object $object Object askpricesupplier
* @param AskPriceSupplier $object Object askpricesupplier
* @param string $modele Force model to use ('' to not force)
* @param Translate $outputlangs Object langs to use for output
* @param int $hidedetails Hide details of lines

View File

@ -45,7 +45,7 @@ abstract class ModelePDFCommandes extends CommonDocGenerator
* Return list of active generation modules
*
* @param DoliDB $db Database handler
* @param string $maxfilenamelength Max length of value to show
* @param integer $maxfilenamelength Max length of value to show
* @return array List of templates
*/
static function liste_modeles($db,$maxfilenamelength=0)
@ -153,7 +153,7 @@ abstract class ModeleNumRefCommandes
* Create a document onto disk accordign to template module.
*
* @param DoliDB $db Database handler
* @param Object $object Object order
* @param Commande $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

View File

@ -44,7 +44,7 @@ abstract class ModelePDFContract extends CommonDocGenerator
* Return list of active generation modules
*
* @param DoliDB $db Database handler
* @param string $maxfilenamelength Max length of value to show
* @param integer $maxfilenamelength Max length of value to show
* @return array List of templates
*/
static function liste_modeles($db,$maxfilenamelength=0)
@ -148,7 +148,7 @@ class ModelNumRefContracts
* Create a contract document on disk using template defined into CONTRACT_ADDON_PDF
*
* @param DoliDB $db objet base de donnee
* @param Object $object Object contract
* @param Contrat $object Object contract
* @param string $modele force le modele a utiliser ('' par defaut)
* @param Translate $outputlangs objet lang a utiliser pour traduction
* @param int $hidedetails Hide details of lines

View File

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

View File

@ -43,7 +43,7 @@ abstract class ModelePdfExpedition extends CommonDocGenerator
* Return list of active generation modules
*
* @param DoliDB $db Database handler
* @param string $maxfilenamelength Max length of value to show
* @param integer $maxfilenamelength Max length of value to show
* @return array List of templates
*/
static function liste_modeles($db,$maxfilenamelength=0)
@ -146,7 +146,7 @@ abstract class ModelNumRefExpedition
* Cree un bon d'expedition sur disque
*
* @param DoliDB $db Objet base de donnee
* @param Object $object Object expedition
* @param Expedition $object Object expedition
* @param string $modele Force le modele a utiliser ('' to not force)
* @param Translate $outputlangs Objet lang a utiliser pour traduction
* @return int <=0 if KO, >0 if OK

View File

@ -30,7 +30,7 @@ class ModeleExpenseReport extends CommonDocGenerator
* Return list of active generation modules
*
* @param DoliDB $db Database handler
* @param string $maxfilenamelength Max length of value to show
* @param integer $maxfilenamelength Max length of value to show
* @return array List of templates
*/
static function liste_modeles($db,$maxfilenamelength=0)
@ -52,7 +52,7 @@ class ModeleExpenseReport extends CommonDocGenerator
* expensereport_pdf_create
*
* @param DoliDB $db Database handler
* @param Object $object Object order
* @param ExpenseReport $object Object order
* @param string $message Message
* @param string $modele Force le modele a utiliser ('' to not force)
* @param Translate $outputlangs objet lang a utiliser pour traduction

View File

@ -43,7 +43,7 @@ class ModeleExports extends CommonDocGenerator // This class can't be abstrac
* Load into memory list of available export format
*
* @param DoliDB $db Database handler
* @param string $maxfilenamelength Max length of value to show
* @param integer $maxfilenamelength Max length of value to show
* @return array List of templates (same content than array this->driverlabel)
*/
function liste_modeles($db,$maxfilenamelength=0)

View File

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

View File

@ -147,7 +147,7 @@ class ExpeditionLineBatch extends CommonObject
/**
* Delete batch record attach to a shipment
*
* @param object $db Database object
* @param DoliDB $db Database object
* @param int $id_expedition rowid of shipment
* @return int -1 if KO, 1 if OK
*/
@ -172,7 +172,7 @@ class ExpeditionLineBatch extends CommonObject
/**
* Retrieve all batch number details link to a shipment line
*
* @param object $db Database object
* @param DoliDB $db Database object
* @param int $id_line_expdet id of shipment line
* @return variant -1 if KO, array of ExpeditionLineBatch if OK
*/