Au cœur de PrestaShop

1. Introduction

Lorsqu’un projet open source est utilisé et qu’un développeur autre que vous est amené à parcourir votre code, les conventions de code sont une bonne pratique au quotidien.

Celles-ci facilitent la lecture de vos développements et vous permettent également de contribuer, par le biais de pull request (propositions de changements), au projet lui-même.

2. Conventions génériques

L’ensemble des fichiers issus du projet doivent :

3. PHP

php ./vendor/bin/php-cs-fixer fix 

1. Structure

PrestaShop s’appuie sur une base de données SQL et dès lors sur un ensemble de tables.

Par défaut, chaque table est préfixée par ps_. Ce préfixe est configurable et il est vivement conseillé de le personnaliser lors de son installation.

Certaines tables sont suffixées par _lang ou _shop.

Les premières servent aux enregistrements pouvant varier selon une locale pour la spécificité d’une langue, d’une région et caractérisée par la présence de la colonne id_lang, tandis que les secondes, disposant de la colonne id_shop, serviront aux enregistrements pouvant varier selon un contexte de boutique. Nous reviendrons plus en détail sur cette notion plus tard.

2. Classe Db

L’interaction avec la base de données est une part fondamentale du développement sous PrestaShop et celle-ci se fait au travers du composant Db, représenté par une classe PHP statique.

$db = Db::getInstance(); 

$db = Db::getInstance(_PS_USE_SQL_SLAVE_); 

