This document is for a version of CakePHP that is no longer supported. Please upgrade to a newer release!

Page Contents

TimeHelper

class TimeHelper(View $view, array $settings = array())

Le Helper Time vous permet, comme il l’indique de gagner du temps. Il permet le traitement rapide des informations se rapportant au temps. Le Helper Time a deux tâches principales qu’il peut accomplir:

  1. Il peut formater les chaînes de temps.

  2. Il peut tester le temps (mais ne peut pas le courber, désolé).

Modifié dans la version 2.1: TimeHelper a été reconstruit dans la classe CakeTime pour faciliter l’utilisation en-dehors de la couche View. Dans une vue, ces méthodes sont accessibles via la classe TimeHelper et vous pouvez l’appeler comme vous appelleriez une méthode normale de helper: $this->Time->method($args);.

Utiliser le Helper

Une utilisation courante de Time Helper est de compenser la date et le time pour correspondre au time zone de l’utilisateur. Utilisons un exemple de forum. Votre forum a plusieurs utilisateurs qui peuvent poster des messages depuis n’importe quelle partie du monde. Une façon facile de gérer le temps est de sauvegarder toutes les dates et les times à GMT+0 or UTC. Décommenter la ligne date_default_timezone_set('UTC'); dans app/Config/core.php pour s’assurer que le time zone de votre aplication est défini à GMT+0.

Ensuite, ajoutez un time zone à votre table users et faîtes les modifications nécessaires pour permettre à vos utilisateurs de définir leur time zone. Maintenant que nous connaissons le time zone de l’utilisateur connecté, nous pouvons corriger la date et le temps de nos posts en utilisant le Helper Time:

echo $this->Time->format(
  'F jS, Y h:i A',
  $post['Post']['created'],
  null,
  $user['User']['time_zone']
);
// Affichera August 22nd, 2011 11:53 PM pour un utilisateur dans GMT+0
// August 22nd, 2011 03:53 PM pour un utilisateur dans GMT-8
// et August 23rd, 2011 09:53 AM GMT+10

La plupart des méthodes du Helper Time contiennent un paramètre $timezone. Le paramètre $timezone accepte une chaîne identifiante de timezone valide ou une instance de la classe DateTimeZone.

Formatage

TimeHelper::convert($serverTime, $timezone = NULL)
Type renvoyé:

integer

Convertit étant donné le time (dans le time zone du serveur) vers le time de l’utilisateur, étant donné son/sa sortie de GMT.

// appel via TimeHelper
echo $this->Time->convert(time(), 'Asia/Jakarta');
// 1321038036

// appel avec CakeTime
App::uses('CakeTime', 'Utility');
echo CakeTime::convert(time(), new DateTimeZone('Asia/Jakarta'));

Modifié dans la version 2.2: Le paramètre $timezone remplace le paramètre $userOffset utilisé dans 2.1 et suivants.

TimeHelper::convertSpecifiers($format, $time = NULL)
Type renvoyé:

string

Convertit une chaîne de caractères représentant le format pour la fonction strftime et retourne un format Windows safe et i18n aware.

TimeHelper::dayAsSql($dateString, $field_name, $timezone = NULL)
Type renvoyé:

string

Crée une chaîne de caractères dans le même format que dayAsSql mais nécessite seulement un unique objet date:

// Appelé avec TimeHelper
echo $this->Time->dayAsSql('Aug 22, 2011', 'modified');
// (modified >= '2011-08-22 00:00:00') AND
// (modified <= '2011-08-22 23:59:59')

// Appelé avec CakeTime
App::uses('CakeTime', 'Utility');
echo CakeTime::dayAsSql('Aug 22, 2011', 'modified');

Modifié dans la version 2.2: Le paramètre $timezone remplace le paramètre $userOffset utilisé dans 2.1 et suivants.

Nouveau dans la version 2.2: Le paramètre $dateString accepte aussi maintenant un objet DateTime.

TimeHelper::daysAsSql($begin, $end, $fieldName, $userOffset = NULL)
Type renvoyé:

string

Retourne une chaîne de caractères dans le format « ($field_name >= “2008-01-21 00:00:00”) AND ($field_name <= “2008-01-25 23:59:59”) ». C’est pratique si vous avez besoin de chercher des enregistrements entre deux dates incluses:

