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', $typentid=0, $categid=0)
	Constructor.
	getNbByMonth ($year, $format=0)
	Return propals number by month for a year.
	getNbByYear ()
	Return propals number per year.
	getAmountByMonth ($year, $format=0)
	Return the propals amount by month for a year.
	getAverageByMonth ($year)
	Return the propals amount average by month for a year.
	getAllByYear ()
	Return nb, total and average.
	getAllByProduct ($year, $limit=10)
	Return nb, amount of predefined product for year.
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.

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 proposals statistics.

Definition at line 38 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 86 of file propalestats.class.php.

References $object, and getEntity().

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

Reimplemented from Stats.

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

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

getAllByYear()

PropaleStats::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 239 of file propalestats.class.php.

References Stats\_getAllByYear().

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<int<0,11>,array{0:int<1,12>,1:int|float}> Array with amount by month

Reimplemented from Stats.

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

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

getAverageByMonth()

PropaleStats::getAverageByMonth

(

$year

)

Return the propals amount average by month for a year.

Parameters

int

$year

year for stats

Returns

array<int<0,11>,array{0:int<1,12>,1:int|float}> Array with number by month

Reimplemented from Stats.

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

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

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<int<0,11>,array{0:int<1,12>,1:int}> Array with number by month

Reimplemented from Stats.

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

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

getNbByYear()

PropaleStats::getNbByYear

(

)

Return propals number per year.

Returns

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

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

References Stats\_getNbByYear().

---

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

• dolibarr_dev/htdocs/comm/propal/class/propalestats.class.php