Package Queue

Fichiers du package

FichierDescription
purger_queue.php

Gestion de l'action de purge des travaux en attente

queue.php

Gestion des queues de travaux

Proposer une amélioration

Liste des constantes

Valeur

  • true

Package

Valeur

  • 200

Package

Valeur

  • min($max_time, 15)

Package

Valeur

Package

Valeur

  • 1

Package

Liste des fonctions

Les tâches sont ensuites exécutées par date programmée croissant/priorité décroissante

integer queue_add_job( $function , $description , $arguments = array() , $file = '' , $no_duplicate = false , $time , $priority )

Paramètres

  1. $function

    The function name to call.

  2. $description

    A human-readable description of the queued job.

  3. $arguments = array()

    Optional array of arguments to pass to the function.

  4. $file = ''

    Optional file path which needs to be included for $fucntion.

  5. $no_duplicate = false

    If TRUE, do not add the job to the queue if one with the same function and arguments already exists. If 'function_only' test of existence is only on function name (for cron job)

  6. $time

    time for starting the job. If 0, job will start as soon as possible

  7. $priority

    -10 (low priority) to +10 (high priority), 0 is the default

Retour

  • integer

    id of job

Utilisé par

Package

Proposer une amélioration

Retourne le HTML à ajouter à la page pour declencher le cron ou rien si on a réussi à le lancer en asynchrone.

Un verrou (cron.lock) empêche l'exécution du cron plus d'une fois par seconde.

string queue_affichage_cron( )

Retour

  • string

Utilisé par

Package

Proposer une amélioration
  • le reprogrammer si c'est un cron
  • supprimer ses liens
  • le detruire en dernier
void queue_close_job( array & $row , integer $time , integer $result )

Paramètres

  1. array & $row
  2. integer $time
  3. integer $result

Utilisé par

Package

Proposer une amélioration
boolean | integer queue_is_cron_job( string $function , string $inclure )

Paramètres

  1. string $function

    Nom de la fonction de tâche

  2. string $inclure

    Nom de l'inclusion contenant la fonction

Retour

  • boolean | integer

    Périodicité de la tâche en secondes, si tâche périodique, sinon false.

Utilisé par

Package

Proposer une amélioration
boolean queue_remove_job( integer $id_job )

Paramètres

  1. integer $id_job

    id de la tache a retirer

Retour

  • boolean

Package

Proposer une amélioration

Prend une par une les tâches en attente et les lance, dans la limite d'un temps disponible total et d'un nombre maxi de tâches

La date de la prochaine tâche à exécuter est mise à jour après chaque chaque tâche finie afin de relancer le scheduler uniquement quand c'est nécessaire

null | boolean queue_schedule( array $force_jobs = null )

Paramètres

  1. array $force_jobs = null

    list of id_job to execute when provided

Retour

  • null | boolean
    • null : pas de tâche à réaliser maintenant
    • false : pas de connexion SQL
    • true : une planification a été faite.

Utilisé par

Package

Proposer une amélioration
void queue_set_next_job_time( integer $next )

Paramètres

  1. integer $next

Package

Proposer une amélioration
mixed queue_start_job( array $row )

Paramètres

  1. array $row

    describe the job, with field of table spip_jobs

Retour

  • mixed

    return the result of job

Utilisé par

Package

Proposer une amélioration