dolibarr 20.0.0
TaskStats Class Reference

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

Inheritance diagram for TaskStats:
Collaboration diagram for TaskStats:

Public Member Functions

 __construct ($db)
 Constructor of the class.
 
 getAllTaskByStatus ($limit=5)
 Return all tasks grouped by status.
 
 getAllByYear ()
 Return count, and sum of products.
 
 buildWhere ()
 Build the where part.
 
 getNbByMonth ($year, $format=0)
 Return Task number by month for a year.
 
 getAmountByMonth ($year, $format=0)
 Return the Task amount by month for a year.
 
- Public Member Functions inherited from Stats
 getNbByMonthWithPrevYear ($endyear, $startyear, $cachedelay=0, $format=0, $startmonth=1)
 Return nb of elements by month for several years.
 
 getAmountByMonthWithPrevYear ($endyear, $startyear, $cachedelay=0, $format=0, $startmonth=1)
 Return amount of elements by month for several years.
 
 getAverageByMonthWithPrevYear ($endyear, $startyear)
 Return average of entity by month for several years.
 
 getAllByProductEntry ($year, $cachedelay=0, $limit=10)
 Return count, and sum of products.
 

Protected Member Functions

 getAverageByMonth ($year)
 Return average of entity by month.
 
- Protected Member Functions inherited from Stats
 _getNbByYear ($sql)
 Return nb of elements by year.
 
 _getAllByYear ($sql)
 Return nb of elements, total amount and avg amount each year.
 
 _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.
 
 _getAmountByMonth ($year, $sql, $format=0)
 Return the amount per month for a given year.
 
 _getAverageByMonth ($year, $sql, $format=0)
 Return the amount average par month for a given year.
 
 _getAllByProduct ($sql, $limit=10)
 Return number or total of product refs.
 
 _getAmountByYear ($sql)
 Returns the summed amounts per year for a given number of past years ending now.
 

Detailed Description

Class to manage statistics on project tasks.

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

Constructor & Destructor Documentation

◆ __construct()

TaskStats::__construct ( $db)

Constructor of the class.

Parameters
DoliDB$dbDatabase handler

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

Member Function Documentation

◆ buildWhere()

TaskStats::buildWhere ( )

Build the where part.

Returns
string

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

References dol_get_first_day(), and dol_get_last_day().

Referenced by getAllByYear(), getAllTaskByStatus(), and getNbByMonth().

◆ getAllByYear()

TaskStats::getAllByYear ( )

Return count, and sum of products.

Returns
array of values

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

References Stats\_getAllByYear(), and buildWhere().

◆ 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.

References buildWhere(), and dol_syslog().

◆ 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 197 of file taskstats.class.php.

◆ getAverageByMonth()

TaskStats::getAverageByMonth ( $year)
protected

Return average of entity by month.

Parameters
int$yearyear number
Returns
array array of values

Reimplemented from Stats.

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

References Stats\_getAverageByMonth(), dol_get_first_day(), and dol_get_last_day().

◆ 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 169 of file taskstats.class.php.

References Stats\_getNbByMonth(), and buildWhere().


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