FactureStats Class Reference

Class to manage stats for invoices (customer and supplier) More...

Inheritance diagram for FactureStats:

Collaboration diagram for FactureStats:

Public Member Functions
	__construct (DoliDB $db, $socid, $mode, $userid=0, $typentid=0, $categid=0)
	Constructor.
	getNbByMonth ($year, $format=0)
	Return orders number by month for a year.
	getNbByYear ()
	Return invoices number per year.
	getAmountByMonth ($year, $format=0)
	Return the invoices amount by month for a year.
	getAverageByMonth ($year)
	Return average amount.
	getAllByYear ()
	Return nb, total and average.
	getAllByProduct ($year, $limit=10)
	Return nb, amount of predefined product for year.
	getAmountByYear ($numberYears, $format=0)
	Return the invoices amount by year for a number of past years.
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 stats for invoices (customer and supplier)

Definition at line 35 of file facturestats.class.php.

Constructor & Destructor Documentation

__construct()

FactureStats::__construct	(	DoliDB	$db,
			$socid,
			$mode,
			$userid = 0,
			$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.
string	$mode	Option ('customer', 'supplier')
int	$userid	Id user for filter (creation user)
int	$typentid	Id typent of thirdpary for filter
int	$categid	Id category of thirdpary for filter

Definition at line 79 of file facturestats.class.php.

References $object, and getDolGlobalString().

Member Function Documentation

getAllByProduct()

FactureStats::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 275 of file facturestats.class.php.

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

getAllByYear()

FactureStats::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 of values

Definition at line 251 of file facturestats.class.php.

References Stats\_getAllByYear().

getAmountByMonth()

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

Return the invoices 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 202 of file facturestats.class.php.

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

getAmountByYear()

FactureStats::getAmountByYear	(		$numberYears,
			$format = 0 )

Return the invoices amount by year for a number of past years.

Parameters

int<0,max>	$numberYears Years to scan
int<0,2>	$format 0=Label of abscissa is a translated text, 1=Label of abscissa is year, 2=Label of abscissa is last number of year

Returns

array<int,array{0:int,1:int}> Array with amount by year

Definition at line 301 of file facturestats.class.php.

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

getAverageByMonth()

FactureStats::getAverageByMonth

(

$year

)

Return average amount.

Parameters

int

$year

Year to scan

Returns

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

Reimplemented from Stats.

Definition at line 228 of file facturestats.class.php.

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

getNbByMonth()

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

Return orders number by month for a year.

Parameters

int	$year	Year to scan
	int<0,2>	$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 values

Reimplemented from Stats.

Definition at line 151 of file facturestats.class.php.

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

getNbByYear()

FactureStats::getNbByYear

(

)

Return invoices number per year.

Returns

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

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

References Stats\_getNbByYear().

---

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

• dolibarr_dev/htdocs/compta/facture/class/facturestats.class.php