dolibarr 18.0.6
date.lib.php File Reference

Set of function to manipulate dates. More...

Go to the source code of this file.

Functions

 get_tz_array ()
 Return an array with timezone values.
 
 getServerTimeZoneString ()
 Return server timezone string.
 
 getServerTimeZoneInt ($refgmtdate='now')
 Return server timezone int.
 
 dol_time_plus_duree ($time, $duration_value, $duration_unit, $ruleforendofmonth=0)
 Add a delay to a date.
 
 convertTime2Seconds ($iHours=0, $iMinutes=0, $iSeconds=0)
 Convert hours and minutes into seconds.
 
 convertSecondToTime ($iSecond, $format='all', $lengthOfDay=86400, $lengthOfWeek=7)
 Return, in clear text, value of a number of seconds in days, hours and minutes.
 
 convertDurationtoHour ($duration_value, $duration_unit)
 Convert duration to hour.
 
 dolSqlDateFilter ($datefield, $day_date, $month_date, $year_date, $excludefirstand=0, $gm=false)
 Generate a SQL string to make a filter into a range (for second of date until last second of date).
 
 dol_stringtotime ($string, $gm=1)
 Convert a string date into a GM Timestamps date Warning: YYYY-MM-DDTHH:MM:SS+02:00 (RFC3339) is not supported.
 
 dol_get_prev_day ($day, $month, $year)
 Return previous day.
 
 dol_get_next_day ($day, $month, $year)
 Return next day.
 
 dol_get_prev_month ($month, $year)
 Return previous month.
 
 dol_get_next_month ($month, $year)
 Return next month.
 
 dol_get_prev_week ($day, $week, $month, $year)
 Return previous week.
 
 dol_get_next_week ($day, $week, $month, $year)
 Return next week.
 
 dol_get_first_day ($year, $month=1, $gm=false)
 Return GMT time for first day of a month or year.
 
 dol_get_last_day ($year, $month=12, $gm=false)
 Return GMT time for last day of a month or year.
 
 dol_get_last_hour ($date, $gm='tzserver')
 Return GMT time for last hour of a given GMT date (it replaces hours, min and second part to 23:59:59)
 
 dol_get_first_hour ($date, $gm='tzserver')
 Return GMT time for first hour of a given GMT date (it removes hours, min and second part)
 
 dol_get_first_day_week ($day, $month, $year, $gm=false)
 Return first day of week for a date.
 
 getGMTEasterDatetime ($year)
 Return the easter day in GMT time.
 
 num_public_holiday ($timestampStart, $timestampEnd, $country_code='', $lastday=0, $includesaturday=-1, $includesunday=-1, $includefriday=-1, $includemonday=-1)
 Return the number of non working days including Friday, Saturday and Sunday (or not) between 2 dates in timestamp.
 
 num_between_day ($timestampStart, $timestampEnd, $lastday=0)
 Function to return number of days between two dates (date must be UTC date !) Example: 2012-01-01 2012-01-02 => 1 if lastday=0, 2 if lastday=1.
 
 num_open_day ($timestampStart, $timestampEnd, $inhour=0, $lastday=0, $halfday=0, $country_code='')
 Function to return number of working days (and text of units) between two dates (working days)
 
 monthArray ($outputlangs, $short=0)
 Return array of translated months or selected month.
 
 getWeekNumbersOfMonth ($month, $year)
 Return array of week numbers.
 
 getFirstDayOfEachWeek ($TWeek, $year)
 Return array of first day of weeks.
 
 getLastDayOfEachWeek ($TWeek, $year)
 Return array of last day of weeks.
 
 getWeekNumber ($day, $month, $year)
 Return week number.
 

Detailed Description

Set of function to manipulate dates.

Definition in file date.lib.php.

Function Documentation

◆ convertDurationtoHour()

convertDurationtoHour ( $duration_value,
$duration_unit )

Convert duration to hour.

Parameters
int$duration_valueDuration value
int$duration_unitDuration unit
Returns
int $result

Definition at line 332 of file date.lib.php.

Referenced by BOM\calculateCosts().

◆ convertSecondToTime()

convertSecondToTime ( $iSecond,
$format = 'all',
$lengthOfDay = 86400,
$lengthOfWeek = 7 )

Return, in clear text, value of a number of seconds in days, hours and minutes.

Can be used to show a duration.

