job_queue_add Ajouter un travail dans la file

SPIP >= 3.0

Description

  1. $id_job = job_queue_add($function, $description, $arguments = array(), $file = '', $no_duplicate = FALSE, $time=0, $priority=0)

Liste des paramètres

  • $function : le nom de la fonction PHP qui doit être appelée
  • $description : une description humainement compréhensible de ce que fait la tache (essentiellement pour l’affichage dans la page de suivi de l’espace privé)
  • $arguments (facultatif, vide par défaut) : les arguments qui seront passés à la fonction, sous forme de tableau PHP
  • $file (facultatif, vide par défaut) : nom du fichier à inclure. Si le nom finit par un / alors on considère que c’est un répertoire et SPIP fera un charger_fonction($function,$file)
  • $no_duplicate (facultatif, false par défaut)
    • si vaut true la tâche ne sera pas ajoutée si elle existe déjà en file d’attente avec la même fonction et les mêmes arguments.
    • si vaut 'function_only' la tâche ne sera pas ajoutée si elle existe déjà en file d’attente avec la même fonction indépendamment de ses arguments
  • $time (facultatif, 0 par défaut) indique la date sous forme de timestamp à laquelle la tâche doit être programmée. Si 0 ou une date passée, la tâche sera exécutée aussitôt que possible (en général en fin hit, en asynchrone).
  • $priority (facultatif, 0 par défaut) indique un niveau de priorité entre -10 et +10. Les tâches sont exécutées par ordre de priorité décroissante, une fois leur date d’exécution passée. La priorité est surtout utilisée quand une tâche cron indique qu’elle n’a pas fini et doit être relancée : dans ce cas SPIP réduit sa priorité pour être sûr que celle tâche ne monopolise pas la file d’attente.

Valeurs de retour

La fonction renvoie le numéro de travail ajouté ou 0 si aucun travail n’a été ajouté.

, par cedric