An Ajax API - Manuel

Attributs et fonctions du framework Anaa.

Attributs

AACaching

AACaching: Booléen

L'attribut prend la valeur true is la mise en cache est permise, ou false, si elle ne l'est pas.
On devrait le laisser sur false, sauf pour les fichiers qui sont rarement modifiée. Désactiver le cache réduit les performances sur de gros fichiers, mais l'activer peut avoir des résultats intattendus.

Fonctions

AACreate

Celle fonction est appelée par les autres pour créer un objet XMLHttpRequest.

Interface:

function AACreate()

Argument: Aucun.
Retour: Un objet XMLHttpRequest.

AARead

Appelée pour lire un document.
Le type de document est déterminé par son extension. Toute extension qui se termine par "ml" (xml, xhtml, etc...) doit être dans un format compatible XML. Les autres extensions sont supposées dénoter des fichiers de texte.
Un fichier JSON doit avoir une extension json ou js et est un fichier de texte.

Interface:

function AARead(url, callback, élément)

Arguments:

url: Le fichier à charger.
callback: La fonction à appeler une fois le fichier chargé. Elle a deux arguments, les données et la référence à une balise de la page pour le stockage.
element: Un élément de la page courante.

Retour: Rien.

AALoadXML

Charger un fichier XML avec toute extension.

Interface:

function AALoadXML(url, callback, élément)

Arguments

url: Un fichier XML, avec n'importe quelle extension.
callback: Nom d'une fonction qui sera appelée dans la fonction AALoadXML. Celle-ci a deux arguments, un document XML et la référence à l'élément pour le stockage.
element: La référence à l'élément donné en argument à la fonction callback.

Retour: Rien.

AALoadHTML

Charge le contenu d'une page HTML dans une variable ou une balise dans la page actuellement affichée. Cela permet d'accéder au contenu d'une autre page par les méthodes du Document Object Model.
Avant d'appeler la fonction, vous devez déclarer une variable ou créer une balise pour stocker le contenu.
Elle appelle elle-même une fonction définie par l'utilisateur et passé en argument, qui traite le corps de la page HTML chargée.
L'argument param peut être l'identifieur d'une balise div où stocker les données extraites.
Voyez les démos pour plus de détails sur l'utilisation de cette fonction.

Interface:

function AALoadHTML(url, callback, id, param)

Arguments:

url: Une page HTML.
callback: Une fonction avec deux arguments, l'élément utilisé pour le stockage (et non l'id), et un paramètre.
id: L'identifieur d'une balise, généralement une <div> pour stocker le contenu de la page chargée.
param: Une chaîne, ce peut être l' id d'une balise div où placer les données à afficher.

Retour:

Rien.

AAWrite

Appelée pour envoyer des données à un script sur le serveur.

Interface:

function AAWrite(url, données [, fonction] )

Arguments:

url: Le script à exécuter avec les paramètres qu'on lui envoie.
data: Une chaîne de paramètres sous la forme : x = y, séparés par &.
fonction: Optionnel, nom d'une fonction callback.
La fonction doit avoir un unique argument. Anaa l'assigne avec responseText, la variable XHR.

Retour: Rien.

AAHead

Lit l'en-tête d'un fichier.

Interface

function AAHead(url, clé, fonction, élément)

Argument

url: Un fichier sur le serveur.
key: Un clé de données d'en-tête, comme "server", etc.
function: Une fonction callback.
element: Balise pour stocker les résultats de la fonction.

Retour: Rien

AAGetBody

Extrait le contenu de la balise body tag dans une page web lue et transcrite sous forme de chaîne de caractères par l'objet XHR.

Interface:

function AAGetBody(contenu)

Argument:

contenu: Une chaîne, le contenu de responseText une fois chargé.

Retour: Une chaîne de caractères, la partie de la page dans la balise body.

Licence

Gratuit, open source sous licence GPL 2.0.
Vous pouvez librement utiliser cette librairie, l'étendre si besoin, mais sans supprimer le notice de copyright notice.