DokuWiki

It's better when it's simple

Outils pour utilisateurs

Outils du site


Panneau latéral

Traductions de cette page?:

Découvrir DokuWiki

Options avancées

Pour les entreprises

Notre Communautée


Suivez-nous sur Facebook, Twitter et les autres résaux sociaux.

Notre politique de confidentialité

fr:plugin:struct:remote_api

Extension Struct

Extension Struct : API à distance

L'extension struct offre plusieurs méthodes d'accès via l'API XML-RPC. Vous pouvez trouver le code actuel dans remote.php

Note: les noms de méthode sont préfixés avec plugin.struct., par exemple plugin.struct.getSchema

Méthodes

  • getData() Obtenir les données structurées pour une page donnée
    1. paramètre : chaîne La page pour laquelle obtenir des données
    2. paramètre : chaîne Le schéma à utiliser, vide pour tous
    3. paramètre : entier Un horodatage si vous souhaitez obtenir l'historique des données (0 pour maintenant)
    • retourne : tableau ('schema' ⇒ ( 'fieldlabel' ⇒ 'value', …))
  • saveData() Sauvegarde les données pour une page donnée (crée une nouvelle révision)
    Si cet appel réussit, vous pouvez supposer que vos données ont été enregistrées ou qu'il n'était pas nécessaire de l'enregistrer car les données existent déjà dans la forme souhaitée ou encore que les schémas donnés ne sont plus affectés à cette page.
    1. paramètre : chaîne page
    2. paramètre : tableau ('schema' ⇒ ( 'fieldlabel' ⇒ 'value', …))
    3. paramètre : chaîne résumé
    • retourne : booléen retourne toujours vrai
  • getSchema() Obtenir des infos concernant les colonnes de schémas
    Ne retourne seulement que les colonnes actuelles activées
    1. paramètre : chaîne le schéma à interroger, vide pour tous
    • retourne :tableau
  • getAggregationData() Obtenir les données qui seront affichés dans une aggrégation
    1. paramètre : tableau tableau de chaînes avec le(s) nom(s) des schémas
    2. paramètre : tableau tableau de chaînes avec les colonnes
    3. paramètre : tableau tableau de tableaux avec ['logique'⇒ 'and'|'or', 'condition' ⇒ 'votre condition']
    4. paramètre : chaîne chaîne indiquant la colonne à trier par
    • retourne : tableau tableau de lignes, chaque ligne étant un tableau de valeurs de colonnes
fr/plugin/struct/remote_api.txt · Dernière modification: 2019-01-02 19:19 par Digitalin