Websource Builder pour PrestaShop — référence développeur

Vue d'ensemble

• Module websourcebuilder, espace de noms Websource\Builder\ (PSR-4 dans src/). Contrôleur d'administration AdminWebsourceBuilder (onglet Apparence > Websource Builder) ; getContent() y redirige.
• Un contenu = une ligne de websourcebuilder_content : un nom, une langue (0 = toutes), une liste d'emplacements et deux arbres de blocs JSON (brouillon et version en ligne). Aucun cache : la version en ligne est lue à chaque requête pour la boutique et la langue du contexte.
• Rendu serveur par Render\PageRenderer ; chaque bloc est une classe Block\BlockInterface. Toute donnée saisie passe par Block\BlockSanitizer (80 blocs, 40 éléments par liste, 30 000 caractères par texte au maximum) ; les couleurs par Block\ColorValue ; les styles avancés par Block\Appearance::sanitize().

Hooks greffés

Hook exposé : actionWebsourceBuilderRegisterBlocks

Permet à un module d'ajouter des blocs à la palette. Le hook est exécuté sans paramètre ; chaque module renvoie un tableau d'objets BlockInterface (les autres valeurs sont ignorées).

public function hookActionWebsourceBuilderRegisterBlocks(): array
{
    return [new MonBloc()];
}

namespace Websource\Builder\Block;

interface BlockInterface
{
    public function getType(): string;        // identifiant unique, lettres minuscules
    public function getLabel(): string;
    public function getDescription(): string;
    public function getCategory(): string;    // famille de la palette
    public function getIcon(): string;
    public function getFields(): array;       // objets Field (texte, liste, image, couleur…)
    public function getDefaults(): array;
    public function render(array $data, \Websource\Builder\Render\RenderContext $context): string;
}

Block\AbstractBlock fournit l'enveloppe commune (apparence, style avancé). RenderContext donne la langue, l'objet Link, la devise, la boutique et indique si le rendu est un aperçu d'éditeur.

Blocs fournis

hero, features, cards, split, cta, faq, testimonials, stats, announcement, columns (1 à 6 colonnes, largeurs de 1 à 6 parts, un seul niveau d'imbrication), heading, text, button, spacer, pagecontent, image, video, products, html. Feuilles de style : views/css/blocks/<type>.css.

Widgets des modules Websource reconnus dans l'accueil (WebsourceBuilder::HOME_WIDGET_MODULES, type de bloc → module) : websource_newproducts → websourcenewproducts, websourcebrands → websourcebrands, websource_newsletter → websourcenewsletter, websource_reassurance → websourcereassurance, websource_slider → websourceslider, store_info → websourcestoreinfo, websourceblog → websourceblog. Quand un de ces widgets figure dans le contenu en ligne de l'accueil, syncHomeWidgets(int $shopId) retire le module du hook displayHome de la boutique et le rétablit quand le widget disparaît (état mémorisé dans WSB_HOME_UNHOOKED).

Emplacements (Placement\PlacementCatalog)

Un emplacement : {"page": "home", "position": "top", "cms_id": 0, "hook": ""}.

Pages : all, home, category, product, cms, login, registration, password, account, orders, cart, contact, notfound.

Jetons (Render\TokenResolver)

Variables Smarty

Variables CSS posées sur l'aperçu par l'écran En-tête et pied de page : --wsx-hdr-min, --wsx-hdr-pt, --wsx-hdr-pb (enregistrées par Websource Theme Config).

Contrôleur AdminWebsourceBuilder

Écrans (paramètres GET) : &home=1 (live builder de l'accueil, écran par défaut), &list=1 (tableau de bord), &edit=<id> (éditeur), &layout=<page>[&cms=<id>] (emplacements d'une page), &design=1 (en-tête et pied de page), &product=1 (fiche produit) ; &standalone=1 ouvre les deux derniers sans le cadre du back-office.

Actions AJAX (ajax=1&action=<nom>, jeton du back-office, réponses JSON) :

Emplacements gérés par reorder : displayBanner, displayNav1, displayNav2, displayTop, displayNavFullWidth, displayWrapperTop, displayContentWrapperTop, displayContentWrapperBottom, displayWrapperBottom, displayFooterBefore, displayFooter, displayFooterAfter ; et selon la page displayHome, displayLeftColumn, displayProductAdditionalInfo, displayReassurance, displayFooterProduct, displayShoppingCart, displayShoppingCartFooter, displayCustomerLoginFormAfter, displayCustomerAccountFormTop, displayCustomerAccountForm, displayMyAccountBlock, displayCustomerAccount.

Fiche produit (Product\ProductLayouts)

• Dispositions (liste blanche) : Classique (classic, par défaut), Galerie XL, Vitrine, Minimal, Achat toujours visible, Magazine.
• Zones : top, media, info, below.
• Blocs (une occurrence chacun) : flags, gallery, title, price, short_description, buy, reassurance, details, related.
• Mode des détails : tabs, accordion, stacked.

Tables

{prefix}websourcebuilder_content

{prefix}websourcebuilder_section : id_section, id_shop, name, type, block (JSON), date_add ; 100 sections au plus par boutique.

Configuration

Les variantes d'en-tête et de pied de page ne sont pas stockées ici mais dans WSTC_SETTINGS (Websource Theme Config).

Export / import de thème

Sections fournies au hub Websource Theme Config : builder (contenus : textes par langue indexés par code ISO, brouillon et version en ligne, emplacements, groupes de traduction ; 200 contenus au plus), builder_library (sections enregistrées), product_layout (disposition de la fiche produit), hook_layout (ordre des modules dans les emplacements du builder).

Export JSON d'une page ou d'une section depuis l'éditeur : fichier .json relu par l'action importBlocks (identifiants régénérés, blocs inconnus écartés).

Méthodes publiques utiles

WebsourceBuilder::createRegistry(): BlockRegistry, createRenderer(): PageRenderer, baseHooks(): array, ensureHookRegistered(string $hookName, int $shopId = 0), ensureHooksForShop(array $hooks, int $shopId), syncHomeWidgets(int $shopId), blockTypes($blocks) (types présents, colonnes comprises), jsStrings(): array.

Traductions

Interface, blocs, modèles et emplacements : translations/fr.php, translations/en.php. Les libellés des blocs passent par I18n\Translator et n'apparaissent pas dans l'écran « Traductions » de PrestaShop.

Test fourni

php modules/websourcebuilder/tests/compat_test.php.