Stats Class Reference

Parent class of statistics class. More...

Inheritance diagram for Stats:

Public Member Functions
	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.

Protected Member Functions
	getNbByMonth ($year, $format=0)
	getAmountByMonth ($year, $format=0)
	getAverageByMonth ($year)
	_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)
	Renvoie le montant moyen par mois pour une annee donnee 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

Parent class of statistics class.

Definition at line 30 of file stats.class.php.

Member Function Documentation

_getAllByProduct()

Stats::_getAllByProduct ( $sql, $limit = 10 )

protected

Return number or total of product refs.

Parameters

string	$sql	SQL
int	$limit	Limit

Returns

array

Definition at line 652 of file stats.class.php.

References dol_print_error(), and dol_syslog().

Referenced by CommandeStats\getAllByProduct(), FactureStats\getAllByProduct(), FichinterStats\getAllByProduct(), and PropaleStats\getAllByProduct().

_getAllByYear()

Stats::_getAllByYear ( $sql )

protected

Return nb of elements, total amount and avg amount each year.

Parameters

string

$sql

SQL request

Returns

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

Definition at line 423 of file stats.class.php.

References dol_print_error(), and dol_syslog().

Referenced by AdherentStats\getAllByYear(), CommandeStats\getAllByYear(), DeplacementStats\getAllByYear(), DonationStats\getAllByYear(), ExpeditionStats\getAllByYear(), ExpenseReportStats\getAllByYear(), FactureStats\getAllByYear(), FichinterStats\getAllByYear(), ProjectStats\getAllByYear(), PropaleStats\getAllByYear(), ReceptionStats\getAllByYear(), SalariesStats\getAllByYear(), TaskStats\getAllByYear(), and TicketStats\getAllByYear().

_getAmountByMonth()

Stats::_getAmountByMonth ( $year, $sql, $format = 0 )

protected

Return the amount per month for a given year.

Parameters

int	$year	Year
string	$sql	SQL
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

Definition at line 537 of file stats.class.php.

References dol_print_error(), and dol_syslog().

Referenced by AdherentStats\getAmountByMonth(), CommandeStats\getAmountByMonth(), DeplacementStats\getAmountByMonth(), DonationStats\getAmountByMonth(), ExpeditionStats\getAmountByMonth(), ExpenseReportStats\getAmountByMonth(), FactureStats\getAmountByMonth(), FichinterStats\getAmountByMonth(), ProjectStats\getAmountByMonth(), PropaleStats\getAmountByMonth(), ReceptionStats\getAmountByMonth(), SalariesStats\getAmountByMonth(), TicketStats\getAmountByMonth(), and ProjectStats\getWeightedAmountByMonth().

_getAmountByYear()

Stats::_getAmountByYear ( $sql )

protected

Returns the summed amounts per year for a given number of past years ending now.

Parameters

string

$sql

SQL

Returns

array

Definition at line 691 of file stats.class.php.

Referenced by FactureStats\getAmountByYear().

_getAverageByMonth()

Stats::_getAverageByMonth ( $year, $sql, $format = 0 )

protected

Renvoie le montant moyen par mois pour une annee donnee Return the amount average par month for a given year.

Parameters

int	$year	Year
string	$sql	SQL
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

Definition at line 595 of file stats.class.php.

References dol_print_error(), and dol_syslog().

Referenced by AdherentStats\getAverageByMonth(), CommandeStats\getAverageByMonth(), DeplacementStats\getAverageByMonth(), DonationStats\getAverageByMonth(), ExpeditionStats\getAverageByMonth(), ExpenseReportStats\getAverageByMonth(), FactureStats\getAverageByMonth(), FichinterStats\getAverageByMonth(), ProjectStats\getAverageByMonth(), PropaleStats\getAverageByMonth(), ReceptionStats\getAverageByMonth(), SalariesStats\getAverageByMonth(), TaskStats\getAverageByMonth(), and TicketStats\getAverageByMonth().

_getNbByMonth()

Stats::_getNbByMonth ( $year, $sql, $format = 0 )

protected

Renvoie le nombre de documents par mois pour une annee donnee Return number of documents per month for a given year.

Parameters

int	$year	Year
string	$sql	SQL
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 Array of nb each month

Definition at line 480 of file stats.class.php.

References dol_print_error(), and dol_syslog().

Referenced by AdherentStats\getNbByMonth(), CommandeStats\getNbByMonth(), DeplacementStats\getNbByMonth(), DonationStats\getNbByMonth(), ExpeditionStats\getNbByMonth(), ExpenseReportStats\getNbByMonth(), FactureStats\getNbByMonth(), FichinterStats\getNbByMonth(), ProjectStats\getNbByMonth(), PropaleStats\getNbByMonth(), ReceptionStats\getNbByMonth(), SalariesStats\getNbByMonth(), TaskStats\getNbByMonth(), TicketStats\getNbByMonth(), and ProjectStats\getTransformRateByMonth().

