AdherentStats Class Reference

Class to manage statistics of members. More...

Inheritance diagram for AdherentStats:

Collaboration diagram for AdherentStats:

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

Additional Inherited Members
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 of members.

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

Constructor & Destructor Documentation

__construct()

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

Constructor.

Parameters

DoliDB	$db	Database handler
int	$socid	Id third party
int	$userid	Id user for filter

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

References $object.

Member Function Documentation

countMembersByTagAndStatus()

AdherentStats::countMembersByTagAndStatus

(

$numberYears = 0

)

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

Parameters

int

$numberYears

Number of years to scan (0 = all)

Returns

array<string,array{label:string,members_draft:int,members_pending:0,members_uptodate:int,members_expired:int,members_excluded:int,members_resiliated:int,all?:float|int,total_adhtag:float|int}> Array with total of draft, pending, uptodate, expired, resiliated for each member tag

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

References dol_get_first_day(), dol_now(), dol_syslog(), getEntity(), Adherent\STATUS_DRAFT, Adherent\STATUS_EXCLUDED, Adherent\STATUS_RESILIATED, and Adherent\STATUS_VALIDATED.

countMembersByTypeAndStatus()

AdherentStats::countMembersByTypeAndStatus

(

$numberYears = 0

)

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

Parameters

int

$numberYears

Number of years to scan (0 = all)

Returns

array<int|string,array{label:string,members_draft:int,members_pending:int,members_uptodate:int,members_expired:int,members_excluded:int,members_resiliated:int,all?:float|int,total_adhtype:float|int}> Array with total of draft, pending, uptodate, expired, resiliated for each member type

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

References dol_get_first_day(), dol_now(), dol_syslog(), getEntity(), Adherent\STATUS_DRAFT, Adherent\STATUS_EXCLUDED, Adherent\STATUS_RESILIATED, and Adherent\STATUS_VALIDATED.

getAllByYear()

AdherentStats::getAllByYear

(

)

Return nb, total and average.

Returns

array<array{year:string,nb:string,nb_diff:float,total?:float,avg?:float,weighted?:float,total_diff?:float,avg_diff?:float,avg_weighted?:float}> Array with nb, total amount, average for each year

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

References Stats\_getAllByYear().

getAmountByMonth()

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

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

Parameters

int	$year	Year
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<int<0,11>,array{0:int<1,12>,1:int|float}> Array of values by month

Reimplemented from Stats.

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

References Stats\_getAmountByMonth().

getAverageByMonth()

AdherentStats::getAverageByMonth

(

$year

)

Return average amount each month.

Parameters

int

$year

Year

Returns

array<int<0,11>,array{0:int<1,12>,1:int|float}> Array of average each month

Reimplemented from Stats.

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

References Stats\_getAverageByMonth().

getNbByMonth()

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

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

Parameters

int	$year	Year
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<int<0,11>,array{0:int<1,12>,1:int}> Array of nb each month

Reimplemented from Stats.

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

References Stats\_getNbByMonth().

getNbByYear()

AdherentStats::getNbByYear

(

)

Return the number of subscriptions by year.

Returns

array<array{0:int,1:int}> Array of nb each year

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

References Stats\_getNbByYear().

---

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

• dolibarr_dev/htdocs/adherents/class/adherentstats.class.php