dolibarr  20.0.0-alpha
Public Member Functions | List of all members
DeplacementStats Class Reference

Class to manage the statistics of travel and expense notes. More...

Inheritance diagram for DeplacementStats:
Inheritance graph
[legend]
Collaboration diagram for DeplacementStats:
Collaboration graph
[legend]

Public Member Functions

 __construct ($db, $socid=0, $userid=0)
 Constructor. More...
 
 getNbByYear ()
 Renvoie le nombre de facture par annee. More...
 
 getNbByMonth ($year, $format=0)
 Renvoie le nombre de facture par mois pour une annee donnee. More...
 
 getAmountByMonth ($year, $format=0)
 Renvoie le montant de facture par mois pour une annee donnee. More...
 
 getAverageByMonth ($year)
 Return average amount. More...
 
 getAllByYear ()
 Return nb, total and average. More...
 
- Public Member Functions inherited from Stats
 getNbByMonthWithPrevYear ($endyear, $startyear, $cachedelay=0, $format=0, $startmonth=1)
 Return nb of elements by month for several years. More...
 
 getAmountByMonthWithPrevYear ($endyear, $startyear, $cachedelay=0, $format=0, $startmonth=1)
 Return amount of elements by month for several years. More...
 
 getAverageByMonthWithPrevYear ($endyear, $startyear)
 Return average of entity by month for several years. More...
 
 getAllByProductEntry ($year, $cachedelay=0, $limit=10)
 Return count, and sum of products. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Stats
 _getNbByYear ($sql)
 Return nb of elements by year. More...
 
 _getAllByYear ($sql)
 Return nb of elements, total amount and avg amount each year. More...
 
 _getNbByMonth ($year, $sql, $format=0)
 Renvoie le nombre de documents par mois pour une annee donnee Return number of documents per month for a given year. More...
 
 _getAmountByMonth ($year, $sql, $format=0)
 Return the amount per month for a given year. More...
 
 _getAverageByMonth ($year, $sql, $format=0)
 Return the amount average par month for a given year. More...
 
 _getAllByProduct ($sql, $limit=10)
 Return number or total of product refs. More...
 
 _getAmountByYear ($sql)
 Returns the summed amounts per year for a given number of past years ending now. More...
 

Detailed Description

Class to manage the statistics of travel and expense notes.

Definition at line 31 of file deplacementstats.class.php.

Constructor & Destructor Documentation

◆ __construct()

DeplacementStats::__construct (   $db,
  $socid = 0,
  $userid = 0 
)

Constructor.

Parameters
DoliDB$dbDatabase handler
int$socidId third party
mixed$useridId user for filter or array of user ids
Returns
void

Definition at line 53 of file deplacementstats.class.php.

Member Function Documentation

◆ getAllByYear()

DeplacementStats::getAllByYear ( )

Return nb, total and average.

Returns
array Array of values

Definition at line 160 of file deplacementstats.class.php.

References $sql, and Stats\_getAllByYear().

◆ getAmountByMonth()

DeplacementStats::getAmountByMonth (   $year,
  $format = 0 
)

Renvoie le montant de facture par mois pour une annee donnee.

Parameters
int$yearYear to scan
int$format0=Label of abscissa is a translated text, 1=Label of abscissa is month number, 2=Label of abscissa is first letter of month
Returns
array Array of values

Reimplemented from Stats.

Definition at line 123 of file deplacementstats.class.php.

◆ getAverageByMonth()

DeplacementStats::getAverageByMonth (   $year)

Return average amount.

Parameters
int$yearYear to scan
Returns
array Array of values

Reimplemented from Stats.

Definition at line 143 of file deplacementstats.class.php.

References $sql, and Stats\_getAverageByMonth().

◆ getNbByMonth()

DeplacementStats::getNbByMonth (   $year,
  $format = 0 
)

Renvoie le nombre de facture par mois pour une annee donnee.

Parameters
int$yearYear to scan
int$format0=Label of abscissa is a translated text, 1=Label of abscissa is month number, 2=Label of abscissa is first letter of month
Returns
array Array of values

Reimplemented from Stats.

Definition at line 101 of file deplacementstats.class.php.

◆ getNbByYear()

DeplacementStats::getNbByYear ( )

Renvoie le nombre de facture par annee.

Returns
array Array of values

Definition at line 83 of file deplacementstats.class.php.

References $sql, and Stats\_getNbByYear().


The documentation for this class was generated from the following file: