Class to manage proposals statistics. More...
Inheritance diagram for PropaleStats:
Collaboration diagram for PropaleStats:
Public Member Functions | |
| __construct ($db, $socid=0, $userid=0, $mode='customer', $typentid=0, $categid=0) | |
| Constructor. More... | |
| getNbByMonth ($year, $format=0) | |
| Return propals number by month for a year. More... | |
| getNbByYear () | |
| Return propals number per year. More... | |
| getAmountByMonth ($year, $format=0) | |
| Return the propals amount by month for a year. More... | |
| getAverageByMonth ($year) | |
| Return the propals amount average by month for a year. More... | |
| getAllByYear () | |
| Return nb, total and average. More... | |
| getAllByProduct ($year, $limit=10) | |
| Return nb, amount of predefined product for 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... | |
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 proposals statistics.
Definition at line 37 of file propalestats.class.php.
Constructor & Destructor Documentation
◆ __construct()
| PropaleStats::__construct | ( | $db, | |
$socid = 0, |
|||
$userid = 0, |
|||
$mode = 'customer', |
|||
$typentid = 0, |
|||
$categid = 0 |
|||
| ) |
Constructor.
- Parameters
-
DoliDB $db Database handler int $socid Id third party for filter. This value must be forced during the new to external user company if user is an external user. int $userid Id user for filter (creation user) string $mode Option ('customer', 'supplier') int $typentid Id typent of thirdpary for filter int $categid Id category of thirdpary for filter
Definition at line 63 of file propalestats.class.php.
Member Function Documentation
◆ getAllByProduct()
| PropaleStats::getAllByProduct | ( | $year, | |
$limit = 10 |
|||
| ) |
Return nb, amount of predefined product for year.
- Parameters
-
int $year Year to scan int $limit Limit
- Returns
- array Array of values
Definition at line 244 of file propalestats.class.php.
◆ getAllByYear()
| PropaleStats::getAllByYear | ( | ) |
Return nb, total and average.
- Returns
- array Array of values
Definition at line 218 of file propalestats.class.php.
◆ getAmountByMonth()
| PropaleStats::getAmountByMonth | ( | $year, | |
$format = 0 |
|||
| ) |
Return the propals 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
Reimplemented from Stats.
Definition at line 170 of file propalestats.class.php.
◆ getAverageByMonth()
| PropaleStats::getAverageByMonth | ( | $year | ) |
Return the propals amount average by month for a year.
- Parameters
-
int $year year for stats
- Returns
- array array with number by month
Reimplemented from Stats.
Definition at line 195 of file propalestats.class.php.
◆ getNbByMonth()
| PropaleStats::getNbByMonth | ( | $year, | |
$format = 0 |
|||
| ) |
Return propals 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 with number by month
Reimplemented from Stats.
Definition at line 121 of file propalestats.class.php.
◆ getNbByYear()
| PropaleStats::getNbByYear | ( | ) |
Return propals number per year.
- Returns
- array Array with number by year
Definition at line 146 of file propalestats.class.php.
The documentation for this class was generated from the following file:
- dolibarr_dev/htdocs/comm/propal/class/propalestats.class.php