Plugin API Prix

API Prix est un plugin outil de développement à la base des divers outils de gestion de commerce en ligne. Il sert à trouver les prix des objets SPIP lorsqu’ils en ont, ce qui est nécessaire pour que d’autres plugins établissent par exemple des factures ou enregistrent des paiements. Il destiné aux développeur⋅euses qui veulent définir le prix HT et TTC de nouveaux objets.

Principe de base

Lorsque vous créez un nouvel objet ayant un prix, au lieu d’utiliser directement la valeur d’un champ qui contiendrait ce prix, ce plugin propose une API unifiée permettant de sortir le prix HT et le prix TTC toujours de la même manière, que ce soit une simple valeur de champ ou un calcul compliqué en arrière plan.

Implémentation

Pour que cette API fonctionne, vous devez l’implémenter pour le nouvel objet. Pour cela vous devez créer un fichier prix/<objet>.php avec possiblement deux fonctions.

Par exemple pour une patate :

prix_patate_ht_dist($id_patate, $ligne_sql) : cette fonction doit renvoyer la valeur du prix hors taxe pour cet identifiant. Afin de ne pas avoir trop de requête SQL, il y a déjà un argument contenant la ligne SQL de ce contenu, avec tous ses champs. Comme très souvent il s’agit juste de renvoyer le contenu d’un champ prix_ht ou prix, le plugin sait déjà le faire tout seul, et dans ce cas vous n’avez pas à implémenter cette fonction. Elle n’est donc utile que si la valeur n’est pas dans un champ commun, ou bien si vous avez besoin de faire des calculs pour trouver le prix HT, par exemple en multipliant avec une quantité (c’est ce que fait le plugin Commande par exemple).

prix_patate_dist($id_patate, $prix_ht) : cette fonction doit renvoyer le prix toute taxes comprises pour cet identifiant. Elle reçoit aussi le prix HT déjà calculé en amont. Si votre plugin est lié à un système permettant de trouver une ou plusieurs taxes pour votre objet, alors vous devez faire les calculs nécessaires et retourner le prix TTC. Si ce n’est pas le cas, le prix renvoyé au final sera le même que le prix HT.

Utilisation en PHP

Au niveau de l’utilisation, le cœur de l’API est constitué de deux fonctions génériques placées dans inc/prix.php.

inc_prix_ht_dist($type_objet, $id_objet, $arrondi)

// Charger la fonction
$fonction_prix_ht = charger_fonction('ht', 'inc/prix');
// Arrondi après la virgule
$arrondi = 2;
// On trouve le prix HT
$prix_ht = $fonction_prix_ht('patate', $id_patate, $arrondi);

inc_prix_dist($type_objet, $id_objet, $arrondi)

// Charger la fonction
$fonction_prix_ht = charger_fonction('prix', 'inc/');
// Arrondi après la virgule
$arrondi = 2;
// On trouve le prix TTC
$prix_ttc = $fonction_prix('patate', $id_patate, $arrondi);

Utilisation dans les squelettes

À utiliser dans le boucle d’un objet :
-  #PRIX_HT : renvoie le prix HT d’un objet
-  #PRIX : renvoie le prix TTC d’un objet

Les balises de prix sont directement formatées, un filtre leur est appliqué automatiquement, sauf si vous utilisez l’étoile *. Si vous devez formater une autre valeur, ou après un calcul dans un squelette, il s’agit du filtre prix_formater :

