dolibarr  7.0.0-beta
Public Member Functions | List of all members
PropaleStats Class Reference

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')
 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)
 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)
 Return nb, amount of predefined product for 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 proposals statistics.

Definition at line 36 of file propalestats.class.php.

Constructor & Destructor Documentation

PropaleStats::__construct (   $db,
  $socid = 0,
  $userid = 0,
  $mode = 'customer' 
)

Constructor.

Parameters
DoliDB$dbDatabase handler
int$socidId third party for filter. This value must be forced during the new to external user company if user is an external user.
int$useridId user for filter (creation user)
string$modeOption ('customer', 'supplier')

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

Member Function Documentation

PropaleStats::getAllByProduct (   $year)

Return nb, amount of predefined product for year.

Parameters
int$yearYear to scan
Returns
array Array of values

Definition at line 213 of file propalestats.class.php.

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

PropaleStats::getAllByYear ( )

Return nb, total and average.

Returns
array Array of values

Definition at line 191 of file propalestats.class.php.

References Stats\_getAllByYear().

PropaleStats::getAmountByMonth (   $year,
  $format 
)

Return the propals 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 149 of file propalestats.class.php.

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

PropaleStats::getAverageByMonth (   $year)

Return the propals amount average by month for a year.

Parameters
int$yearyear for stats
Returns
array array with number by month

Definition at line 171 of file propalestats.class.php.

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

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

Return propals 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 with number by month

Definition at line 106 of file propalestats.class.php.

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

PropaleStats::getNbByYear ( )

Return propals number per year.

Returns
array Array with number by year

Definition at line 128 of file propalestats.class.php.

References Stats\_getNbByYear().


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