Parameters
int$iSecondNumber of seconds
string$formatOutput format
  • 'all': total delay days hour:min like "2 days 12:30",
    • 'allwithouthour': total delay days without hour part like "2 days",
    • 'allhourmin': total delay with format hours:min like "60:30",
    • 'allhourminsec': total delay with format hours:min:sec like "60:30:10",
    • 'allhour': total delay hours without min/sec like "60:30",
    • 'fullhour': total delay hour decimal like "60.5" for 60:30,
    • 'hour': only hours part "12",
    • 'min': only minutes part "30",
    • 'sec': only seconds part,
    • 'month': only month part,
    • 'year': only year part);
int$lengthOfDayLength of day (default 86400 seconds for 1 day, 28800 for 8 hour)
int$lengthOfWeekLength of week (default 7)
Returns
string Formated text of duration Example: 0 return 00:00, 3600 return 1:00, 86400 return 1d, 90000 return 1 Day 01:00
See also
convertTime2Seconds()

Definition at line 240 of file date.lib.php.

References dol_print_date().

Referenced by build_calfile(), constructGanttLine(), doc_generic_project_odt\get_substitutionarray_tasks(), doc_generic_task_odt\get_substitutionarray_tasks(), doc_generic_project_odt\get_substitutionarray_taskstime(), doc_generic_task_odt\get_substitutionarray_taskstime(), Fichinter\getKanbanView(), getTaskProgressView(), print_projecttasks_array(), projectLinesa(), projectLinesPerAction(), projectLinesPerDay(), projectLinesPerWeek(), pdf_baleine\write_file(), pdf_soleil\write_file(), pdf_strato\write_file(), and pdf_timespent\write_file().

◆ convertTime2Seconds()

convertTime2Seconds ( $iHours = 0,
$iMinutes = 0,
$iSeconds = 0 )

Convert hours and minutes into seconds.

Parameters
int$iHoursHours
int$iMinutesMinutes
int$iSecondsSeconds
Returns
int Time into seconds
See also
convertSecondToTime()

Definition at line 211 of file date.lib.php.

◆ dol_get_first_day()

dol_get_first_day ( $year,
$month = 1,
$gm = false )

Return GMT time for first day of a month or year.

Parameters
int$yearYear
int$monthMonth
mixed$gmFalse or 0 or 'tzserver' = Return date to compare with server TZ, True or 1 or 'gmt' to compare with GMT date. Example: dol_get_first_day(1970,1,false) will return -3600 with TZ+1, a dol_print_date on it will return 1970-01-01 00:00:00 Example: dol_get_first_day(1970,1,true) will return 0 whatever is TZ, a dol_print_date on it will return 1970-01-01 00:00:00
Returns
int Date for first day, '' if error

Definition at line 577 of file date.lib.php.

References dol_mktime().

Referenced by CommActionRapport\_pages(), activitytrim(), ActionComm\build_exportfile(), ProjectStats\buildWhere(), TaskStats\buildWhere(), Asset\calculationDepreciation(), AdherentStats\countMembersByTagAndStatus(), AdherentStats\countMembersByTypeAndStatus(), Facture\createFromClone(), dolSqlDateFilter(), CommandeStats\getAllByProduct(), FactureStats\getAllByProduct(), FichinterStats\getAllByProduct(), PropaleStats\getAllByProduct(), CommandeStats\getAmountByMonth(), FactureStats\getAmountByMonth(), FichinterStats\getAmountByMonth(), PropaleStats\getAmountByMonth(), ReceptionStats\getAmountByMonth(), FactureStats\getAmountByYear(), CommandeStats\getAverageByMonth(), FactureStats\getAverageByMonth(), FichinterStats\getAverageByMonth(), ProjectStats\getAverageByMonth(), PropaleStats\getAverageByMonth(), ReceptionStats\getAverageByMonth(), TaskStats\getAverageByMonth(), CommandeStats\getNbByMonth(), DonationStats\getNbByMonth(), ExpeditionStats\getNbByMonth(), FactureStats\getNbByMonth(), FichinterStats\getNbByMonth(), PropaleStats\getNbByMonth(), ReceptionStats\getNbByMonth(), AccountancyCategory\getSumDebitCredit(), box_birthdays\loadBox(), Localtax\localtax_sum_collectee(), Localtax\localtax_sum_payee(), Localtax\localtax_sum_reglee(), tax_by_rate(), tax_by_thirdparty(), pdf_paiement\write_file(), and pdf_standard\write_file().

◆ dol_get_first_day_week()

dol_get_first_day_week ( $day,
$month,
$year,
$gm = false )

Return first day of week for a date.

First day of week may be monday if option MAIN_START_WEEK is 1.

Parameters
int$dayDay
int$monthMonth
int$yearYear
mixed$gmFalse or 0 or 'tzserver' = Return date to compare with server TZ, True or 1 or 'gmt' to compare with GMT date.
Returns
array year,month,week,first_day,first_month,first_year,prev_day,prev_month,prev_year

