Documentation de KeetagCaller version 1

KeetagCaller est la librairie qui vous permet d'intégrer rapidement le convertisseur à votre site. En savoir plus...

Cette version de la librairie (v1) est obsolète. L'utilisation de KeetagCaller version 2 est recommandée.

Sommaire

Les méthodes publiques :

• convert_text() [enrichi dans la V2]
• set_option()
• set_keetag_api_url() [remplacé par set_root_url() dans la V2]
• set_output_format()

Les méthodes privées :

• get_keetag_api_output() [remplacé par get_api_output() dans la V2]
• change_json_format()
• emergency_output_on_failure()

---

convert_text()

La méthode convert_text() est la plus importante car c'est elle qui vous permet de convertir votre texte. Dans la version 1 de la librairie, elle prend obligatoirement 3 paramètres :

$keetag->convert_text($text_to_convert, $orig_language_id, $destin_language_id);

1. $text_to_convert = le texte que vous voulez convertir.
2. $orig_language_id = le numéro d'identifiant du langage dans le lequel est balisé votre texte. Vous trouverez cet identifiant dans la liste des langages pris en charge.
3. $destin_language_id = le numéro d'identifiant du langage vers lequel vous voulez convertir votre texte.

Par exemple, pour convertir en HTML (ID #1 d'après la liste des langages pris en charge) ce texte qui contient des balises BBcode (ID #2 d'après la liste) :

$keetag->convert_text("Du [b]gras[/b].", 2, 1);

La version 2 de la librairie permet de passer moins de trois paramètres. Voir convert_text() dans la version 2.

---

set_option()

La méthode set_option() vous permet de définir les paramètres de conversion. Par exemple :

// Indique le langage d'origine
$keetag->set_option('orig_language_id', 1);
// Indique le langage d'arrivée
$keetag->set_option('destin_language_id', 3);
// Définit le texte à convertir
$keetag->set_option('text_to_convert', 'This is <strong>bold</strong> text.');
// Indique que les balises non reconnues devront être supprimées
$keetag->set_option('remove_unknown_tags', TRUE);

// Convertit le texte en appliquant tous les paramètres définis par set_option()
$keetag->convert_text();

Pour connaître tous les paramètres disponibles, consultez la liste des paramètres d'appel l'API de conversion.

Remarque : dans la version 2 de la librairie, le langage de départ, celui d'arrivée et le texte à convertir peuvent être passés directement en paramètres de la méthode convert_text(), sans utiliser set_option(). Voir la documentation de la méthode convert_text() V2.

---

set_output_format()

La méthode set_output_format($format) vous permet de choisir sous quelle forme vous pourrez manipuler les données retournées par l'API. Trois paramètres sont possibles :

• "array" : les données seront retournées sous forme d'un array.
• "object" : les données seront retournées sous formes d'un objet POO.
• "json" : le flux sera retourné sous forme de JSON brut (autrement dit, du texte). Cela est utile pour visualiser le flux lorsque vous développez votre site ou application.
• Par défaut, si aucun paramètre n'est précisé, il vaudra "json".

Ces exemples montrent la différence de syntaxe selon le paramètre choisi :

$keetag->set_output_format('array');
$result = $keetag->convert_text();
// On utilise la syntaxe d'un array pour accéder aux données
echo $result['converted_text'];

$keetag->set_output_format('object');
$result = $keetag->convert_text();
// Ici on utilise la syntaxe de la POO
echo $result->converted_text;

$keetag->set_output_format('json');
$result = $keetag->convert_text();
// Ceci va afficher le résultat JSON tel quel, sous forme de texte 
echo $result;

---