dolibarr  16.0.5
Public Member Functions | List of all members
FactureStats Class Reference

Class to manage stats for invoices (customer and supplier) More...

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

Public Member Functions

 __construct (DoliDB $db, $socid, $mode, $userid=0, $typentid=0, $categid=0)
 Constructor. More...
 
 getNbByMonth ($year, $format=0)
 Return orders number by month for a year. More...
 
 getNbByYear ()
 Return invoices number per year. More...
 
 getAmountByMonth ($year, $format=0)
 Return the invoices amount by month for a year. More...
 
 getAverageByMonth ($year)
 Return average amount. More...
 
 getAllByYear ()
 Return nb, total and average. More...
 
 getAllByProduct ($year, $limit=10)
 Return nb, amount of predefined product for year. More...
 
 getAmountByYear ($numberYears, $format=0)
 Return the invoices amount by year for a number of past years. 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)
 Renvoie le montant moyen par mois pour une annee donnee 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 stats for invoices (customer and supplier)

Definition at line 34 of file facturestats.class.php.

Constructor & Destructor Documentation

◆ __construct()

FactureStats::__construct ( DoliDB  $db,
  $socid,
  $mode,
  $userid = 0,
  $typentid = 0,
  $categid = 0 
)

Constructor.

Parameters
DoliDB$dbDatabase handler
int$socidId third party for filter. This value must be forced during the new to external user company if user is an external user.
string$modeOption ('customer', 'supplier')
int$useridId user for filter (creation user)
int$typentidId typent of thirdpary for filter
int$categidId category of thirdpary for filter

Definition at line 60 of file facturestats.class.php.

Member Function Documentation

◆ getAllByProduct()

FactureStats::getAllByProduct (   $year,
  $limit = 10 
)

Return nb, amount of predefined product for year.

Parameters
int$yearYear to scan
int$limitLimit
Returns
array Array of values

Definition at line 259 of file facturestats.class.php.

◆ getAllByYear()

FactureStats::getAllByYear ( )

Return nb, total and average.

Returns
array Array of values

Definition at line 235 of file facturestats.class.php.

◆ getAmountByMonth()

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

Return the invoices 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 186 of file facturestats.class.php.

◆ getAmountByYear()

FactureStats::getAmountByYear (   $numberYears,
  $format = 0 
)

Return the invoices amount by year for a number of past years.

Parameters
int$numberYearsYears to scan
int$format0=Label of abscissa is a translated text, 1=Label of abscissa is year, 2=Label of abscissa is last number of year
Returns
array Array with amount by year

Definition at line 285 of file facturestats.class.php.

◆ getAverageByMonth()

FactureStats::getAverageByMonth (   $year)

Return average amount.

Parameters
int$yearYear to scan
Returns
array Array of values

Reimplemented from Stats.

Definition at line 212 of file facturestats.class.php.

◆ getNbByMonth()

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

Return orders 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 of values

Reimplemented from Stats.

Definition at line 135 of file facturestats.class.php.

◆ getNbByYear()

FactureStats::getNbByYear ( )

Return invoices number per year.

Returns
array Array with number by year

Definition at line 161 of file facturestats.class.php.


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