Definition at line 652 of file date.lib.php.

References dol_getdate(), and dol_mktime().

Referenced by dol_get_next_week(), and dol_get_prev_week().

◆ dol_get_first_hour()

dol_get_first_hour ( $date,
$gm = 'tzserver' )

Return GMT time for first hour of a given GMT date (it removes hours, min and second part)

Parameters
int$dateDate GMT
mixed$gmFalse or 0 or 'tzserver' = Return date to compare with server TZ, 'gmt' to compare with GMT date.
Returns
int Date for last hour of a given date

Definition at line 637 of file date.lib.php.

References dol_getdate(), and dol_mktime().

Referenced by User\isNotIntoValidityDateRange(), and Facture\sendEmailsRemindersOnInvoiceDueDate().

◆ dol_get_last_day()

dol_get_last_day ( $year,
$month = 12,
$gm = false )

Return GMT time for last day of a month or year.

Note: The timestamp contains last day and last hours (23:59:59)

Parameters
int$yearYear
int$monthMonth
mixed$gmFalse or 0 or 'tzserver' = Return date to compare with server TZ, True or 1 or 'gmt' to compare with GMT date.
Returns
int Date for first day, '' if error

Definition at line 596 of file date.lib.php.

References dol_mktime().

Referenced by CommActionRapport\_pages(), ActionComm\build_exportfile(), ProjectStats\buildWhere(), TaskStats\buildWhere(), Asset\calculationDepreciation(), Facture\createFromClone(), dolSqlDateFilter(), Accountancy\exportData(), CommandeStats\getAllByProduct(), FactureStats\getAllByProduct(), FichinterStats\getAllByProduct(), PropaleStats\getAllByProduct(), CommandeStats\getAmountByMonth(), FactureStats\getAmountByMonth(), FichinterStats\getAmountByMonth(), PropaleStats\getAmountByMonth(), ReceptionStats\getAmountByMonth(), FactureStats\getAmountByYear(), CommandeStats\getAverageByMonth(), FactureStats\getAverageByMonth(), FichinterStats\getAverageByMonth(), ProjectStats\getAverageByMonth(), PropaleStats\getAverageByMonth(), ReceptionStats\getAverageByMonth(), TaskStats\getAverageByMonth(), getCurrentPeriodOfFiscalYear(), getDefaultDatesForTransfer(), CommandeStats\getNbByMonth(), DonationStats\getNbByMonth(), ExpeditionStats\getNbByMonth(), FactureStats\getNbByMonth(), FichinterStats\getNbByMonth(), PropaleStats\getNbByMonth(), ReceptionStats\getNbByMonth(), AccountancyCategory\getSumDebitCredit(), Localtax\localtax_sum_collectee(), Localtax\localtax_sum_payee(), Localtax\localtax_sum_reglee(), tax_by_rate(), tax_by_thirdparty(), pdf_paiement\write_file(), and pdf_standard\write_file().

◆ dol_get_last_hour()

dol_get_last_hour ( $date,
$gm = 'tzserver' )

Return GMT time for last hour of a given GMT date (it replaces hours, min and second part to 23:59:59)

Parameters
int$dateDate GMT
mixed$gmFalse or 0 or 'tzserver' = Return date to compare with server TZ, 'gmt' to compare with GMT date.
Returns
int Date for last hour of a given date

Definition at line 623 of file date.lib.php.

References dol_getdate(), and dol_mktime().

Referenced by Facture\createDepositFromOrigin(), and User\isNotIntoValidityDateRange().

◆ dol_get_next_day()

dol_get_next_day ( $day,
$month,
$year )

Return next day.

Parameters
int$dayDay
int$monthMonth
int$yearYear
Returns
array Next year,month,day

Definition at line 481 of file date.lib.php.

References dol_getdate(), and dol_mktime().

Referenced by getCommonSubstitutionArray(), and GETPOST().

◆ dol_get_next_month()

dol_get_next_month ( $month,
$year )

Return next month.

Parameters
int$monthMonth
int$yearYear
Returns
array Next year,month

Definition at line 515 of file date.lib.php.

Referenced by Facture\createFromClone(), getCommonSubstitutionArray(), and GETPOST().

◆ dol_get_next_week()

dol_get_next_week ( $day,
$week,
$month,
$year )

Return next week.

Parameters
int$dayDay
int$weekWeek
int$monthMonth
int$yearYear
Returns
array Next year,month,day

Definition at line 555 of file date.lib.php.

References dol_get_first_day_week(), dol_getdate(), and dol_mktime().

◆ dol_get_prev_day()