Les taxes seules :
 [(#PRIX*|moins{#PRIX_HT*}|prix_formater)] 

Si vous avez besoin de trouver le prix d’un objet quelconque dans un squelette, sans le connaitre à l’avance, donc sans boucle, deux filtres permettent cela, qui appellent directement l’API centrale :
-  prix_ht_objet($id_objet, $type_objet)
-  prix_objet($id_objet, $type_objet)

Paramétrage

Deux constantes permettent de gérer la devise utilisée.
On peut les définir dans le fichier mes_options.php :

-  PRIX_DEVISE pour formater les prix selon une langue (séparateur de milliers, de décimal, etc...). Cette valeur est utilisée par la fonction setlocale de PHP pour le paramètre LC_MONETARY.
-  DEVISE_DEFAUT pour indiquer quel texte doit être affiché après les prix pour indiquer la devise utilisée.

Par exemple, pour les dollars canadiens, on définira les valeurs ainsi :

define('PRIX_DEVISE','fr_CA.utf8');    // locale du français Canadien
define('DEVISE_DEFAUT','&nbsp;&dollar; CAN'); // espace insécable + symbole dollar + CAN

Pipelines

Le plugin défini deux pipelines : “prix” et “prix_ht”.

Le plugin n’associe aucun traitement par défaut à ces pipelines, mais il est possible de les définir pour votre site ou plugin, de manière à adapter les prix selon les intentions et besoins. C’est ce que fait notamment ici le plugin ’montants’, par exemple.

updated on 17 April 2020

Discussion

2 discussions

  • 8

    Yop,
    pour info, qu’est ce qui explique le nécessite PHP 7.0.8 ?

    • Plop,

      C’est la lib Intl de Commerce guys qui nécessite ça.

    • Ben justement, je me suis douté, j’ai regardé, et dans le composer.json ça dit :

      "require": {
          "php": ">=5.5.0"
      }
    • Ah tu fais bien de signaler, faut qu’on mette à jour.
      Maintenant c’est bien php 7.0.8 min : https://github.com/commerceguys/intl/blob/master/composer.json#L7

    • Ah flûte, ça m’arrange pas, c’est pour un vieux serveur avec PHP 5.6 ^^

      Bon, sinon, comment afficher par défaut le symbole € à la place de “EUR” ?

    • Il y a deux manières :
      -  soit tu ne touches à rien et tu utilises les balises avec * puis tu appelles le filtre de formatage toi-même dessus avec les options que tu veux
      https://git.spip.net/spip-contrib-extensions/prix/src/branch/master/prix_fonctions.php#L139
      -  soit tu surcharges le filtre sans le _dist et tu mets autre chose que tu veux par défaut

      Il ne me semble pas qu’on soit parti pour rendre ça configurable pour pouvoir changer le défaut, car la seule manière vraiment accessible c’est avec les devises en code alpha. Les symboles ne sont pas forcément lu correctement partout, et encore moins quand ça dépend des devises. Donc l’afficher autrement, comme par ex avec le symbole, ne devrait pas pouvoir être mis par défaut, mais plutôt utilisé au cas par cas à la main (avec étoile et le filtre), par ex dans des endroits précis où on veut un affichage “marketing” court et joli à présenter (concrètement avec un truc du genre : <span class="offscreen">#PRIX</span><span aria-hidden="true">[(#PRIX*|prix_formater{avec symbole})]</span>).

    • Ah… autre idée si tu veux vraiment par défaut malgré accessibilité et sans devoir surcharger (c’est jamais top) : t’insérer dans “declarer_tables_interfaces” après Prix, et passer par dessus la définition des filtres des deux balises en changeant $interface['table_des_traitements']['PRIX'][]= 'prix_formater(%s)'; par le tien, avec normalement possible la même fonction mais avec l’argument options en plus avec ce que tu désires.

    • Ok merci.
      Ce sera pour un site purement à public français, et en €, une surcharge ira très bien (même pas peur ^^).

    • Test quand même la table des traitements, c’est plus court (2 lignes de code) et ça éviterait la surcharge ! :)

    Reply to this message

  • 8

    Salut

    Les prix d’une application sont saisis en prix ttc.
    Option du plugin Produits v1.2.15 : Editer les produits en TTC.
    Ce plugin enregistre cependant le prix d’un objet en prix ht après l’avoir calculé.
    On a donc des prix_ht avec 6 décimales. Ce qui permet de calculer des prix TTC correctement arrondis.

    Or le plugin API Prix supprime les décimales pour calculer les prix ttc via la balise #PRIX :
    $options_ht = array_merge($options, array('arrondi'=>0));
    Résulat les prix affichés ne correspondent pas aux prix saisis dans l’administration où pourtant ils sont bien affichés, calculés sans doute par une autre formule.

    Peut-on corriger cette ligne 192 de ./inc/prix.php de cette façon :
    $options_ht = array_merge($options, array('arrondi'=>6));

    Cordialement

    • Yo,
      tout d’abord, peux tu indiquer de quelle version tu parles ? :)

      Si c’est la dernière, es-tu vraiment bien à jour ? Car il y a déjà eu cette correction (la dernière version étant encore “en dev” comme l’indique bien son statut) :
      https://git.spip.net/spip-contrib-extensions/prix/commit/41b8823b675096e20072aed5bf012a1cb79d5bfd

    • API Prix 1.2.6 - dev
      telle que distribuée par la fonction de mise à jour des plugins
      mais je vais aller chercher à la main la 1.2.8
      merci

    • API Prix 1.2.6 - dev
      telle que distribuée par la fonction de mise à jour des plugins

      @RastaPopoulos
      Ce tag a été ajouté automatiquement suite au déploiement du débardeur non ?
      Au départ la version de dev n’était pas dans le archivelist il me semble (pour pas être proposée dans SVP justement).

    • Au passage, quand j’active API Prix v1.2.8, ça l’active mais ça me dit ça en rouge,
      ce qui est incohérent :

      Impossible d’activer le plugin ../plugins/auto/paniers/v1.4.1
      Nécessite le plugin PRIX en version ≥ 0.1.8.
      Impossible d’activer le plugin ../plugins/auto/commandes/v1.17.2
      Nécessite le plugin PRIX en version ≥ 0.1.19.
      Impossible d’activer le plugin ../plugins/auto/livraison/v2.2.0
      Nécessite le plugin COMMANDES en version ≥ 1.6.13.
      Impossible d’activer le plugin ../plugins/auto/abonnements/v3.5.7
      Nécessite le plugin PRIX en version ≥ 0.1.11.
      Impossible d’activer le plugin ../plugins/auto/abozones/v1.0.7
      Nécessite le plugin ABONNEMENTS en version ≥ 2.0.0.

    • Ça c’est SVP qui lance parfois des fausses alertes, mais ça ne devrait avoir désactivé aucun de ces plugins.

      En résumé : la branche v1 est encore en développement, elle ne devrait pas tarder à passer en test ou en stable mais il peut subsister quelques bugs. Elle reste rétrocompatible avec la branche v0, mais il n’est pas exclus de faire un peu de ménage (renommage de fonctions, etc.), Bref si tu l’utilises en prod, garde ça en tête :)

      Il n’était pas prévu de la distribuer pour l’instant, c’est un effet de bord dû passage au débardeur, le tag a été posé automatiquement.

    • @tcharlss, tout à fait, c’est lors du passage au nouveau système, Cédric a d’abord généré des centaines de tags sur toutes les dernières versions des plugins (seulement le dernier de chaque branche, contrairement au script de azerttyu), et donc pour cette branche de dev aussi

      Il faudrait vraiment faire un chantier sur SVP pour ne pas mettre à jour si facilement quand ça change de X majeur… (et d’autant plus quand c’est en dev là ça devrait même pas être visible par défaut)

    • Grand merci pour vos explications.
      Très cordialement, Yanic

    Reply to this message

Ajouter un commentaire

Who are you?
[Log in]

To show your avatar with your message, register it first on gravatar.com (free et painless) and don’t forget to indicate your Email addresse here.

Enter your comment here

This form accepts SPIP shortcuts {{bold}} {italic} -*list [text->url] <quote> <code> and HTML code <q> <del> <ins>. To create paragraphs, just leave empty lines.

Add a document

Follow the comments: RSS 2.0 | Atom