Blogspx - Spxdatas

Créer un plugin widget pour spxdatas

je-evrard — Fri, 01 Aug 2014 11:34:00 +0200

A partir de la version 1.60 de spxdatas, il est possible de créer des plugins qui viennent s'ajouter dans la partie widget de spxdatas.

C'est un tournant majeur pour spxdatas, avec l'accueil de plugins externes, il n'y a plus de limite à la création de widget !

Nous allons voir ensemble comment créer un plugin widget de A à Z.

Comment créer un plugin widget ?

Un plugin widget est tout d'abord un plugin dans pluxml, il doit donc être déclaré comme tout plugin dans le dossier plugins.

La première chose à faire est une déclaration le fichier de construction du plugin.

[PHP]

public function __construct($default_lang) {

# Appel du constructeur de la classe plxPlugin (obligatoire)

parent::__construct($default_lang);

$this->setParam('spxdatas_widget', '1', 'string');

}

[/PHP]

Le paramètre "spxdatas_widget = 1" va permettre au plugin spxdatas de savoir que votre plugin est un plugin de type widget. C'est la première chose à faire.

Ensuite, il va falloir créer un dossier spxdatas à la racine de votre plugin avec une hierarchie spécifique. Voici a quoi ressemble la structure d'ensemble.

Le dossier icon contient une image qui permettra l'affichage et la personnalisation dans la partie widget.

Le dossier table contient tous les éléments pour définir le widget et "alimenter" en quelque sorte spxdatas.

Dans ce dossier on trouve notamment deux parties :

un fichier table.php correspondant description du widget au format xml en terme de structure
un dossier table_loc contenant les fichiers de traduction du widget

Comment créer l'administration du widget ?

L'administration du widget est crée tout simplement par lecture du fichier se trouvant dans :

monwidgetplugin/spxdatas/table/table.php

Ce fichier table.php contient une description au format xml du widget.

Voici par exemple la description xml du widget spxwpolaroid :

[PHP]<table name="spxwpolaroids" maxparam="2" groupe="spxwpolaroid" tableuserlevel="0,1,2,3,4" rightCMDlevel="0:111,1:111,2:111,3:111,4:111" >

<description><![CDATA[<p>List of polaroid</p>]]></description>

</parameter>

</column>

</table>

<description><![CDATA[<p>Your polaroid</p>]]></description>

</column>

</table>[/PHP]

Comme on peux le voir ic la description du widget est faite en deux parties (2 tables).

table spxwpolaroids : permet d'avoir le titre du polaroid et un lien vers une autre table
table spxwpolaroid : une sous table permet la description du polaroid (titre, image, url...)

Je ne vais pas ici faire un tutoriel sur la construction de la table. Le plugin spxdatas comporte une aide détaillée sur le sujet et de nombreux autres articles viendront enrichir la documentation obscure ou absente.

A noter : la structure du xml est particulière est ne comporte pas de balise encadrant les tables.

Bien sur, il est tout à fait possible de générer ce fichier à partir de la configuration de votre plugin widget. C'est ce que fait spwunslider et spxwpolaroid.

Pourquoi générer le fichier table.php ?

Il peux être utille, par exemple, de changer les droits de l'administration du widget (spxdatas le permet). Consulter le documentation de spxdatas pour plus de détails.

Les traductions du widget

l'administration des widget peut-être traduite en deux langues pour le moment (anglais et français).

Pour cela il suffit de créer des fichier de traductions :

français dans monpluginwidget/spxdatas/table/table_loc/fr/admin.php
anglais dans monpluginwidget/spxdatas/table/table_loc/en/admin.php

Que contiennent ces fichiers ?

Exemple pour l'administration française du plugin spxpolaroïd

[PHP]

<?php