dol_get_prev_day ( $day,
$month,
$year )

Return previous day.

Parameters
int$dayDay
int$monthMonth
int$yearYear
Returns
array Previous year,month,day

Definition at line 465 of file date.lib.php.

References dol_getdate(), and dol_mktime().

Referenced by getCommonSubstitutionArray(), and GETPOST().

◆ dol_get_prev_month()

dol_get_prev_month ( $month,
$year )

Return previous month.

Parameters
int$monthMonth
int$yearYear
Returns
array Previous year,month

Definition at line 496 of file date.lib.php.

Referenced by Accountancy\exportData(), getCommonSubstitutionArray(), and GETPOST().

◆ dol_get_prev_week()

dol_get_prev_week ( $day,
$week,
$month,
$year )

Return previous week.

Parameters
int$dayDay
int$weekWeek
int$monthMonth
int$yearYear
Returns
array Previous year,month,day

Definition at line 536 of file date.lib.php.

References dol_get_first_day_week(), dol_getdate(), and dol_mktime().

◆ dol_stringtotime()

dol_stringtotime ( $string,
$gm = 1 )

Convert a string date into a GM Timestamps date Warning: YYYY-MM-DDTHH:MM:SS+02:00 (RFC3339) is not supported.

If parameter gm is 1, we will use no TZ, if not we will use TZ of server, not the one inside string.

Parameters
string$stringDate in a string YYYYMMDD YYYYMMDDHHMMSS YYYYMMDDTHHMMSSZ YYYY-MM-DDTHH:MM:SSZ (RFC3339) DD/MM/YY or DD/MM/YYYY (deprecated) DD/MM/YY HH:MM:SS or DD/MM/YYYY HH:MM:SS (deprecated)
int | string$gm'gmt' or 1 =Input date is GM date, 'tzserver' or 0 =Input date is date using PHP server timezone
Returns
int Date as a timestamp 19700101020000 -> 7200 with gm=1 19700101000000 -> 0 with gm=1
See also
dol_print_date(), dol_mktime(), dol_getdate()

Definition at line 409 of file date.lib.php.

References dol_mktime(), and dol_syslog().

Referenced by Tasks\addTimeSpent(), ActionComm\build_exportfile(), Export\build_file(), createInvoice(), createOrder(), createProject(), Dolistore\get_products(), ImportCsv\import_insert(), ImportXlsx\import_insert(), StockMovements\post(), Tasks\putTimeSpent(), and ExportExcel2007\write_record().

◆ dol_time_plus_duree()

◆ dolSqlDateFilter()

dolSqlDateFilter ( $datefield,
$day_date,
$month_date,
$year_date,
$excludefirstand = 0,
$gm = false )

Generate a SQL string to make a filter into a range (for second of date until last second of date).

This method allows to maje SQL request that will deal correctly the timezone of server.

Parameters
string$datefieldName of SQL field where apply sql date filter
int | string$day_dateDay date (Can be 0 or '' for filter on a month)
int | string$month_dateMonth date (Can be 0 or '' for filter on a year)
int | string$year_dateYear date
int$excludefirstandExclude first and
mixed$gmFalse or 0 or 'tzserver' = Input date fields are date info in the server TZ. True or 1 or 'gmt' = Input are date info in GMT TZ. Note: In database, dates are always fot the server TZ.
Returns
string $sqldate String with SQL filter

Definition at line 360 of file date.lib.php.

References dol_get_first_day(), dol_get_last_day(), and dol_mktime().

Referenced by BookKeeping\deleteByYearAndJournal(), box_birthdays\loadBox(), and box_birthdays_members\loadBox().

◆ get_tz_array()

get_tz_array ( )

Return an array with timezone values.

Returns
array Array with timezone values

Definition at line 34 of file date.lib.php.

◆ getFirstDayOfEachWeek()

getFirstDayOfEachWeek ( $TWeek,
$year )

Return array of first day of weeks.

Parameters
array$TWeekarray of week numbers
int$yearYear number
Returns
array First day of week

Definition at line 1135 of file date.lib.php.

◆ getGMTEasterDatetime()

getGMTEasterDatetime ( $year)

Return the easter day in GMT time.

This function replaces easter_date() that returns a date in local TZ.

Parameters
int$yearYear
Returns
int GMT Date of easter day

Definition at line 722 of file date.lib.php.

Referenced by num_public_holiday().

◆ getLastDayOfEachWeek()

getLastDayOfEachWeek ( $TWeek,
$year )

Return array of last day of weeks.

Parameters
array$TWeekarray of week numbers
int$yearYear number
Returns
array Last day of week

Definition at line 1153 of file date.lib.php.

