4.3.6 Client::purgeTransformation

4.3.6.1 Description

string purgeTransformation ( string $tid, )

Les fichiers d'entrée et de sortie liés à la tâche sont supprimés ainsi que la référence à la tâche.

4.3.6.1.1 Avertissements

La suppression ne vérifie pas si la tâche est en cours d'exécution. Par conséquent, si la demande est en cours d'exécution il faut au préalable l'interrompre (voir méthode abortTransformation()).

4.3.6.2 Liste des paramètres

(string) tid

Identifiant de la tâche qu'on souhaite supprimer.

4.3.6.3 Valeur de retour

La méthode getTransformation() retourne une chaîne non vide, contenant le message d'erreur, si l'opération n'a pu être réalisée, ou une chaîne vide si l'opération est réussie.

4.3.6.4 Erreurs / Exceptions

La méthode retourne une chaîne non vide contenant le message d'erreur si l'opération n'a pu être réalisée.

4.3.6.5 Historique

Aucun.

4.3.6.6 Exemples

$tid = '54c8a79a4780d2.85897641';
$err = $te->getInfo($tid, $info);
if ($info['status'] == \Dcp\TransformationEngine\Client::TASK_STATE_PROCESSING) {
    throw new Exception("La transformation est en cours d'exécution. Veuillez d'abord l'interrompre.");
}
$err = $te->purgeTransformation($tid)
if ($err != '') {
    throw new Exception(sprintf("Erreur lors de la suppression de la transformation '%s': %s", $tid, $err));
}

4.3.6.7 Notes

Aucune.

4.3.6.8 Voir aussi

• getInfo()
• abortTransformation()