dolibarr  17.0.4
Public Member Functions | Protected Member Functions | List of all members
TaskStats Class Reference

Class to manage statistics on project tasks. More...

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

Public Member Functions

 __construct ($db)
 Constructor of the class. More...
 
 getAllTaskByStatus ($limit=5)
 Return all tasks grouped by status. More...
 
 getAllByYear ()
 Return count, and sum of products. More...
 
 buildWhere ()
 Build the where part. More...
 
 getNbByMonth ($year, $format=0)
 Return Task number by month for a year. More...
 
 getAmountByMonth ($year, $format=0)
 Return the Task amount by month for a year. 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...
 

Protected Member Functions

 getAverageByMonth ($year)
 Return average of entity by month. More...
 
- 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 statistics on project tasks.

Definition at line 26 of file taskstats.class.php.

Constructor & Destructor Documentation

◆ __construct()

TaskStats::__construct (   $db)

Constructor of the class.

Parameters
DoliDb$dbDatabase handler

Definition at line 38 of file taskstats.class.php.

References db.

Member Function Documentation

◆ buildWhere()

TaskStats::buildWhere ( )

Build the where part.

Returns
string

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

◆ getAllByYear()

TaskStats::getAllByYear ( )

Return count, and sum of products.

Returns
array of values

Definition at line 112 of file taskstats.class.php.

◆ getAllTaskByStatus()

TaskStats::getAllTaskByStatus (   $limit = 5)

Return all tasks grouped by status.

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

Definition at line 54 of file taskstats.class.php.

◆ getAmountByMonth()

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

Return the Task 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 206 of file taskstats.class.php.

◆ getAverageByMonth()

TaskStats::getAverageByMonth (   $year)
protected

Return average of entity by month.

Parameters
int$yearyear number
Returns
int value

Reimplemented from Stats.

Definition at line 217 of file taskstats.class.php.

◆ getNbByMonth()

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

Return Task 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 176 of file taskstats.class.php.


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