$LANG = array(

# GROUPES

'L_GROUPE_SPXWPOLAROID_TITLE' => '<img src="plugins/spxwpolaroid/spxdatas/icon/Slideshow.png" width="20px" height="20px" >Polaroid',

# TABLE

'L_TABLE_SPXWPOLAROIDS_TITLE' => 'Polaroid',

'L_TABLE_SPXWPOLAROIDS_DESCRIPTION' => '<p>Adminstration de vos polaroids.</p>',

# ACTION TITLE

'L_TABLE_SPXWPOLAROIDS_ACTIONTITLE' => '',

# COLUMN

'L_TABLE_COLUMN_SPXWPOLAROIDS_TITLE_HIGHLIGHTTITLE' => '',

'L_TABLE_COLUMN_SPXWPOLAROIDS_TITLE_TITLE' => 'Titre',

'L_TABLE_COLUMN_SPXWPOLAROIDS_TITLE_HELP' => 'Donner un titre a votre polaroid.',

# COLUMN

'L_TABLE_COLUMN_SPXWPOLAROIDS_POLAROID_CONTENT_HIGHLIGHTTITLE' => '',

'L_TABLE_COLUMN_SPXWPOLAROIDS_POLAROID_CONTENT_TITLE' => 'Accès au contenu',

'L_TABLE_COLUMN_SPXWPOLAROIDS_POLAROID_CONTENT_HELP' => 'Cliquer sur éditer pour créer ou modifier le contenu de votre polaroid',

# TABLE

'L_TABLE_SPXWPOLAROID_TITLE' => 'Polaroid',

...

);

[/PHP]

Ce fichier contient en fait un tableau php de traduction. Les noms d'association ont leur importance et obéissent à une logique codifiée.

Attention : le codage est en majuscule et séparé par le caractère "_"
Remplace xxx par le nom de la table : ex SPXWPOLAROID
Remplace yyy par le nom de la colonne : ex IMAGE

code	note
L_GROUPE_xxx_TITLE	Nom du groupe
L_TABLE_xxx_DESCRIPTION	Description de ma table
L_TABLE_xxx_ACTIONTITLE	Description de mon action (réservé pour plus tard)
L_TABLE_COLUMN_xxx_yyy_HIGHLIGHTTITLE	Texte de séparation entre deux colonnes (dans les options du widget)
L_TABLE_COLUMN_xxx_yyy_TITLE	Nom de ma colonne dans ma table
L_TABLE_COLUMN_xxx_yyy_HELP	Aide de ma colonne dans ma table

Il est possible de générer ce fichier à partir de la configuration du plugin widget. Voir l'exemple spxwpolaroid ou spxwunslider.

Comment récupérer les données de l'administration coté client ?

Tout d'abord nous allons déclarer un hook dans le constructeur du plugin.

[PHP]

$this->addHook('spxwpolaroid::getPolaroidID', 'getUnsliderID');

[/PHP]

Puis nous construisons la fonction qui va permettre de récuprérer les données du widget.

Spxdatas : présentation

je-evrard — Thu, 17 Jul 2014 07:44:00 +0200

Ce plugin permet de créer une administration afin de gérer des données autres que articles, catégories...

Il permet la gestion de galeries (images, titres, description), de liens html, de produits (titre, image, prix, description...), ...

Ce plugin peut être considéré comme un framework d'adminstration pour pluxml.

Un Framework d'administration :

