Description

Ce plugin permet de récupérer un certain nombre d'éléments du blog, par exemple par le biais de requêtes Ajax. Ne vous étonnez donc pas si vous ne voyez rien de nouveau en installant le plugin, puisqu'il ne fait rien coté administration, et rien coté public.

Enfin presque, il se contente d'enregistrer une nouvelle url au blog, accessible via http://urldublog/rest/

Téléchargement

L'archive du plugin est disponible ici : dotAjax-1.0.zip

Utilisation

Le plugin récupère un certain nombre de paramètres dans l'URL passée (en GET et/ou en POST), les transmet au service adéquat, puis retourne un résultat au format JSON, donc directement exploitable en Javascript.

Requêtes

L'url de requêtage est de la forme suivante :

  • En path_info : http://urldublog/rest/<service>?f=<fonction>&param1=valeur1&param2=valeur2&...
  • En query_string : http://urldublog/?rest/<service>&f=<fonction>&param1=valeur1&param2=valeur2&...

où :

  • <service> est le service à appeler (seul le service "blog" est proposé par défaut, mais des plugins peuvent enregistrer leur propre service)
  • <fonction> est la fonction du service à appeler
  • param1 est le premier paramètre, param2 le second, ...

Petit exemple pour situer le contexte : pour récupérer tous les billets publiés en 2008 par toto, il suffit d'aller sur : http://urldublog/rest/blog?f=getPosts&post_year=2008&user_id=toto

Réponse

Le service renverra systématiquement un objet JSON de la forme :

{ "status": "ok", "data": [...] }

où status indique l'état du traitement, et data contient les informations demandées par la requête (un tableau s'il plusieurs entrées peuvent être retournées, une valeur sinon).

En cas d'erreur, l'objet retourné sera de la forme :

{ "status": "failed", "message": "error message" }

Extension

Le plugin a été prévu pour être étendu par d'autres plugins. Il fournit par défaut uniquement des méthodes sur le blog, mais peut être étendu assez simplement. Une page dédiée décrira bientôt comment enregistrer ses propres services au plugin. Pour les impatients, il suffit de regarder la tête du fichier class.blogrest.php du plugin, qui définit le service blog.

Services

TODO

  • Ajout du support des métadonnées
  • Ajout du support des galeries
  • Ajout du support des sous-catégories (actif partiellement aujourd'hui et bridé pour rester compatible avec la version actuelle de dotclear2, sera rendu pleinement fonctionnel après la sortie de la 2.1)
  • Envoi de commentaires