ProjectStats

class ProjectStats extends Stats (View source)

Class to manage statistics on projects

Properties

protected DoliDB $db from  Stats
protected array<string, int> $lastfetchdate from  Stats
string $cachefilesuffix from  Stats
string $from
string $where
string $from_line from  Stats
string $field_date from  Stats
string $field
string $field_line from  Stats
string $error from  Stats
int $year from  Stats
int $month from  Stats
int $userid
int $socid
int $status
string $opp_status

Methods

array<int<0, 11>, array{0: int<1, 12>, 1: int}>
getNbByMonth(int $year, int $format = 0)

Return Project number by month for a year

array<int<0, 11>, array{0: int<1, 12>, 1: int}>
getNbByMonthWithPrevYear(int $endyear, int $startyear, int $cachedelay = 0, int $format = 0, int $startmonth = 1)

Return nb of elements by month for several years

from  Stats
array<int<0, 11>, array{0: int<1, 12>, 1: int|float}>
getAmountByMonth(int $year, int $format = 0)

Return the Project amount by month for a year

array<int<0, 11>, array<string|int|float>>
getAmountByMonthWithPrevYear(int $endyear, int $startyear, int $cachedelay = 0, int $format = 0, int $startmonth = 1)

Return amount of elements by month for several years.

from  Stats
array<int<0, 11>, array{0: int<1, 12>, 1: int|float}>
getAverageByMonth(int $year)

Return average of entity by month

array<array<int|float>>
getAverageByMonthWithPrevYear(int $endyear, int $startyear)

Return average of entity by month for several years

from  Stats
array<int<0, 11>, array{0: int<1, 12>, 1: int|float}>
getAllByProductEntry(int $year, int $cachedelay = 0, int $limit = 10)

Return count, and sum of products

from  Stats
array<array{0: int, 1: int}>
_getNbByYear(string $sql)

Return nb of elements by year

from  Stats
_getAllByYear(string $sql)

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

from  Stats
array<int<0, 11>, array{0: int<1, 12>, 1: int}>
_getNbByMonth(int $year, string $sql, int<0, 2> $format = 0)

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

from  Stats
array<int<0, 11>, array{0: int<1, 12>, 1: int|float}>
_getAmountByMonth(int $year, string $sql, int<0, 2> $format = 0)

Return the amount per month for a given year

from  Stats
array<int<0, 11>, array{0: int<1, 12>, 1: int|float}>
_getAverageByMonth($year, string $sql, $format = 0)

Return the amount average par month for a given year

from  Stats
array<int<0, 11>, array{0: int<1, 12>, 1: int|float}>
_getAllByProduct($sql, int $limit = 10)

Return number or total of product refs

from  Stats
array<int, array{0: int, 1: int}>
_getAmountByYear($sql)

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

from  Stats
array<int<0, 11>, array{0: int<1, 12>, 1: int|float}>
getAllByProduct(int $year, $limit = 0)

Return nb, amount of predefined product for year

from  Stats
__construct(DoliDB $db)

Constructor

array<array{0: string, 1: float}>|int<-1, -1>
getAllProjectByStatus(int $limit = 5)

Return all leads grouped by opportunity status.

getAllByYear()

Return count, and sum of products

string
buildWhere()

Build the where part

int<-1, -1>|array<int<0, 11>, array{0: string, 1: int, 2?: int, 3?: int, 4?: int}>
getWeightedAmountByMonthWithPrevYear(int $endyear, int $startyear, int $cachedelay = 0, int $wonlostfilter = 1)

Return amount of elements by month for several years

array<int<0, 11>, array{0: int<1, 12>, 1: int|float}>
getWeightedAmountByMonth(int $year, int $wonlostfilter = 1)

Return the Project weighted opp amount by month for a year.

array<int<0, 11>, array<string|float>>|int<-1, -1>
getTransformRateByMonthWithPrevYear(int $endyear, int $startyear, int $cachedelay = 0)

Return amount of elements by month for several years

array<int<0, 11>, array{0: int<1, 12>, 1: int|float}>
getTransformRateByMonth(int $year, int $format = 0)

Return the Project transformation rate by month for a year

Details

at line 266
array<int<0, 11>, array{0: int<1, 12>, 1: int}> getNbByMonth(int $year, int $format = 0)

Return Project number by month for a year

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

Return Value

array<int<0, 11>, array{0: int<1, 12>, 1: int}>

Array of nb each month