// Appelé avec TimeHelper
echo $this->Time->daysAsSql('Aug 22, 2011', 'Aug 25, 2011', 'created');
// (created >= '2011-08-22 00:00:00') AND
// (created <= '2011-08-25 23:59:59')

// Appelé avec CakeTime
App::uses('CakeTime', 'Utility');
echo CakeTime::daysAsSql('Aug 22, 2011', 'Aug 25, 2011', 'created');

Modifié dans la version 2.2: Le paramètre $timezone remplace $userOffset utilisé dans 2.1 et suivants.

Nouveau dans la version 2.2: Le paramètre $dateString accepte aussi maintenant un objet DateTime.

TimeHelper::format($date, $format = NULL, $default = false, $timezone = NULL)
Type renvoyé:

string

Va retourner une chaîne formatée avec le format donné en utilisant les options de formatage de la fonction PHP strftime():

// appel via TimeHelper
echo $this->Time->format('2011-08-22 11:53:00', '%B %e, %Y %H:%M %p');
// August 22nd, 2011 11:53 AM

echo $this->Time->format('%r', '+2 days');
// 2 days from now formatted as Sun, 13 Nov 2011 03:36:10 AM EET

// appel avec CakeTime
App::uses('CakeTime', 'Utility');
echo CakeTime::format('2011-08-22 11:53:00', '%B %e, %Y %H:%M %p');
echo CakeTime::format('+2 days', '%c');

Vous pouvez aussi fournir la date/time en premier argument. En faisant cela vous devrez utiliser le format strftime compatible. Cette signature d’appel vous permet de tirer parti du format de date de la locale ce qui n’est pas possible en utilisant le format de date() compatible:

// appel avec TimeHelper
echo $this->Time->format('2012-01-13', '%d-%m-%Y', 'invalid');

// appel avec CakeTime
App::uses('CakeTime', 'Utility');
echo CakeTime::format('2011-08-22', '%d-%m-%Y');

Modifié dans la version 2.2: Les paramètres $format et $date sont en ordre opposé par rapport à ce qui se faisait dans 2.1 et suivants. Le paramètre $timezone remplace le paramètre $userOffset utilisé dans 2.1 et suivants. Le paramètre $default remplace le paramètre $invalid utilisé dans 2.1 et suivants.

Nouveau dans la version 2.2: Le paramètre $date accepte aussi maintenant un objet DateTime.

TimeHelper::fromString($dateString, $timezone = NULL)
Type renvoyé:

string

Prend une chaîne et utilise strtotime pour la convertir en une date integer:

// Appelé avec TimeHelper
echo $this->Time->fromString('Aug 22, 2011');
// 1313971200

echo $this->Time->fromString('+1 days');
// 1321074066 (+1 day from current date)

// Appelé avec CakeTime
App::uses('CakeTime', 'Utility');
echo CakeTime::fromString('Aug 22, 2011');
echo CakeTime::fromString('+1 days');

Modifié dans la version 2.2: Le paramètre $timezone remplace le paramètre $userOffset utilisé dans 2.1 et suivants.

Nouveau dans la version 2.2: Le paramètre $dateString accepte aussi maintenant un objet DateTime.

TimeHelper::gmt($dateString = NULL)
Type renvoyé:

integer

Va retourner la date en un nombre défini sur Greenwich Mean Time (GMT).

// Appelé avec TimeHelper
echo $this->Time->gmt('Aug 22, 2011');
// 1313971200

// Appelé avec CakeTime
App::uses('CakeTime', 'Utility');
echo CakeTime::gmt('Aug 22, 2011');
TimeHelper::i18nFormat($date, $format = NULL, $invalid = false, $timezone = NULL)
Type renvoyé:

string

Retourne une chaîne de date formatée, étant donné soit un timestamp UNIX soit une chaîne de date valide strtotime(). Il prend en compte le format de la date par défaut pour le langage courant si un fichier LC_TIME est utilisé. Pour plus d’infos sur le fichier LC_TIME, allez voir ici

Modifié dans la version 2.2: Le paramètre $timezone remplace le paramètre $userOffset utilisé dans 2.1 et suivants.

TimeHelper::nice($dateString = NULL, $timezone = NULL, $format = null)
Type renvoyé:

string

