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

Class to manage reception statistics. More...

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

Public Member Functions

 __construct ($db, $socid, $mode, $userid=0)
 Constructor. More...
 
 getNbByMonth ($year, $format=0)
 Return reception number by month for a year. More...
 
 getNbByYear ()
 Return receptions number per year. More...
 
 getAmountByMonth ($year, $format=0)
 Return the orders amount by month for a year. More...
 
 getAverageByMonth ($year)
 Return the orders amount average by month for a year. 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 reception statistics.

Definition at line 35 of file receptionstats.class.php.

Constructor & Destructor Documentation

◆ __construct()

ReceptionStats::__construct (   $db,
  $socid,
  $mode,
  $userid = 0 
)

Constructor.

Parameters
DoliDB$dbDatabase handler
int$socidId third party for filter
string$modeOption (not used)
int$useridId user for filter (creation user)

Definition at line 55 of file receptionstats.class.php.

Member Function Documentation

◆ getAllByYear()

ReceptionStats::getAllByYear ( )

Return nb, total and average.

Returns
array Array of values

Definition at line 184 of file receptionstats.class.php.

◆ getAmountByMonth()

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

Return the orders amount by month for a year.

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 with amount by month

Reimplemented from Stats.

Definition at line 138 of file receptionstats.class.php.

◆ getAverageByMonth()

ReceptionStats::getAverageByMonth (   $year)

Return the orders amount average by month for a year.

Parameters
int$yearyear for stats
Returns
array array with number by month

Reimplemented from Stats.

Definition at line 162 of file receptionstats.class.php.

◆ getNbByMonth()

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

Return reception number by month for a year.

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 with number by month

Reimplemented from Stats.

Definition at line 91 of file receptionstats.class.php.

◆ getNbByYear()

ReceptionStats::getNbByYear ( )

Return receptions number per year.

Returns
array Array with number by year

Definition at line 115 of file receptionstats.class.php.


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