DokuWiki

Cette page est en lecture seule. Vous pouvez afficher le texte source, mais ne pourrez pas le modifier. Contactez votre administrateur si vous pensez qu'il s'agit d'une erreur.

<= [[fr:plugin:struct|Extension Struct]]

====== Extension Struct : API à distance ======

L'extension struct offre plusieurs méthodes d'accès via l'API [[devel:xmlrpc|XML-RPC]]. Vous pouvez trouver le code actuel dans [[https://github.com/cosmocode/dokuwiki-plugin-struct/blob/master/remote.php|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//
    - paramètre : **chaîne** //La page pour laquelle obtenir des données//
    - paramètre : **chaîne** //Le schéma à utiliser, vide pour tous//
    - 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.
    - paramètre : **chaîne** //page//
    - paramètre : **tableau** ''('schema' => ( 'fieldlabel' => 'value', ...))''
    - 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
    - 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//
    - paramètre : **tableau** //tableau de chaînes avec le(s) nom(s) des schémas//
    - paramètre : **tableau** //tableau de chaînes avec les colonnes//
    - paramètre : **tableau** //tableau de tableaux avec// ''['logique'=> 'and'|'or', 'condition' => 'votre condition']''
    - 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//

DokuWiki

Outils pour utilisateurs

Outils du site

Outils de la page

Global DokuWiki Links