_getNbByYear()

Stats::_getNbByYear ( $sql )

protected

Return nb of elements by year.

Parameters

string

$sql

SQL request

Returns

array

Definition at line 394 of file stats.class.php.

References dol_print_error(), and dol_syslog().

Referenced by AdherentStats\getNbByYear(), CommandeStats\getNbByYear(), DeplacementStats\getNbByYear(), DonationStats\getNbByYear(), ExpeditionStats\getNbByYear(), ExpenseReportStats\getNbByYear(), FactureStats\getNbByYear(), FichinterStats\getNbByYear(), PropaleStats\getNbByYear(), ReceptionStats\getNbByYear(), SalariesStats\getNbByYear(), and TicketStats\getNbByYear().

getAllByProductEntry()

Stats::getAllByProductEntry	(		$year,
			$cachedelay = 0,
			$limit = 10 )

Return count, and sum of products.

Parameters

int	$year	Year
int	$cachedelay	Delay we accept for cache file (0=No read, no save of cache, -1=No read but save)
int	$limit	Limit

Returns

array Array of values

@phpstan-ignore-next-line

Definition at line 326 of file stats.class.php.

References dol_filemtime(), dol_is_dir(), dol_mkdir(), dol_now(), dol_syslog(), and dolChmod().

getAmountByMonth()

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

abstractprotected

Parameters

int	$year	year number
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

int value

Reimplemented in AdherentStats, CommandeStats, DeplacementStats, DonationStats, ExpeditionStats, ExpenseReportStats, FactureStats, FichinterStats, ProjectStats, PropaleStats, ReceptionStats, SalariesStats, TaskStats, and TicketStats.

Referenced by getAmountByMonthWithPrevYear().

getAmountByMonthWithPrevYear()

Stats::getAmountByMonthWithPrevYear	(		$endyear,
			$startyear,
			$cachedelay = 0,
			$format = 0,
			$startmonth = 1 )

Return amount of elements by month for several years.

Criterias used to build request are defined into the constructor of parent class into xxx/class/xxxstats.class.php The caller of class can add more filters into sql request by adding criteris into the $stats->where property just after calling constructor.

Parameters

int	$endyear	Start year
int	$startyear	End year
int	$cachedelay	Delay we accept for cache file (0=No read, no save of cache, -1=No read but save)
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
int	$startmonth	month of the fiscal year start min 1 max 12 ; if 1 = january

Returns

array Array of values

Definition at line 196 of file stats.class.php.

References dol_filemtime(), dol_is_dir(), dol_mkdir(), dol_now(), dol_syslog(), dolChmod(), and getAmountByMonth().

getAverageByMonth()

Stats::getAverageByMonth ( $year )

abstractprotected

Parameters

int

$year

year number

Returns

array array of values

Reimplemented in AdherentStats, CommandeStats, DeplacementStats, DonationStats, ExpeditionStats, ExpenseReportStats, FactureStats, FichinterStats, ProjectStats, PropaleStats, ReceptionStats, SalariesStats, TaskStats, and TicketStats.

Referenced by getAverageByMonthWithPrevYear().

getAverageByMonthWithPrevYear()

Stats::getAverageByMonthWithPrevYear	(		$endyear,
			$startyear )

Return average of entity by month for several years.

Parameters

int	$endyear	Start year
int	$startyear	End year

Returns

array Array of values

Definition at line 290 of file stats.class.php.

References getAverageByMonth().

getNbByMonth()

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

abstractprotected

Parameters

int	$year	number
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

int value

Reimplemented in AdherentStats, CommandeStats, DeplacementStats, DonationStats, ExpeditionStats, ExpenseReportStats, FactureStats, FichinterStats, ProjectStats, PropaleStats, ReceptionStats, SalariesStats, TaskStats, and TicketStats.

Referenced by getNbByMonthWithPrevYear().

getNbByMonthWithPrevYear()

Stats::getNbByMonthWithPrevYear	(		$endyear,
			$startyear,
			$cachedelay = 0,
			$format = 0,
			$startmonth = 1 )

Return nb of elements by month for several years.

Parameters

int	$endyear	Start year
int	$startyear	End year
int	$cachedelay	Delay we accept for cache file (0=No read, no save of cache, -1=No read but save)
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
int	$startmonth	month of the fiscal year start min 1 max 12 ; if 1 = january

Returns

array Array of values

Definition at line 94 of file stats.class.php.

References dol_filemtime(), dol_is_dir(), dol_mkdir(), dol_now(), dol_syslog(), dolChmod(), and getNbByMonth().

---

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

• dolibarr_19.0/htdocs/core/class/stats.class.php