in Stats at line 106
array<int<0, 11>, array{0: int<1, 12>, 1: int}> getNbByMonthWithPrevYear(int $endyear, int $startyear, int $cachedelay = 0, int $format = 0, int $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

Return Value

array<int<0, 11>, array{0: int<1, 12>, 1: int}>

Array of values

at line 291
array<int<0, 11>, array{0: int<1, 12>, 1: int|float}> getAmountByMonth(int $year, int $format = 0)

Return the Project amount by month for a year

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

Return Value

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

Array of values by month

in Stats at line 208
array<int<0, 11>, array<string|int|float>> getAmountByMonthWithPrevYear(int $endyear, int $startyear, int $cachedelay = 0, int $format = 0, int $startmonth = 1)

Return amount of elements by month for several years.

Criteria 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

Return Value

array<int<0, 11>, array<string|int|float>>

Array of values

at line 562
protected array<int<0, 11>, array{0: int<1, 12>, 1: int|float}> getAverageByMonth(int $year)

Return average of entity by month

Parameters

int $year

year number

Return Value

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

Array of values

in Stats at line 303
array<array<int|float>> getAverageByMonthWithPrevYear(int $endyear, int $startyear)

Return average of entity by month for several years

Parameters

int $endyear

Start year
int $startyear

End year

Return Value

array<array<int|float>>

Array of values

in Stats at line 338
array<int<0, 11>, array{0: int<1, 12>, 1: int|float}> getAllByProductEntry(int $year, int $cachedelay = 0, int $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

Return Value

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

Array of values

in Stats at line 408
protected array<array{0: int, 1: int}> _getNbByYear(string $sql)

Return nb of elements by year

Parameters

string $sql

SQL request

Return Value

array<array{0: int, 1: int}>

Array of nb each year

in Stats at line 437
protected _getAllByYear(string $sql)

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

Parameters

string $sql

SQL request @return 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

in Stats at line 494
protected array<int<0, 11>, array{0: int<1, 12>, 1: int}> _getNbByMonth(int $year, string $sql, int<0, 2> $format = 0)

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<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

Return Value

array<int<0, 11>, array{0: int<1, 12>, 1: int}>

Array of nb each month

in Stats at line 551
protected array<int<0, 11>, array{0: int<1, 12>, 1: int|float}> _getAmountByMonth(int $year, string $sql, int<0, 2> $format = 0)

Return the amount per month for a given year

Parameters

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

Return Value

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

Array of nb each month

in Stats at line 608
protected array<int<0, 11>, array{0: int<1, 12>, 1: int|float}> _getAverageByMonth($year, string $sql, $format = 0)

Return the amount average par month for a given year

@param int $year Year

Parameters

$year
string $sql

SQL @param 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
$format

Return Value

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

Array of average each month

in Stats at line 665
protected array<int<0, 11>, array{0: int<1, 12>, 1: int|float}> _getAllByProduct($sql, int $limit = 10)

Return number or total of product refs

@param string $sql SQL

Parameters

$sql
int $limit Limit

Return Value

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

Array of total of product refs each month

in Stats at line 704
protected array<int, array{0: int, 1: int}> _getAmountByYear($sql)

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

@param string $sql SQL

Parameters

$sql

Return Value

array<int, array{0: int, 1: int}>

Array of sum of amounts

in Stats at line 732
array<int<0, 11>, array{0: int<1, 12>, 1: int|float}> getAllByProduct(int $year, $limit = 0)

Return nb, amount of predefined product for year

Parameters

int $year

Year to scan @param int $limit Limit
$limit

Return Value

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

Array of values

at line 69
__construct(DoliDB $db)

Constructor

Parameters

DoliDB $db

Database handler

at line 100
array<array{0: string, 1: float}>|int<-1, -1> getAllProjectByStatus(int $limit = 5)

Return all leads grouped by opportunity status.

Warning: There is no filter on WON/LOST because we want this for statistics.

Parameters

int $limit

Limit results

Return Value

array<array{0: string, 1: float}>|int<-1, -1>

Array with value or -1 if error

Exceptions

Exception

at line 164
getAllByYear()

Return count, and sum of products

@return 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

at line 195
string buildWhere()

Build the where part

Return Value

string

at line 319
int<-1, -1>|array<int<0, 11>, array{0: string, 1: int, 2?: int, 3?: int, 4?: int}> getWeightedAmountByMonthWithPrevYear(int $endyear, int $startyear, int $cachedelay = 0, int $wonlostfilter = 1)

Return amount 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 $wonlostfilter

Add a filter on status won/lost

Return Value

int<-1, -1>|array<int<0, 11>, array{0: string, 1: int, 2?: int, 3?: int, 4?: int}>

Array of values or <0 if error

at line 404
array<int<0, 11>, array{0: int<1, 12>, 1: int|float}> getWeightedAmountByMonth(int $year, int $wonlostfilter = 1)

Return the Project weighted opp amount by month for a year.

Parameters

int $year

Year to scan
int $wonlostfilter

Add a filter on status won/lost

Return Value

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

Array with amount by month

at line 430
array<int<0, 11>, array<string|float>>|int<-1, -1> getTransformRateByMonthWithPrevYear(int $endyear, int $startyear, int $cachedelay = 0)

Return amount of elements by month for several years

Parameters

int $endyear

End year
int $startyear

Start year
int $cachedelay

accept for cache file (0=No read, no save of cache, -1=No read but save)

Return Value

array<int<0, 11>, array<string|float>>|int<-1, -1>

Array of values or <0 if error

at line 513
array<int<0, 11>, array{0: int<1, 12>, 1: int|float}> getTransformRateByMonth(int $year, int $format = 0)

Return the Project transformation rate 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

Return Value

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

Array with amount by month