Utilisation de dcSoapCulture

Présentation

Ce plugin permet de gérer des listes de lecture/film/artiste musical il utilise l'api SOAP d'Amazon et se compose de 3 parties :

• en haut : un moteur de recherche utilisant HTTP et SOAP qui va chercher les infos sur un "produit" (Film/Livre/Artiste Musical) sur le site Amazon.com (version US,pas de version fr pour le moment)

• une partie centrale qui affiche les résultats de la recherche (invisible au début)
• un formulaire pour insérer le "produit" trouvé dans sa base de données

Installation/désinstallation/mise à jour du plugin

Installation suppression et mise à jour des tables du plugin.

• Le plugin dcSOAPCulture s'installe automatiquement à la toute première utilisation : la(es) table(s) seront automatiquement crées (c.f. fichier install/db-create.xml)
• La mise à jour des tables se fera à chaque nouvelle version du plugin qui nécessitera une modification de la structure de la table (la mise à jour ne se fera que si le plugin est déjà installé).Cette opération est dangereuse et peut entrainer la perte de vos anciennes données enregistrées,il est très vivement recommandé de faire une sauvegarde des données de la table avant d'effectuer cette mise à jour (note : nous ne serons aucunement responsables de la perte de vos données si vous effectuez une mauvaise manipulation de la commande "upgrade table(s)")
• La suppression des tables se fait en cliquant sur le lien correspondant en haut à droite de l'interface de l'administration.La suppresion des tables du plugin est irréversible et toutes les données s'y trouvant seront perdues,soyez prudents et faites une sauvegarde de celles-ci avant (note : nous ne serons aucunement responsables de la perte de vos données si vous effectuez une mauvaise manipulation de la commande "delete table(s)")
• Pour la suppresion du(es) table(s) du plugin,le fichier se trouve dans uninstall/db-delete.xml.Pour la mise à jour du(es) table(s) le fichier se trouve dans upgrade/db-upgrade.xml (note : ce plugin est une première version,il n'y a pas de mise à jour des tables à effectuer).
• Pour une suppresion complète du plugin dans le répertoire DC_ECRIRE/tools/ aller au plugin initial correspondant de DotClear.

Moteur de Recherche

Champs mot(s) clé(s) pour le moteur de recherche

Ce champ contient le ou les mots clés à mettre dans le moteur de recherche.(note : s'il y a une erreur ou une requête qui n'aboutit pas un message d'erreur apparait en bas recommencer la recherche le cas échéant).

Catégories de l'item

Cette liste déroulante permet de choisir entre un "Film" (en général DVD),un "Livre" (Auteur), un "Artiste" (musical),un "Jeux" (jeu(x) video(s)),un "Classique" (musique classique),un "Techno" (gadget électronique),une "Photo" (appareils photos ou périphériques photos"). un sélecteur ASIN a été rajouté pour permettre une vérification de la présence de l'item avec son identifiant.

Navigation dans les pages de résultats

Une petite barre de navigation apparaît en-dessous de la recherche ;

"<<" signifie page précédente , ">>" signifie page suivante.

10 items maximum peuvent être affichés sur chaque page.

Champs

Asin

Ce champ contient l'Asin (l'Asin est un identifiant Amazon unique d'un produit composé de chiffres ou chiffres/lettres). Il est obligatoire.

Type

Menu déroulant permettant de choisir le type de l'entrée (un Film ou un Livre ou un Artiste musical ou Jeux video ou musique Classique ou un gadget Technologique ou un appareil Photo/périphériques Photo).

URL

Ce champ contient une url supplémentaire (site d'un film ou d'un artiste ou autre en rapport avec l'entrée). Il est optionel.

Langue

Ce champ contient le code ISO de la langue de l'url. Il peut contenir le code ISO de la langue sur 2 ou 3 lettres (FR ou FRA pour la France), soit le code ISO de la langue sur 2 lettres suivi du code du dialecte (FR-be pour le Français parlé en Belgique. Ce champ est optionnel,mais très vivement recommandé si on a rajouté une url supplémentaire.

Description

Ce champ permet de mettre une petite description personnelle ou un titre sur l'url (il sera utilisé à l'affichage dans le champ title du lien >a< de l'url). Ce champ est optionnel,mais très vivement recommandé si on a rajouté une url supplémentaire.

Divers

Bookmarklet/favelet

Un bookmarklet ou favelet est un code JavaScript concis que l'ont substitue à une URL dans un bookmark (favori). Il permet d'effectuer un certain nombre de choses lorsqu'il est appellé.

Pour l'installer il n'y a rien de plus simple : il suffit de le traiter exactement comment un bookmark (favori) classique.

Quant à son utilisation elle est tout aussi simple. Quand vous êtes sur une page que vous souhaiter ajouter à votre item/"produit" une adresse url externe, appellez le bookmarklet. Celui-ci vous conduit directement sur la page d'ajout du plugin et remplit automatiquement les champs url et description (url et titre du lien).

Il ne vous reste plus qu'à effectuer les modifications que vous souhaitez et à valider. Si vous n'êtes pas encore authentifié, vous passerez par l'écran d'authentification avant d'être amené vers la page d'ajout du plugin.

Bookmarklet2/favelet2 - spécial Amazon

Pour pallier aux faiblesses du moteur de recherche dans les versions localisées (non us), un bookmarklet/favelet supplémentaire est fourni.

Ce bookmarklet/favelet permet de récupérer l'ASIN directement à partir de l'url fournie par Amazon lors de l'affichage d'un item sur leur site et de l'incorporer dans les champs Asin du plugin (pour la recherche d'ASIN via le plugin ou pour l'ajout d'un nouvel item pour le plugin.

• glisser/déposer (drag-n-drop) le bookmarklet dans un endroit du navigateur le permettant
• aller sur le site Amazon de votre pays (exemple http://www.amazon.fr)
• rechercher l'item que vous voulez dans le moteur de recherche du site Amazon de votre pays
• choisir l'item que l'on souhaite parmi les résultats trouvés
• cliquer sur le bookmarklet "dcSOAPCulture - Amazon Asin" et le bookmarklet redirigera automatiquement sur la page d'ajout d'un item du plugin dcSOAPCulture avec remplissage automatique des champs asin, description, url.

Notes supplémentaires concernant ce plugin et sa partie SOAP

Pour pouvoir utiliser pleinement ce plugin,il vous faudra aller sur le site d'amazon et récupérer un "Token" (une clé d'identification développeur) cette opération est gratuite et permet à son utilisateur de profiter des ressources SOAP d'amazon :

http://www.amazon.com/gp/aws/landing.html

Le token présent dans le fichier conf.ini est un Token de test (veuillez récupérer votre popre token/clé sur le site d'Amazon)

Ce "Token" permet de faire une recherche sur 10 éléments par page (un petit menu permet de naviguer dans les pages et recupérer les 10 éléments suivants se situant sur une autre page)

En plus de ce plugin,il vous faudra faire quelques manipulations supplémentaire installer les librairies/classes nusoap.php et dcAmazonSearch.php dans le repertoire

/racine_du_blog/inc/nusoap/

.

Dans le répertoire nusoap/ fourni,il y a une autre classe GoogleSearch.php pour créer un moteur de recherche Google SOAP.Pour plus d'infos sur l'utilisation de cette classe dans DotClear veuillez lire le billet correspondant sur le blog ou m'envoyer un mail à: harisson [à] free [point] fr subject [dcSOAP]votre_sujet.(Note : le fichier nusoap.php est celui de la dernière version CVS de nusoap,les versions précédentes sont bugguées).

Deux requetes SOAP sont effectuées pour le traitement des données (une dans la partie administration pour le moteur de recherche) et une dans le "front-end" pour récupérer dynamiquement les données de la requête AsinSearchRequest.

Cette version du plugin utilise le répertoire de cache de DotClear.Cela permet d'éviter de faire des requêtes HTTP SOAP à chaque nouvel appel d'une page de blog si la requête SOAP demandée a déjà été effectuée.

Si vous connaissez déjà l'Asin du "produit" que vous désirez,il n'est pas nécessaire d'utiliser le moteur de recherche,remplissez directement le formulaire d'ajout.Si le résultat ne colle pas rééditez l'entrée.

concernant l'affichage dans le fichier template placez dans la sidebar :

<div id="Ce_que_vous_voulez">
<h2>Ce_que_vous_voulez</h2>
      
<?php dcsoapculture::showItemsImageNB('Film',1); ?>
<?php dcsoapculture::showItemsImageNB('Livre',1); ?>
<?php dcsoapculture::showItemsImageNB('Artiste',1); ?>

</div>

Pour afficher les 3 catégories.Si par exemple ,vous ne voulez afficher que les livres mettez juste :

<div id="Ce_que_vous_voulez">
<h2>Ce_que_vous_voulez</h2>

      <?php dcsoapculture::showItemsImageNB('Livre',1); ?>
      
</div>

Il est à noter aussi qu'il existe un fichier nommé popup-dcamazon.php fourni avec le plugin.Ce fichier permet de mettre dans le template ,en-dessous de chaque item, un bouton de type formulaire qui va ouvrir dans une popup la liste complète de toutes les entrées pour chaque catégorie. Pour bénéficier de cette fonctionnalité ,il suffit juste de copier ce fichier popup-dcamazon.php dans le répertoire du thème actif (ie là où se trouve,en général,le fichier template.php).

Trois nouvelles fonctions ont été ajoutées : showItemsImageNB($type,$nb,$imgsize), showItemImagesNBAlea($type,$nb,$imgsize), showItemImagesNBMosaic($type,$nb,$imgsize,$nostyle,$width,$height) exemple :

<div id="Ce_que_vous_voulez">
<h2>Ce_que_vous_voulez</h2>

      <?php dcsoapculture::showItemsImageNBAlea('Film',1); ?>
 <?php dcsoapculture::showItemsImageNB('Livre',1); ?>
<?php dcsoapculture::showItemsImageNBMosaic('Artiste',0,true); ?>

      
</div>

n'affichera que l'image et l'url supplémentaire de l'item Film.