From d5ab0723bafddb10bb415c70f0f392d86eae96d4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rapha=C3=ABl=20Doursenaud?= Date: Thu, 7 Nov 2013 21:12:11 +0100 Subject: [PATCH] Timestamp is not a type Timestamps are integers so let's document this correctly --- htdocs/comm/action/class/ical.class.php | 4 ++-- htdocs/comm/propal/class/propal.class.php | 14 +++++++------- htdocs/core/lib/date.lib.php | 8 ++++---- htdocs/core/lib/files.lib.php | 2 +- htdocs/core/lib/functions.lib.php | 8 ++++---- 5 files changed, 18 insertions(+), 18 deletions(-) diff --git a/htdocs/comm/action/class/ical.class.php b/htdocs/comm/action/class/ical.class.php index 4dc47cdc395..0e279adc03c 100644 --- a/htdocs/comm/action/class/ical.class.php +++ b/htdocs/comm/action/class/ical.class.php @@ -270,7 +270,7 @@ class ICal * Return Unix time from ical date time fomrat (YYYYMMDD[T]HHMMSS[Z] or YYYYMMDD[T]HHMMSS) * * @param string $ical_date String date - * @return timestamp + * @return int */ function ical_date_to_unix($ical_date) { @@ -395,4 +395,4 @@ class ICal return $this->cal; } } -?> \ No newline at end of file +?> diff --git a/htdocs/comm/propal/class/propal.class.php b/htdocs/comm/propal/class/propal.class.php index ada87415b11..7f2b3f5bb3c 100644 --- a/htdocs/comm/propal/class/propal.class.php +++ b/htdocs/comm/propal/class/propal.class.php @@ -305,8 +305,8 @@ class Propal extends CommonObject * @param int $fk_fournprice Id supplier price * @param int $pa_ht Buying price without tax * @param string $label ??? - * @param timestamp $date_start Start date of the line - * @param timestamp $date_end End date of the line + * @param int $date_start Start date of the line + * @param int $date_end End date of the line * @param array $array_option extrafields array * @return int >0 if OK, <0 if KO * @@ -479,8 +479,8 @@ class Propal extends CommonObject * @param int $pa_ht Price (without tax) of product when it was bought * @param string $label ??? * @param int $type 0/1=Product/service - * @param timestamp $date_start Start date of the line - * @param timestamp $date_end End date of the line + * @param int $date_start Start date of the line + * @param int $date_end End date of the line * @param array $array_option extrafields array * @return int 0 if OK, <0 if KO */ @@ -1370,7 +1370,7 @@ class Propal extends CommonObject * Define proposal date * * @param User $user Object user that modify - * @param timestamp $date Date + * @param int $date Date * @return int <0 if KO, >0 if OK */ function set_date($user, $date) @@ -1407,7 +1407,7 @@ class Propal extends CommonObject * Define end validity date * * @param User $user Object user that modify - * @param timestamp $date_fin_validite End of validity date + * @param int $date_fin_validite End of validity date * @return int <0 if KO, >0 if OK */ function set_echeance($user, $date_fin_validite) @@ -1434,7 +1434,7 @@ class Propal extends CommonObject * Set delivery date * * @param User $user Object user that modify - * @param timestamp $date_livraison Delivery date + * @param int $date_livraison Delivery date * @return int <0 if ko, >0 if ok */ function set_date_livraison($user, $date_livraison) diff --git a/htdocs/core/lib/date.lib.php b/htdocs/core/lib/date.lib.php index 95eb057b547..78551dac105 100644 --- a/htdocs/core/lib/date.lib.php +++ b/htdocs/core/lib/date.lib.php @@ -166,10 +166,10 @@ function getParentCompanyTimeZoneInt($refgmtdate='now') /** * Add a delay to a date * - * @param timestamp $time Date timestamp (or string with format YYYY-MM-DD) + * @param int $time Date timestamp (or string with format YYYY-MM-DD) * @param int $duration_value Value of delay to add * @param int $duration_unit Unit of added delay (d, m, y, w) - * @return timestamp New timestamp + * @return int New timestamp */ function dol_time_plus_duree($time,$duration_value,$duration_unit) { @@ -317,7 +317,7 @@ function convertSecondToTime($iSecond, $format='all', $lengthOfDay=86400, $lengt * DD/MM/YY HH:MM:SS or DD/MM/YYYY HH:MM:SS (this format should not be used anymore) * @param int $gm 1 =Input date is GM date, * 0 =Input date is local date using PHP server timezone - * @return date Date + * @return int Date as a timestamp * 19700101020000 -> 7200 with gm=1 * * @see dol_print_date, dol_mktime, dol_getdate @@ -812,4 +812,4 @@ function monthArray($outputlangs) return $montharray; } -?> \ No newline at end of file +?> diff --git a/htdocs/core/lib/files.lib.php b/htdocs/core/lib/files.lib.php index b64f403b758..1021316b0df 100644 --- a/htdocs/core/lib/files.lib.php +++ b/htdocs/core/lib/files.lib.php @@ -461,7 +461,7 @@ function dol_filesize($pathoffile) * Return time of a file * * @param string $pathoffile Path of file - * @return timestamp Time of file + * @return int Time of file */ function dol_filemtime($pathoffile) { diff --git a/htdocs/core/lib/functions.lib.php b/htdocs/core/lib/functions.lib.php index 9e67318d693..202e1f0cb4a 100644 --- a/htdocs/core/lib/functions.lib.php +++ b/htdocs/core/lib/functions.lib.php @@ -776,7 +776,7 @@ function dol_strftime($fmt, $ts=false, $is_gmt=false) * Output date in a string format according to outputlangs (or langs if not defined). * Return charset is always UTF-8, except if encodetoouput is defined. In this case charset is output charset * - * @param timestamp $time GM Timestamps date + * @param int $time GM Timestamps date * @param string $format Output date format * "%d %b %Y", * "%d/%m/%Y %H:%M", @@ -932,7 +932,7 @@ function dol_print_date($time,$format='',$tzoutput='tzserver',$outputlangs='',$e * WARNING: This function always use PHP server timezone to return locale informations. * Usage must be avoid. * - * @param timestamp $timestamp Timestamp + * @param int $timestamp Timestamp * @param boolean $fast Fast mode * @return array Array of informations * If no fast mode: @@ -989,7 +989,7 @@ function dol_getdate($timestamp,$fast=false) * @param int $year Year * @param int $gm 1=Input informations are GMT values, otherwise local to server TZ * @param int $check 0=No check on parameters (Can use day 32, etc...) - * @return timestamp Date as a timestamp, '' if error + * @return int Date as a timestamp, '' if error * @see dol_print_date, dol_stringtotime, dol_getdate */ function dol_mktime($hour,$minute,$second,$month,$day,$year,$gm=false,$check=1) @@ -1048,7 +1048,7 @@ function dol_mktime($hour,$minute,$second,$month,$day,$year,$gm=false,$check=1) * 'tzserver' => we add the PHP server timezone * 'tzref' => we add the company timezone * 'tzuser' => we add the user timezone - * @return timestamp $date Timestamp + * @return int $date Timestamp */ function dol_now($mode='gmt') {