4.3.3 Client::getInfo

Récupérer les informations sur une tâche de transformation.

4.3.3.1 Description

string getInfo ( string $tid,
                  array & $info )

Une fois la tâche soumise (à l'aide de [sendTransformation()][Client::sendTransformation]), le client peut interroger régulièrement (ou dans le code exécuté par le callback du serveur TE) la tâche à partir de sontid` pour voir si elle est terminée (ou en attente, ou en échec, etc.).

4.3.3.1.1 Avertissements

4.3.3.2 Liste des paramètres

(string) tid: Identifiant de la tâche dont on souhaite obtenir les informations.
[out] (array) info: Informations retournées de la tâche.

4.3.3.3 Valeur de retour

La méthode getInfo() retourne une chaîne non vide, contenant le message d'erreur, si la demande d'information a échoué, ou une chaîne vide si la demande d'information est réussie.

Si la demande d'information est réussie, la variable $info contient les informations de la tâche.

Les propriétés de $info peuvent être :

array(
    'tid'        => (string) $taskId,
    'infile'     => (string) $inputFile,
    'inmime'     => (string) $inputFileMimeType,
    'outfile'    => (string) $outputFile,
    'engine'     => (string) $transformationName,
    'status'     => (string) $status,
    'callback'   => (string) $clientCallbackURL,
    'callreturn' => (string) $callbackReturn,
    'fkey'       => (string) $clientForeignKey,
    'pid'        => (string) $transformationPID,
    'comment'    => (string) $transformationComment
)

tid

Identifiant de la tâche.

infile

Chemin d'accès (sur le serveur) du fichier à transformer.

inmime

Type MIME du fichier à transformer.

outfile

Chemin du fichier résultat de la transformation.

engine

Moteur de transformation demandé par le client.

status

Status de la tâche (voir Cycle de traitement des demandes).

Liste des constantes de statut de tâche :

\Dcp\TransformationEngine\Client::TASK_STATE_BEGINNING (B): Demande de conversion reçue.
\Dcp\TransformationEngine\Client::TASK_STATE_TRANSFERRING (`T): Lecture/transfert du fichier à convertir.
\Dcp\TransformationEngine\Client::TASK_STATE_ERROR (K): Erreur.
\Dcp\TransformationEngine\Client::TASK_STATE_SUCCESS (D): Transformation réussie.
\Dcp\TransformationEngine\Client::TASK_STATE_PROCESSING (P): En cours de traitement.
\Dcp\TransformationEngine\Client::TASK_STATE_WAITING (W): Attente de traitement par le moteur.
\Dcp\TransformationEngine\Client::TASK_STATE_INTERRUPTED (I): Interrompue.

callback

URL de callback fournie par le client.

callreturn

Message retourné par l'appel à l'URL de callback.

fkey

Clef fkey soumise par le client lors de la demande de transformation.

pid

Le PID du processus de transformation lorsque celui-ci tourne.

comment

Dernier message de la tâche.

4.3.3.4 Erreurs / Exceptions

La méthode retourne une chaîne non vide contenant le message d'erreur si les informations de la tâche n'ont pu être récupérées.

4.3.3.5 Historique

4.3.3.6 Exemples

$tid = '54c8a79a4780d2.85897641';
$info = array();
$err = $te->getInfo(
    $tid, /* Identifiant de la tâche qu'on souhaite interroger */
    $info
);
if ($err != '') {
    throw new Exception(sprintf("getInfo() returned with error: %s", $err));
}
var_export($info);

array (
  'tid' => "54c8a79a4780d2.85897641",
  'infile' => "/var/tmp/tes-6FDTUK.txt",
  'inmime' => "text/plain;",
  'outfile' => "/var/tmp/ter-xbpYHM.pdf",
  'engine' => "pdf",
  'status' => "D",
  'callback' => "",
  'callreturn' => "",
  'fkey' => "",
  'pid' => "15678",
  'comment' => "generated by [/opt/te/lib/engines/txt2pdf] command; "
)

4.3.3.7 Notes

4.3.3.8 Voir aussi

Source : programmation/class_TransformationEngine_Client/getInfo.md Dynacase Platform 3.2 | Tranformation Engine Installation et exploitation, version 1.4 édition 4, © Anakeen Labs <labs@anakeen.com>