Ce plugin est ouvert à la programmation pour créer des widgets soit en "interne" (dans le plugin spxdatas lui même) soit en "externe" (via d'autres plugins)

Ainsi, le plugin est accessible au débutant comme au développeur.

un débutant utilisera principalement spxdatas en addition avec d'autres plugins comme par exemple spxwunslider (gestion de slider) ou spxwpolaroid (gestion de polaroid)
un développeur pourra créer son propore plugin widget avec son administration, des hook et éventuellement des shortcodes pour afficher le widget.

spxdatas : fonctionnement technique

je-evrard — Thu, 17 Jul 2014 07:32:00 +0200

Spxdatas est un plugin générique qui exécutera les instructions qui seront définies dans sa base de données. Cette base va créer automatique une adminstration cliente. Vous êtes le chef d'orchestre de cette administration ! Spxdatas est un couteau suisse, un framework qui obéit a des règles précises. Il fera ce que vous lui dites de faire.

Mais comment ?

Pour que ça fonctionne, il va falloir lui donner des instructions qui vont définir l'administration. Ces instructions sont écrites au format xml. Cette description xml définit en fait une base de données avec des tables.

Une base de données avec des tables ?

Une vraie base de données fonctionne avec des tables, ici le meme principe est appliqué.

Une table dans une base de données est un ensemble de données organisées sous forme d'un tableau où les colonnes correspondent à des catégories d'informations (une colonne peut stocker des numéros de téléphone, une autre des noms...) et les lignes à des enregistrements, également appelées entrées.

Ici, c'est à peu près semblable mais en beaucoup plus simple et avec des options propres a l'administration de ce plugin décidemment pas comme les autres.

Pour résumer :

le plugin fait une lecture de la base cliente au format xml
cette lecture permet de créer l'administration cliente (admin/widget)
en front end il est possible de faire des requêtes au plugin pour récupérer les données sous forme de tableau php ou html
il est aussi possible, en frontend, d'administrer les données par des requêtes au plugin (suppression, mise à jour, création)

Spxdatas : configuration des données

je-evrard — Thu, 17 Jul 2014 07:00:00 +0200

Spxdatas sauvegarde les données dans des dossiers.

Cette procédure vous explique comment configurer spxdatas pour une utilisation optimale.

Attention à partir de la version 1.72 il est n'est plus nécessaire d'appliquer cette procédure : rendez vous directement dans la configuration du plugin avec une installation en un clic.

Par default les données de spxdatas sont enregistrées dans le dossier builder du plugin. Ce n'est pas l'idéal en cas de mise à jour. Le mieux est donc d'enregistrer les donneés dans le dossier data de pluxml.

Dans le plugin spxdatas/builder recopier les fichiers suivants :

data
builderdata
table

Dans le dossier "data" de la racine de pluxml, créer un dossier "spxdatas" et coller les dossiers recopiés.

Vous devriez avoir la configuration suivante.

Dans la configuration du plugin modifier le chemin pour l'enregistrement des données.

Remplacer le chemin par default par "data/spxdatas/"

Votre spxdatas est maintenant correctement configuré. Les enregistrements se feront dans le dossier "data/spxdatas".

Pour une future mise à jour du plugin, remplacer tout simplement le plugin dans son intégralité et c'est tout.

Spxdatas : prise en main

je-evrard — Thu, 03 Jul 2014 21:40:00 +0200

Voici la procédure pour débuter avec spxdatas.

Tout d'abord, vous devez récupérer la dernière version du plugin ici. Dézipper l'ensemble et installer spxdatas dans le répertoire plugins de pluxml. (plugins/spxdatas/). Allez dans le menu de gestion des plugins et activez spxdatas. Pluxml affichera un message "Plugin non configuré"

Allez dans le menu de configuration du plugin.

Sélectionnez "oui" dans l'option "Active builder".

Vous pouvez maintenant enregistrer.

Votre plugin est maintenant configuré correctement pour une utilisation basique.

Dans l'administration allez dans le nouveau menu "Widgets".

La nouvelle page qui apparaît est l'administration par default de spxdatas. L'onglet "Liens" est sélectionné. Appuyez sur "nouvelle entrée" pour commencer à créer un premier enregistrement.

Un nouvel écran apparaît. Remplissez les différents champs comme sur l'image et appuyez sur "Enregistrer".

Bravo vous venez de créer votre premier enregistrement !

Veuillez maintenant cliquer sur l'onglet "Editer base". A noter que seul l'administrateur (dont l'id est 001 et uniquement celui-la) peux accéder à cet onglet.

Dans la nouvelle page qui apparaît, veillez cliquer sur "Editer xml base".

Cette nouvelle page vous montre le code xml de votre base de données. Il est très important d'en prendre note car la connaissance de sa structure va vous permettre de faire les requêtes pour récupérer les données d'enregistrement coté client.

table name="link" --> nom de code de la table lien
parameter name="name" --> parametre du nom du lien
parameter name="url" --> parametre pour l'url du lien
parameter name="description" --> parametre pour la description du lien

Nous allons maintenant créer une nouvelle page statique dans laquelle nous allons mettre le code nécessaire pour récupérer les données.

Dans pages statiques, créé une nouvelle page "Link".

Editer cette nouvelle page et placez le code suivant:

[PHP]

<?php

global $plxShow;

$o= array();

$o["table"]="link";

$o["out"]="html";

$o["format"]='<li><a href="#url" title="#description">#name</a></li>';

echo ("<u1>".$plxShow->callHook('spxdatas::getData',$o)."</u1>");

[/PHP]

Valider les modifications.

Sur le site, dans la page "link" vous pouvez voir votre lien. Bienvenue dans spxdatas.