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, $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 | |
| getNbByMonth ($year, $format=0) | |
| getAmountByMonth ($year, $format=0) | |
| getAverageByMonth ($year) | |
| _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 projects.
Definition at line 25 of file projectstats.class.php.
Constructor & Destructor Documentation
| ProjectStats::__construct | ( | $db | ) |
Member Function Documentation
| ProjectStats::buildWhere | ( | ) |
Build the where part.
- Returns
- string
Definition at line 155 of file projectstats.class.php.
References db, dol_get_first_day(), and dol_get_last_day().
Referenced by getAllByYear(), getAllProjectByStatus(), getAmountByMonth(), getNbByMonth(), getTransformRateByMonth(), and getWeightedAmountByMonth().
| ProjectStats::getAllByYear | ( | ) |
Return count, and sum of products.
- Returns
- array of values
Definition at line 124 of file projectstats.class.php.
References Stats\_getAllByYear(), buildWhere(), and db.
| 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 $limit Limit results
- Returns
- array|int Array with value or -1 if error
- Exceptions
-
Exception
Definition at line 60 of file projectstats.class.php.
References $resql, buildWhere(), db, dol_syslog(), price(), and price2num().
| ProjectStats::getAmountByMonth | ( | $year, | |
$format = 0 |
|||
| ) |
Return the Project amount by month for a year.
- Parameters
-
int $year Year to scan int $format 0=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
Definition at line 255 of file projectstats.class.php.
References Stats\_getAmountByMonth(), buildWhere(), and db.
|
protected |
Return average of entity by month.
- Parameters
-
int $year year number
- Returns
- int value
Definition at line 537 of file projectstats.class.php.
References Stats\_getAverageByMonth(), db, dol_get_first_day(), and dol_get_last_day().
| ProjectStats::getNbByMonth | ( | $year, | |
$format = 0 |
|||
| ) |
Return Project number by month for a year.
- Parameters
-
int $year Year to scan int $format 0=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
Definition at line 226 of file projectstats.class.php.
References Stats\_getNbByMonth(), buildWhere(), and db.
| ProjectStats::getTransformRateByMonth | ( | $year, | |
$format = 0 |
|||
| ) |
Return the Project transformation rate by month for a year.
- Parameters
-
int $year Year to scan int $format 0=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
Definition at line 485 of file projectstats.class.php.
References Stats\_getNbByMonth(), buildWhere(), and db.
Referenced by getTransformRateByMonthWithPrevYear().
| ProjectStats::getTransformRateByMonthWithPrevYear | ( | $endyear, | |
| $startyear, | |||
$cachedelay = 0 |
|||
| ) |
Return amount of elements by month for several years.
- Parameters
-
int $endyear End year int $startyear Start year int $cachedelay accept for cache file (0=No read, no save of cache, -1=No read but save)
- Returns
- array of values
Definition at line 402 of file projectstats.class.php.
References dol_filemtime(), dol_is_dir(), dol_mkdir(), dol_now(), dol_syslog(), and getTransformRateByMonth().
| ProjectStats::getWeightedAmountByMonth | ( | $year, | |
$wonlostfilter = 1 |
|||
| ) |
Return the Project weighted opp amount by month for a year.
- Parameters
-
int $year Year to scan int $wonlostfilter Add a filter on status won/lost
- Returns
- array Array with amount by month
Definition at line 373 of file projectstats.class.php.
References Stats\_getAmountByMonth(), buildWhere(), and db.
Referenced by getWeightedAmountByMonthWithPrevYear().
| ProjectStats::getWeightedAmountByMonthWithPrevYear | ( | $endyear, | |
| $startyear, | |||
$cachedelay = 0, |
|||
$wonlostfilter = 1 |
|||
| ) |
Return amount of elements by month for several years.
- Parameters
-
int $endyear Start year int $startyear End year int $cachedelay Delay we accept for cache file (0=No read, no save of cache, -1=No read but save) int $wonlostfilter Add a filter on status won/lost
- Returns
- array Array of values
Definition at line 286 of file projectstats.class.php.
References dol_filemtime(), dol_is_dir(), dol_mkdir(), dol_now(), dol_syslog(), and getWeightedAmountByMonth().
The documentation for this class was generated from the following file:
- htdocs/projet/class/projectstats.class.php