dolibarr 21.0.0-alpha
SalariesStats Class Reference

Class to manage salary statistics. More...

Inheritance diagram for SalariesStats:
Collaboration diagram for SalariesStats:

Public Member Functions

 __construct ($db, $socid=0, $userid=0)
 Constructor.
 
 getNbByYear ()
 Return the number of salary by year.
 
 getNbByMonth ($year, $format=0)
 Return the number of salary by month, for a given year.
 
 getAmountByMonth ($year, $format=0)
 Return amount of salaries by month for a given year.
 
 getAverageByMonth ($year)
 Return average amount.
 
 getAllByYear ()
 Return nb, 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.
 

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

Definition at line 31 of file salariesstats.class.php.

Constructor & Destructor Documentation

◆ __construct()

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

Constructor.

Parameters
DoliDB$dbDatabase handler
int$socidId third party
mixed$useridId user for filter or array of user ids
Returns
void

Definition at line 53 of file salariesstats.class.php.

References $object.

Member Function Documentation

◆ getAllByYear()

SalariesStats::getAllByYear ( )

Return nb, total and average.

Returns
array Array of values

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

References Stats\_getAllByYear().

◆ getAmountByMonth()

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

Return amount of salaries by month for a given year.

Parameters
int$yearYear to scan
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 values

Reimplemented from Stats.

Definition at line 122 of file salariesstats.class.php.

References Stats\_getAmountByMonth().

◆ getAverageByMonth()

SalariesStats::getAverageByMonth ( $year)

Return average amount.

Parameters
int$yearYear to scan
Returns
array Array of values

Reimplemented from Stats.

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

References Stats\_getAverageByMonth().

◆ getNbByMonth()

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

Return the number of salary by month, for a given year.

Parameters
int$yearYear to scan
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 values by month

Reimplemented from Stats.

Definition at line 100 of file salariesstats.class.php.

References Stats\_getNbByMonth().

◆ getNbByYear()

SalariesStats::getNbByYear ( )

Return the number of salary by year.

Returns
array Array of values

Definition at line 82 of file salariesstats.class.php.

References Stats\_getNbByYear().


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