Prend une chaîne de date et la sort au format « Tue, Jan 1st 2008, 19:25 » ou avec le param optionnel $format:

// Appelé avec TimeHelper
echo $this->Time->nice('2011-08-22 11:53:00');
// Mon, Aug 22nd 2011, 11:53

// Appelé avec CakeTime
App::uses('CakeTime', 'Utility');
echo CakeTime::nice('2011-08-22 11:53:00');
TimeHelper::niceShort($dateString = NULL, $timezone = NULL)
Type renvoyé:

string

Prend une chaîne de date et la sort au format « Jan 1st 2008, 19:25 ». Si l’objet date est today, le format sera « Today, 19:25 ». Si l’objet date est yesterday, le format sera « Yesterday, 19:25 »:

// Appelé avec TimeHelper
echo $this->Time->niceShort('2011-08-22 11:53:00');
// Aug 22nd, 11:53

// Appelé avec CakeTime
App::uses('CakeTime', 'Utility');
echo CakeTime::niceShort('2011-08-22 11:53:00');

Modifié dans la version 2.2: Le paramètre $timezone remplace le paramètre $userOffset utilisé dans 2.1 et suivants.

Nouveau dans la version 2.2: Le paramètre $dateString accepte aussi maintenant un objet DateTime.

TimeHelper::serverOffset()
Type renvoyé:

integer

Retourne la valeur du serveur à partir du GMT dans les secondes.

TimeHelper::timeAgoInWords($dateString, $options = array())
Type renvoyé:

string

Prendra une chaîne datetime (tout ce qui est parsable par la fonction strtotime() de PHP ou le format de datetime de MySQL) et la convertit en un format de texte comme, « 3 weeks, 3 days ago »:

// Appelé avec TimeHelper
echo $this->Time->timeAgoInWords('Aug 22, 2011');
// on 22/8/11

// on August 22nd, 2011
echo $this->Time->timeAgoInWords(
    'Aug 22, 2011',
    array('format' => 'F jS, Y')
);

// Appelé avec CakeTime
App::uses('CakeTime', 'Utility');
echo CakeTime::timeAgoInWords('Aug 22, 2011');
echo CakeTime::timeAgoInWords(
    'Aug 22, 2011',
    array('format' => 'F jS, Y')
);

Utilisez l’option “end” pour déterminer le point de cutoff pour ne plus utiliser de mots; par défaut à “+1 month”:

// Appelé avec TimeHelper
echo $this->Time->timeAgoInWords(
    'Aug 22, 2011',
    array('format' => 'F jS, Y', 'end' => '+1 year')
);
// On Nov 10th, 2011 it would display: 2 months, 2 weeks, 6 days ago

// Appelé avec CakeTime
App::uses('CakeTime', 'Utility');
echo CakeTime::timeAgoInWords(
    'Aug 22, 2011',
    array('format' => 'F jS, Y', 'end' => '+1 year')
);

Utilisez l’option “accuracy” pour déterminer la précision de la sortie. Vous pouvez utiliser ceci pour limiter la sortie:

// Si $timestamp est il y a 1 month, 1 week, 5 days et 6 hours
echo CakeTime::timeAgoInWords($timestamp, array(
    'accuracy' => array('month' => 'month'),
    'end' => '1 year'
));
// Sort '1 month ago'

Modifié dans la version 2.2: L’option accuracy a été ajoutée.

Nouveau dans la version 2.2: Le paramètre $dateString accepte aussi maintenant un objet DateTime.

TimeHelper::toAtom($dateString, $timezone = NULL)
Type renvoyé:

string

Va retourner une chaîne de date au format Atom « 2008-01-12T00:00:00Z »

Modifié dans la version 2.2: Le paramètre $timezone remplace le paramètre $userOffset utilisé dans 2.1 et suivants.

Nouveau dans la version 2.2: Le paramètre $dateString accepte aussi maintenant un objet DateTime.

TimeHelper::toQuarter($dateString, $range = false)
Type renvoyé:

mixed

Va retourner 1, 2, 3 ou 4 dépendant du quart de l’année sur lequel la date tombe. Si range est défini à true, un tableau à deux éléments va être retourné avec les dates de début et de fin au format « 2008-03-31 »:

