dolibarr  9.0.0
Public Member Functions | List of all members
ProjectStats Class Reference

Class to manage statistics on projects. More...

+ Inheritance diagram for ProjectStats:
+ Collaboration diagram for ProjectStats:

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 getAllProjectByStatus ($limit=5)
 Return all leads grouped by opportunity status. More...
 
 getAllByYear ()
 Return count, and sum of products. More...
 
 buildWhere ()
 Build the where part. More...
 
 getNbByMonth ($year, $format=0)
 Return Project number by month for a year. More...
 
 getAmountByMonth ($year, $format=0)
 Return the Project amount by month for a year. More...
 
 getWeightedAmountByMonthWithPrevYear ($endyear, $startyear, $cachedelay=0, $wonlostfilter=1)
 Return amount of elements by month for several years. More...
 
 getWeightedAmountByMonth ($year, $wonlostfilter=1)
 Return the Project weighted opp amount by month for a year. More...
 
 getTransformRateByMonthWithPrevYear ($endyear, $startyear, $cachedelay=0)
 Return amount of elements by month for several years. More...
 
 getTransformRateByMonth ($year, $format=0)
 Return the Project transformation rate by month for a year. More...
 
- Public Member Functions inherited from Stats
 getNbByMonthWithPrevYear ($endyear, $startyear, $cachedelay=0, $format=0)
 Return nb of elements by month for several years. More...
 
 getAmountByMonthWithPrevYear ($endyear, $startyear, $cachedelay=0, $format=0)
 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)
 Return count, and sum of products. More...
 
 _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 proposition par mois pour une annee donnee. More...
 
 _getAmountByMonth ($year, $sql, $format=0)
 Renvoie le nombre d'element par mois pour une annee donnee. More...
 
 _getAverageByMonth ($year, $sql, $format=0)
 Renvoie le montant moyen par mois pour une annee donnee. More...
 
 _getAllByProduct ($sql, $limit=10)
 Return number or total of product refs. More...
 

Detailed Description

Class to manage statistics on projects.

Definition at line 25 of file projectstats.class.php.

Constructor & Destructor Documentation

◆ __construct()

ProjectStats::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 37 of file projectstats.class.php.

Member Function Documentation

◆ buildWhere()

ProjectStats::buildWhere ( )

Build the where part.

Returns
string

Definition at line 152 of file projectstats.class.php.

◆ getAllByYear()

ProjectStats::getAllByYear ( )

Return count, and sum of products.

Returns
array of values

Definition at line 121 of file projectstats.class.php.

◆ getAllProjectByStatus()

ProjectStats::getAllProjectByStatus (   $limit = 5)

Return all leads grouped by opportunity status.

Warning: There is no filter on WON/LOST because we want this for statistics.

Parameters
int$limitLimit results
Returns
array|int Array with value or -1 if error
Exceptions
Exception

Definition at line 56 of file projectstats.class.php.

◆ getAmountByMonth()

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

Return the Project amount by month for a year.

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

Definition at line 225 of file projectstats.class.php.

◆ getNbByMonth()

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

Return Project number by month for a year.

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

Definition at line 196 of file projectstats.class.php.

◆ getTransformRateByMonth()

ProjectStats::getTransformRateByMonth (   $year,
  $format = 0 
)

Return the Project transformation rate by month for a year.

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

Definition at line 459 of file projectstats.class.php.

◆ getTransformRateByMonthWithPrevYear()

ProjectStats::getTransformRateByMonthWithPrevYear (   $endyear,
  $startyear,
  $cachedelay = 0 
)

Return amount of elements by month for several years.

Parameters
int$endyearEnd year
int$startyearStart year
int$cachedelayaccept for cache file (0=No read, no save of cache, -1=No read but save)
Returns
array of values

Definition at line 378 of file projectstats.class.php.

◆ getWeightedAmountByMonth()

ProjectStats::getWeightedAmountByMonth (   $year,
  $wonlostfilter = 1 
)

Return the Project weighted opp amount by month for a year.

Parameters
int$yearYear to scan
int$wonlostfilterAdd a filter on status won/lost
Returns
array Array with amount by month

Definition at line 349 of file projectstats.class.php.

◆ getWeightedAmountByMonthWithPrevYear()

ProjectStats::getWeightedAmountByMonthWithPrevYear (   $endyear,
  $startyear,
  $cachedelay = 0,
  $wonlostfilter = 1 
)

Return amount of elements by month for several years.

Parameters
int$endyearStart year
int$startyearEnd year
int$cachedelayDelay we accept for cache file (0=No read, no save of cache, -1=No read but save)
int$wonlostfilterAdd a filter on status won/lost
Returns
array Array of values

Definition at line 256 of file projectstats.class.php.


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