return [ 
    [ 
        'server' => 'xxx.xxx.x.x', 
        'user' => 'user', 
        'password' => '123456', 
        'database' => 'clone1' 
    ], 
    [ 
        'server' => 'xxx.xxx.x.x', 
        'user' => 'user', 
        'password'...

1. Utilisation

Vous pouvez utiliser la classe legacy pour lire, mettre à jour ou ajouter une configuration.

Toutefois, il existe un service qui vous est accessible et qu’il est vivement conseillé d’utiliser : prestashop.adapter.legacy.configuration.

$container = Context::getContext()->container; 
/** @var Configuration $configuration */ 
$configuration = $container->
get('prestashop.adapter.legacy.configuration'); 

$configuration->get('CONFIGURATION_NAME'); 

$configurationValue = $configuration->get('CONFIGURATION_NAME', 
'Valeur par défaut'); 
// => $configurationValue : 'Valeur par défaut'. 

1. Introduction

Précédemment, vous avez pu voir la notion de contexte de boutique (Shop) utilisée dans les contraintes de boutiques.

Il existe toutefois une notion de contexte plus globalement utilisée que l’on pourrait définir comme un regroupement de données déterminant le contexte d’utilisation : la langue de l’utilisateur, le pays, la devise ou encore la boutique.

2. Composition du contexte

Tout d’abord, le contexte est une classe définie sous le pattern skeleton, ayant pour objectif de ne définir qu’une instance de la classe Context par utilisation.

Chaque propriété - publique - de cette classe correspond à des objets accessibles tels que Country, Shop ou encore Cookie.

Précisément, on retrouve une propriété pour chacune de ces instances :

Chaque propriété reprend comme nom la valeur de l’objet en minuscules.

/** @var Cart|null */ 
public $cart; 

3. Initialisation du contexte

Le contexte est initialisé par PrestaShop en son point d’entrée.

Cette initialisation se base sur les valeurs enregistrées en cookies ou celles définies par...

1. Utilisation des routes

Dans un contexte Symfony, vous pouvez utiliser le service du routeur embarqué de Symfony afin de générer vos liens.

La documentation officielle de Symfony regorge d’exemples à ce sujet : https://symfony.com/doc/4.4/routing.html#generating-urls

Lorsque vous êtes dans un contexte legacy, notamment dans un module, vous pouvez...

1. Listes des commandes

PrestaShop dispose d’un ensemble de commandes de console en plus de celles embarquées par Symfony.

Vous pouvez par ailleurs ajouter vos propres commandes au sein de vos modules. 

Pour obtenir l’ensemble des commandes de console disponibles, vous pouvez lancer l’appel suivant :

php bin/console list 

Pour obtenir de l’aide sur une commande en particulier, utilisez --help en argument. 

php bin/console debug:twig --help 

Les commandes relatives à PrestaShop sont regroupées sous la section prestashop. 

Passons en revue les quelques commandes qui pourraient vous être utiles lors de vos développements.

prestashop:config

Permet d’ajouter, modifier ou supprimer une valeur de configuration.

php bin/console prestashop:config set YOUR_VAR --value "La valeur 
de configuration" 
 
php bin/console prestashop:config get YOUR_VAR 
 
php bin/console prestashop:config remove YOUR_VAR 

prestashop:debug

Permet de définir le statut du mode développeur.

php bin/console prestashop:debug on 
php bin/console prestashop:debug off 

Lorsqu’aucun argument n’est passé, le statut du mode développeur reste inchangé et son état actuel vous est retourné.

php bin/console prestashop:debug 

prestashop:list:commands-and-queries

Cette commande est expliquée dans le chapitre Introduction - CQRS.

prestashop:mail:generate

Permet de générer les templates statiques d’un thème d’e-mails.

php bin/console prestashop:mail:generate modern fr 

Le concept des thèmes d’e-mails est vu dans le chapitre Personnalisation - Thème d’e-mails.

prestashop:module

Permet de gérer les modules.

Plusieurs...

1. Utilisation au sein d’un template

Selon la nature du point d’accroche, il est principalement exécuté dans un contrôleur.

Il est toutefois possible d’appeler un hook pour une injection de contenu au sein des templates.

{hook h='displayFooter'} 

{hook h='displayFooter' mod='votremodule'} 

# Dans un fichier .tpl 
{hook h='displayFooter' param1='123' param2='456'} 
 
# Fichier : example.php 
public function hookDisplayFooter($params) 
{ 
    // $params['param1'] => 123 
    // $params['param2'] => 456 
} 

{{ renderhook('displayFooter', { 'param1': '123' }) }} 

2. Appeler un hook

Durant la conception de vos développements - notamment au sein d’un module - vous pouvez également faire appel à l’exécution d’un hook à l’endroit souhaité.

La méthode à...

1. HelperCalendar

Permet d’afficher un calendrier pour la sélection d’une plage de dates.

$helper = new HelperCalendar(); 
 
// Plage de dates séléctionée par défaut 
$helper->setDateFrom('2022-08-01'); 
$helper->setDateTo('2022-10-31'); 
 
// Dates utilisées dans le bloc "Comparer avec" 
$helper->setCompareDateFrom('2021-08-01'); 
$helper->setCompareDateTo('2021-10-31'); 
 
return $helper->generate(); 

Afin de pouvoir afficher le calendrier, vous devez ajouter un bouton d’ouverture de ce dernier. Il possède l’identifiant datepickerExpand.

<button 
    id="datepickerExpand" 
    class="btn btn-default" type="button"> 
        Voir le calendrier <i class="icon-caret-down"></i> 
</button> 

2. HelperView

Génère une vue. Exclusivement utilisé par la classe AdminController.

3. HelperList

Permet d’afficher un tableau de données.

Tout d’abord, il vous faut instancier un objet HelperList et lui attribuer quelques propriétés.

$helper = new HelperList(); 
 
$helper->simple_header = true; 
 
$helper->identifier = 'id_chapter'; 
$helper->title = 'Chapitres'; 
 
$helper->list_id = $this->name; 
$helper->token = Tools::getAdminTokenLite('AdminModules'); 
$helper->currentIndex = 
AdminController::$currentIndex.'&configure='.$this->name; 

Tout tableau disposant d’une à plusieurs colonnes, il vous faut les définir.

$columns = [ 
    'id_chapter' => array( 
        'title' => $this->l('#'), 
        'width' => 140, 
        'type' => 'text', 
    ), 
    'name' => array( 
        'title' => $this->l('Name'), 
        'width' => 140, 
        'type' => 'text', 
    ), 
]; 

Les données affichées doivent être déclarées...

1. Types additionels

Texte

Choix

Date et heure

Boutons

Extensions

Autres

2. Aide au rendu

Symfony dispose...

1. Définir une grille

<?php 
namespace Eni\Example\Grid\Definition\Factory; 
 
use PrestaShop\PrestaShop\Core\Grid\Definition\Factory\
AbstractGridDefinitionFactory; 
 
final class ProductGridDefinitionFactory extends 
AbstractGridDefinitionFactory 
{ 
} 

protected function getId() 
{ 
    return 'customers'; 
} 
 
protected function getName() 
{ 
    return $this->trans('Customer', [], 'Admin.Grid.Example'); 
} 

use PrestaShop\PrestaShop\Core\Grid\Column\ColumnCollection; 
use PrestaShop\PrestaShop\Core\Grid\Column\Type\DataColumn; 
 
protected function getColumns() 
{ 
    return (new ColumnCollection()) 
        ->add((new DataColumn('id_customer')) 
            ->setName($this->trans('ID', [], 'Admin.Global')) 
            ->setOptions([ 
                'field'...

1. Introduction

Afin d’utiliser les LazyArrays, il est avant tout nécessaire de bien cerner ce qui caractérise ceux-ci.

Les LazyArrays implémentent l’interface ArrayAccess, native de PHP. Cette interface permet d’accéder aux objets de la même façon que pour les tableaux. 

Ils sont principalement utilisés lors du passage de ressources en paramètres de hooks ou lors de la présentation des objets en front-office.

2. Classe abstraite : AbstractLazyArray

L’ensemble des LazyArrays s’articulent autour d’une classe abstraite : AbstractLazyArray. 

Celle-ci se charge d’implémenter l’interface ArrayAccess nécessaire à cette utilisation d’un objet comme un tableau. Elle implémente également les interfaces Iterator, Countable et JsonSerializable.

Ainsi, vous aurez notamment la possibilité d’utiliser des méthodes telles que count(), current(), key(), next(), rewind(), valid() ou encore jsonSerialize().

count()

Permet de récupérer le nombre de clés définies dans le LazyArray.

current()

Permet de récupérer la donnée associée à l’index courant.

key()

Permet de récupérer la clé de l’élément courant.

next()

Permet d’avancer au prochain élément au sein du LazyArray.

rewind()

Permet de placer l’itérateur sur le premier élément.

valid()

Vérifie si la position courante est valide.

Par valide, on entend que l’itérateur est placé sur une position associée à un élément. Dans le cas contraire, le retour de cette méthode est un booléen défini sur false et signifiant la fin de la boucle.

jsonSerialize()

Permet d’obtenir le LazyArray sous forme d’un array classique utilisable lors de l’utilisation de json_encode().

3. Annotation @arrayAccess

Puisqu’il s’agit d’un tableau utilisable comme un objet, le LazyArray donne la possibilité d’utiliser des méthodes.

Lorsque l’on consulte les LazyArrays existants, on peut voir quelques-unes de ces méthodes portant l’annotation @arrayAccess en bloc de commentaires.

Cette annotation doit être associée à une méthode en visibilité publique et dont le nom est composé de l’index en PascaCase préfixé de get.

Par exemple, getAddToCart() est utilisée en lien...

1. Utilisation

Afin d’utiliser un composant, il faut tout d’abord l’initialiser.

À cette fin, on utilise l’objet window.prestashop.component et plus précisément sa méthode initComponents().

$(document).ready(function () { 
    window.prestashop.component.initComponents( 
        [ 
            'Router', ...