Skip to content

$cal.diff

Description

Calcule l'écart entre deux dates, heures ou timestamps. La méthode retourne le résultat de la différence ref2 - ref1.

Syntaxe

$cal.diff( ref1 , ref2 [ , unit ] )

Paramètres

ref1 date / time / timestamp
Date/heure/timestamp de début de la période/durée à calculer
ref2 date / time / timestamp
Date/heure/timestamp de fin de la période/durée à calculer. Si ref2 est supérieur à ref1, la méthode retournera une valeur positive.
unit string

Unité de amount. Les unités reconnues sont:

  • y ou year
  • m ou month
  • d ou day
  • h ou hour
  • min ou minute
  • s, sec ou second
  • ms ou millisecond
  • microsecond
  • n ou nanosecond

Si l'unité n'est pas spécifiée, la méthode retourne la durée selon le format ISO-8601 (p.ex PT27.03S pour désigner une période de 27.03 secondes)

Retour

Valeur entière représentant le nombre d'unités qui séparent les deux dates/heures/timestamps.

Exemple

1
$cal.diff( $cal.date("2023-01-01"), $cal.date("2023-12-31"), "d" );