dolibarr  19.0.0-dev
Public Member Functions | List of all members
AdherentStats Class Reference

Class to manage statistics of members. More...

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

Public Member Functions

 __construct ($db, $socid=0, $userid=0)
 Constructor. More...
 
 getNbByMonth ($year, $format=0)
 Return the number of proposition by month for a given year. More...
 
 getNbByYear ()
 Return the number of subscriptions by year. More...
 
 getAmountByMonth ($year, $format=0)
 Return the number of subscriptions by month for a given year. More...
 
 getAverageByMonth ($year)
 Return average amount each month. More...
 
 getAllByYear ()
 Return nb, total and average. More...
 
 countMembersByTypeAndStatus ($numberYears=0)
 Return count of member by status group by adh type, total and average. More...
 
 countMembersByTagAndStatus ($numberYears=0)
 Return count of member by status group by adh type, total and average. 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 statistics of members.

Definition at line 34 of file adherentstats.class.php.

Constructor & Destructor Documentation

◆ __construct()

AdherentStats::__construct (   $db,
  $socid = 0,
  $userid = 0 
)

Constructor.

Parameters
DoliDB$dbDatabase handler
int$socidId third party
int$useridId user for filter

Definition at line 57 of file adherentstats.class.php.

Member Function Documentation

◆ countMembersByTagAndStatus()

AdherentStats::countMembersByTagAndStatus (   $numberYears = 0)

Return count of member by status group by adh type, total and average.

Parameters
int$numberYearsNumber of years to scan (0 = all)
Returns
array Array with total of draft, pending, uptodate, expired, resiliated for each member tag

Definition at line 256 of file adherentstats.class.php.

◆ countMembersByTypeAndStatus()

AdherentStats::countMembersByTypeAndStatus (   $numberYears = 0)

Return count of member by status group by adh type, total and average.

Parameters
int$numberYearsNumber of years to scan (0 = all)
Returns
array Array with total of draft, pending, uptodate, expired, resiliated for each member type

Definition at line 180 of file adherentstats.class.php.

◆ getAllByYear()

AdherentStats::getAllByYear ( )

Return nb, total and average.

Returns
array Array with nb, total amount, average for each year

Definition at line 162 of file adherentstats.class.php.

References $sql, and Stats\_getAllByYear().

◆ getAmountByMonth()

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

Return the number of subscriptions by month for a given year.

Parameters
int$yearYear
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 amount each month

Reimplemented from Stats.

Definition at line 124 of file adherentstats.class.php.

◆ getAverageByMonth()

AdherentStats::getAverageByMonth (   $year)

Return average amount each month.

Parameters
int$yearYear
Returns
array Array of average each month

Reimplemented from Stats.

Definition at line 143 of file adherentstats.class.php.

◆ getNbByMonth()

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

Return the number of proposition by month for a given year.

Parameters
int$yearYear
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 nb each month

Reimplemented from Stats.

Definition at line 87 of file adherentstats.class.php.

◆ getNbByYear()

AdherentStats::getNbByYear ( )

Return the number of subscriptions by year.

Returns
array Array of nb each year

Definition at line 105 of file adherentstats.class.php.

References $sql, and Stats\_getNbByYear().


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