// Appelé avec TimeHelper
echo $this->Time->toQuarter('Aug 22, 2011');
// Afficherait 3

$arr = $this->Time->toQuarter('Aug 22, 2011', true);
/*
Array
(
    [0] => 2011-07-01
    [1] => 2011-09-30
)
*/

// Appelé avec CakeTime
App::uses('CakeTime', 'Utility');
echo CakeTime::toQuarter('Aug 22, 2011');
$arr = CakeTime::toQuarter('Aug 22, 2011', true);

Nouveau dans la version 2.2: Le paramètre $dateString accepte aussi maintenant un objet DateTime.

Nouveau dans la version 2.4: Les nouveaux paramètres d’option relativeString (par défaut à %s ago) et absoluteString (par défaut à on %s) pour permettre la personnalisation de la chaîne de sortie résultante sont maintenant disponibles.

TimeHelper::toRSS($dateString, $timezone = NULL)
Type renvoyé:

string

Va retourner une chaîne de date au format RSS « Sat, 12 Jan 2008 00:00:00 -0500 »

Modifié dans la version 2.2: Le paramètre $timezone remplace le paramètre $userOffset utilisé dans 2.1 et suivants.

Nouveau dans la version 2.2: Le paramètre $dateString accepte aussi maintenant un objet DateTime.

TimeHelper::toUnix($dateString, $timezone = NULL)
Type renvoyé:

integer

Un enrouleur pour fromString.

Modifié dans la version 2.2: Le paramètre $timezone remplace le paramètre $userOffset utilisé dans 2.1 et suivants.

Nouveau dans la version 2.2: Le paramètre $dateString accepte aussi maintenant un objet DateTime.

TimeHelper::toServer($dateString, $timezone = NULL, $format = 'Y-m-d H:i:s')
Type renvoyé:

mixed

Nouveau dans la version 2.2: Retourne une date formatée dans le timezone du serveur.

TimeHelper::timezone($timezone = NULL)
Type renvoyé:

DateTimeZone

Nouveau dans la version 2.2: Retourne un objet timezone à partir d’une chaîne de caractères ou de l’objet timezone de l’utilisateur. Si la fonction est appelée sans paramètres, elle essaie d’obtenir le timezone de la variable de configuration “Config.timezone”.

TimeHelper::listTimezones($filter = null, $country = null, $options = array())
Type renvoyé:

array

Nouveau dans la version 2.2: Retourne une liste des identificateurs de timezone.

Modifié dans la version 2.8: $options accepte maintenant un tableau avec les clés group, abbr, before, et after. Spécifier abbr => true va ajouter l’abréviation de la timezone dans le texte <option>.

Tester Time

TimeHelper::isToday($dateString, $timezone = NULL)
TimeHelper::isThisWeek($dateString, $timezone = NULL)
TimeHelper::isThisMonth($dateString, $timezone = NULL)
TimeHelper::isThisYear($dateString, $timezone = NULL)
TimeHelper::wasYesterday($dateString, $timezone = NULL)
TimeHelper::isTomorrow($dateString, $timezone = NULL)
TimeHelper::isFuture($dateString, $timezone = NULL)

Nouveau dans la version 2.4.

TimeHelper::isPast($dateString, $timezone = NULL)

Nouveau dans la version 2.4.

TimeHelper::wasWithinLast($timeInterval, $dateString, $timezone = NULL)

Modifié dans la version 2.2: Le paramètre $timezone remplace le paramètre $userOffset utilisé dans 2.1 et suivants.

Nouveau dans la version 2.2: Le paramètre $dateString accepte aussi maintenant un objet DateTime.

Toutes les fonctions ci-dessus retourneront true ou false quand une chaîne de date est passé. wasWithinLast prend une option supplémentaire $time_interval:

// Appelé avec TimeHelper
$this->Time->wasWithinLast($time_interval, $dateString);

// Appelé avec CakeTime
App::uses('CakeTime', 'Utility');
CakeTime::wasWithinLast($time_interval, $dateString);

wasWithinLast prend un intervalle de time qui est une chaîne au format « 3 months » et accepte un intervalle de time en secondes, minutes, heures, jours, semaines, mois et années (pluriels ou non). Si un intervalle de time n’est pas reconnu (par exemple, si il y a une faute de frappe) ensuite ce sera par défaut à days.