◆ getServerTimeZoneInt()

getServerTimeZoneInt ( $refgmtdate = 'now')

Return server timezone int.

Parameters
string$refgmtdateReference period for timezone (timezone differs on winter and summer. May be 'now', 'winter' or 'summer')
Returns
float An offset in hour (+1 for Europe/Paris on winter and +2 for Europe/Paris on summer). Note some countries use half and even quarter hours.

Definition at line 83 of file date.lib.php.

References dol_now(), dol_print_date(), dol_print_error(), and getServerTimeZoneString().

Referenced by dol_now(), dol_print_object_info(), and Form\selectDate().

◆ getServerTimeZoneString()

getServerTimeZoneString ( )

Return server timezone string.

Returns
string PHP server timezone string ('Europe/Paris')

Definition at line 72 of file date.lib.php.

Referenced by getServerTimeZoneInt().

◆ getWeekNumber()

getWeekNumber ( $day,
$month,
$year )

Return week number.

Parameters
int$dayDay number
int$monthMonth number
int$yearYear number
Returns
int Week number

Definition at line 1169 of file date.lib.php.

Referenced by getWeekNumbersOfMonth(), and Project\loadTimeSpentMonth().

◆ getWeekNumbersOfMonth()

getWeekNumbersOfMonth ( $month,
$year )

Return array of week numbers.

Parameters
int$monthMonth number
int$yearYear number
Returns
array Week numbers

Definition at line 1118 of file date.lib.php.

References getWeekNumber().

◆ monthArray()

monthArray ( $outputlangs,
$short = 0 )

Return array of translated months or selected month.

This replace old function monthArrayOrSelected.

Parameters
Translate$outputlangsObject langs
int$short0=Return long label, 1=Return short label
Returns
array Month string or array if selected < 0

Definition at line 1075 of file date.lib.php.

◆ num_between_day()

num_between_day ( $timestampStart,
$timestampEnd,
$lastday = 0 )

Function to return number of days between two dates (date must be UTC date !) Example: 2012-01-01 2012-01-02 => 1 if lastday=0, 2 if lastday=1.

Parameters
int$timestampStartTimestamp start UTC
int$timestampEndTimestamp end UTC
int$lastdayLast day is included, 0: no, 1:yes
Returns
int Number of days @seealso num_public_holiday(), num_open_day()

Definition at line 991 of file date.lib.php.

Referenced by Asset\calculationDepreciation(), and num_open_day().

◆ num_open_day()

num_open_day ( $timestampStart,
$timestampEnd,
$inhour = 0,
$lastday = 0,
$halfday = 0,
$country_code = '' )

Function to return number of working days (and text of units) between two dates (working days)

Parameters
int$timestampStartTimestamp for start date (date must be UTC to avoid calculation errors)
int$timestampEndTimestamp for end date (date must be UTC to avoid calculation errors)
int$inhour0: return number of days, 1: return number of hours
int$lastdayWe include last day, 0: no, 1:yes
int$halfdayTag to define half day when holiday start and end
string$country_codeCountry code (company country code if not defined)
Returns
int|string Number of days or hours or string if error @seealso num_between_day(), num_public_holiday()

Definition at line 1017 of file date.lib.php.

References dol_syslog(), num_between_day(), and num_public_holiday().

Referenced by Export\build_file().

◆ num_public_holiday()

num_public_holiday ( $timestampStart,
$timestampEnd,
$country_code = '',
$lastday = 0,
$includesaturday = -1,
$includesunday = -1,
$includefriday = -1,
$includemonday = -1 )

Return the number of non working days including Friday, Saturday and Sunday (or not) between 2 dates in timestamp.

Dates must be UTC with hour, min, sec to 0. Called by function num_open_day()

Parameters
int$timestampStartTimestamp start (UTC with hour, min, sec = 0)
int$timestampEndTimestamp end (UTC with hour, min, sec = 0)
string$country_codeCountry code
int$lastdayLast day is included, 0: no, 1:yes
int$includesaturdayInclude saturday as non working day (-1=use setup, 0=no, 1=yes)
int$includesundayInclude sunday as non working day (-1=use setup, 0=no, 1=yes)
int$includefridayInclude friday as non working day (-1=use setup, 0=no, 1=yes)
int$includemondayInclude monday as non working day (-1=use setup, 0=no, 1=yes)
Returns
int|string Number of non working days or error message string if error
See also
num_between_day(), num_open_day()

Definition at line 746 of file date.lib.php.

References dol_getIdFromCode(), dol_syslog(), dol_time_plus_duree(), and getGMTEasterDatetime().

Referenced by num_open_day().