Accueil > Documentation incomplète > Les plugins développés pour MédiaSPIP > XMLRPC : une API xml-rpc pour SPIP > Les méthodes xmlrpc SPIP

Les méthodes xmlrpc SPIP

spip.lire_objet

Méthode générique

Liste le contenu d’un objet (article, mot, auteur ...).

Si l’objet a une méthode spécifique définie (ex : spip.lire_article ou spip.lire_auteur), on utilise cette méthode, sinon on utilise le crud de l’objet et on retourne ce qu’il renvoit.

Paramètres

  • login string
  • pass string
  • id_objet int (Obligatoire)
  • objet string (Obligatoire)

Retour

Aléatoire en fonction de l’objet

spip.lire_article

Liste le contenu d’un article.

Sans identification (login/pass) :

  • retourne les informations de l’article s’il est publié ;
  • si l’article n’est pas publié, renvoie une erreur ;

Si on est identifié :

  • si on peut modifier l’article et qu’il n’est pas publié, on retourne ses données ;
  • si on peut modifier ses données, on ajoute dans l’array de retour un élément "modifiable" à true ;

Paramètres

  • login string
  • pass string
  • id_article int (Obligatoire)

Retour

Un array des informations de l’article avec tous ses champs dans la base, plus son url publique si publié, plus son logo, ainsi qu’un élément "modifiable", booléen (true/false).

  • struct
    • int id_article : identifiant numérique de l’article ;
    • string : champ_base : chaque champ de la table de l’objet article ;
    • ... (autres champs de la base)
    • string url : l’URL publique de l’article si publié ;
    • string logo : l’url du logo de l’article si disponible ;
    • bool modifiable : true/false, l’article est il modifiable ;

spip.lire_auteur

Liste le contenu d’un auteur.

Sans identification (login/pass) :

  • retourne les informations de l’auteur sans certaines informations ;

Si on est identifié :

  • retourne les infos complêtes de l’auteur ;
  • si on peut modifier ses données, on ajoute dans l’array de retour un élément "modifiable" à true ;

Paramètres

  • login string
  • pass string
  • id_auteur int (Obligatoire)

Retour

Un array des informations de l’auteur avec tous ses champs dans la base sauf celles sensibles et celles personnelles si on ne peut le modifier, plus son url publique, plus son logo, ainsi qu’un élément "modifiable", booléen (true/false).

  • struct
    • int id_auteur
    • string champ_base
    • ... (autres champs de la base)
    • string url (l’URL publique)
    • logo (le logo si disponible)
    • bool modifiable (true/false)

spip.lire_mot

Liste le contenu d’un mot.

Paramètres

  • login string
  • pass string
  • id_mot int (Obligatoire)

Retour

Un array des informations du mot avec tous ses champs dans la base plus son url publique, plus son logo, ainsi qu’un élément "modifiable", booléen (true/false).

  • struct
    • int id_mot
    • string champ de la base
    • ... (autres champs de la base)
    • string url (l’URL publique)
    • logo (le logo si disponible)
    • bool modifiable (true/false)

spip.lire_rubrique

Liste le contenu d’une rubrique.

Sans identification (login/pass) :

  • retourne les informations de la rubrique si elle est publiée ;
  • retourne les informations de la rubrique si elle n’est publiée mais que l’argument tout vaut oui ;
  • si la rubrique n’est pas publiée, renvoie une erreur ;

Si on est identifié :

  • si on peut créer un article dans la rubrique et qu’elle n’est pas publiée, on retourne ses données ;
  • si on peut modifier ses données, on ajoute dans l’array de retour un élément "modifiable" à true ;

Paramètres

  • login string
  • pass string
  • id_rubrique int (Obligatoire)
  • tout string "oui"

Retour

Un array des informations de la rubrique avec tous ses champs dans la base, plus son url publique si publiée, plus son logo, ainsi qu’un élément "modifiable", booléen (true/false).

  • struct
    • int id_rubrique
    • string champ_base
    • ... (autres champs de la base)
    • string url (l’URL publique)
    • logo (le logo si disponible)
    • bool modifiable (true/false)

spip.liste_articles

Liste les articles.

Sans identification (login/pass) :

  • retourne les articles publiés correspondant aux paramètres ;

Si on est identifié :

  • Si on a un id_auteur dans la requète on liste les articles publiés de l’id_auteur en question ;
  • Sinon on liste l’ensemble des articles de l’auteur logué qu’il soit publiés ou non ;

Paramètres

  • login string
  • pass string
  • id_rubrique int
  • id_secteur int
  • id_rubrique int
  • tri array
  • limite string

Retour

Un array des articles avec tous leur champs dans la base, plus leur url publique si publié, plus leur logo.

  • array
    • struct
      • int id_article
      • string champ_base
      • ... (autres champs de la base)
      • string url (l’URL publique)
      • logo (le logo si disponible)
    • ...

spip.liste_auteurs

Liste les auteurs.

Sans identification :

  • On affiche la liste des auteurs correspondants aux critères en enlevant certaines informations sensibles (email, login, et les champs htpass et autres) ;

Si on est identifié :

  • Si on a le droit de modifier l’auteur en question, on affiche son mail et son login ;
  • Si on n’a pas le droit de modifier cet auteur, on retourne les mêmes infos que non identifiés ;

Paramètres

  • login string
  • pass string
  • tri array
  • limite string

Retour

Un array des auteurs avec certains des champs dans la base (certains sont enlevés pour raison de sécurité), plus leur url publique, plus leur logo.

  • array
    • struct
      • int id_auteur
      • string champ_base
      • ... (autres champs de la base)
      • string url (l’URL publique)
      • logo (le logo si disponible)
    • ...

spip.liste_mots

Liste les mots clés.

Paramètres

  • id_groupe int
  • tri array
  • limite string

Retour

Un array des articles avec tous leur champs dans la base, plus leur url publique si publié, plus leur logo.

  • array
    • struct
      • int id_article
      • string champ_base
      • ... (autres champs de la base)
      • string url (l’URL publique)
      • logo (le logo si disponible)
    • ...

spip.liste_rubriques

Liste les rubriques.

Sans identification (login/pass) :

  • retourne les rubriques publiées correspondant aux paramètres ;
  • si on a l’argument tout valant oui, retourne l’ensemble des rubriques ;

Si on est identifié :

  • retourne la liste des rubriques non publiées dans lesquelles on peut créer des articles ;

Paramètres

  • login string
  • pass string
  • id_parent int
  • id_secteur int
  • tri array
  • limite string
  • tout tring "oui"

Retour

Un array des rubriques avec tous leur champs dans la base, plus leur url publique si publiée, plus leur logo.

  • array
    • struct
      • int id_rubrique
      • string champ_base
      • ... (autres champs de la base)
      • string url (l’URL publique)
      • logo (le logo si disponible)
    • ...
  • Auteur :
  • Publié le :
  • Mis à jour : 20/03/14
  • Révisé par : 1 anonyme

Aucun commentaire

Commentez la documentation

Qui êtes-vous ?

Pour afficher votre trombine avec votre message, enregistrez-la d’abord sur gravatar.com (gratuit et indolore) et n’oubliez pas d’indiquer votre adresse e-mail ici.

Ajoutez votre commentaire ici

Ce champ accepte les raccourcis SPIP {{gras}} {italique} -*liste [texte->url] <quote> <code> et le code HTML <q> <del> <ins>. Pour créer des paragraphes, laissez simplement des lignes vides.

Ajouter un document

Navigation

Mots-clés