Déclarer une tâche

Pour déclarer une tâche, il faut indiquer son nom et sa périodicité en secondes via le pipeline taches_generales_cron :

  1. function monplugin_taches_generales_cron($taches){
  2. $taches['nom'] = 24*3600; // tous les jours
  3. return $taches;
  4. }

Télécharger

Cette tâche sera appelée au moment venu. Les traitements sont placés dans un fichier du répertoire genie/, homonyme à la tâche (nom.php) et disposant d’une fonction genie_nom_dist().

La fonction reçoit en argument la date à laquelle s’est réalisé le dernier traitement de cette tâche. Elle doit retourner un nombre :

  • nul, si la tâche n’a rien à faire
  • positif, si la tâche a été traitée
  • négatif, si la tâche a commencé, mais doit se poursuivre. Cela permet d’effectuer des tâches par lots (pour éviter des timeout sur les exécutions des scripts PHP à cause de traitements trop longs). Dans ce cas là, le nombre négatif indiqué correspond au nombre de secondes d’intervalle pour la prochaine exécution.

Exemple

Cet exemple est simple, issu des tâches de « maintenance » de SPIP, dans le fichier genie/maintenance.php, puisqu’il exécute des fonctions et renvoie toujours 1, indiquant que l’action a été réalisée.

  1. // Diverses taches de maintenance
  2. function genie_maintenance_dist ($t) {
  3.  
  4. // (re)mettre .htaccess avec deny from all
  5. // dans les deux repertoires dits inaccessibles par http
  6. include_spip('inc/acces');
  7. verifier_htaccess(_DIR_ETC);
  8. verifier_htaccess(_DIR_TMP);
  9.  
  10. // Verifier qu'aucune table n'est crashee
  11. if (!_request('reinstall'))
  12. verifier_crash_tables();
  13.  
  14. return 1;
  15. }

Télécharger

Auteur Matthieu Marcillaud Publié le : Mis à jour : 08/02/10

Traductions : English, français