Joomla! Documentation™

Une part importante dans la création d'un patch pour Joomla! est de vous assurer que vous l'avez créé correctement. La norme impose que tous les patchs soient créés à la racine de votre site Joomla. De cette façon, lorsque nous sommes amenés à le tester, nous n'avons pas besoin de travailler en dehors du répertoire dans lequel se trouve le fichier que vous tentez de changer ou, de devoir modifier votre fichier correctif pour le faire fonctionner correctement sur notre propre système local. Ceci peut être un problème car si votre correctif ne modifie qu'un unique fichier, il se peut qu'il existe déjà un même fichier avec ce nom. Par exemple, nous avons récemment reçu un correctif pour un fichier appelé banner.php. Il existe déjà cinq différents fichiers de Joomla! appelé banner.php. Il convient alors de déterminer et travailler sur le fichier concerné.

Création d'un patch correctif avec la ligne de commande

Pour les utilisateurs Linux/Mac, l'utilisation des lignes de commande reste souvent le moyen le plus rapide pour la création d'un correctif. En fonction des modifications que vous avez déjà apportées à votre installation en locale, vous pourriez avoir quelques nouveaux changements à opérer. Le meilleur moyen pour éviter cela est de partir d'une nouvelle installation de Joomla! à partir du SVN et d'y d'apporter vos modifications. Puis, à la racine de votre Joomla, vous pouvez exécuter la commande suivante :

svn diff > file.patch

Vous devez vous assurer que seules les modifications que vous avez effectuées sont présentes dans le fichier et aucun autre changement non souhaité. Si vous ne pouvez pas, vous devrez spécifier les fichiers que vous avez modifiés pour faire partie du patch correctif :

svn diff libraries/joomla/database/table.php > jtable.patch

Assurez-vous d'être dans répertoire racine de Joomla et non pas dans le répertoire des fichiers (vous devez voir des dossiers tels que : libraries, administrator, plugins, components, modules, etc).

Création d'un patch avec Eclipse

Si vous utilisez Subclipse pour Eclipse, vous pouvez vérifier un nouveau projet à partir du SVN de Joomla! (quelle que soit la branche/version concernée par votre anomalie) et ainsi l'utiliser pour créer un fichier correctif. Gardez à l'esprit que, par défaut, Eclipse créé des correctifs qui reprennent l'intégralité du chemin d'accès aux fichiers ce qui n'est absolument pas ce que nous recherchons. En supposant que vous avez créé un nouveau projet à l'aide du checkout du SVN et utilisé la racine de Joomla, vous devriez être en mesure de créer facilement un correctif valide.

Pour créer un patch correctif, sélectionnez les fichiers que vous avez modifiés et faites un clic droit sur l'un d'eux puis sélectionnez "Team > Create Patch". Le premier écran vous demandera où vous souhaitez placer le fichier : dans le presse-papiers, le système de fichiers ou dans l'espace de travail. En général vous souhaiterez le créer quelque part dans le système de fichiers. Personnellement, j'utilise un dossier pour les patchs où je conserve tous les patchs que je fais. Vous devez également remarquer au bas de l'écran la liste des fichiers qui seront inclus dans ce correctif. Si vous avez inclus des fichiers que vous ne voulez pas, vous pouvez les désélectionner. S'il vous manque un fichier dans cette liste, vous devez sélectionner à nouveau les fichiers et les ajouter.

Une fois que vous avez déterminé l'endroit où vous allez mettre le patch et que vous avez sélectionné les fichiers, cliquez sur "Next" pour continuer. Si vous cliquez sur "Finish" à ce stade, votre patch sera créé de façon incorrecte et c'est pour cette raison qu'il est important à ce stade de cliquer sur "Next". A ce stade, sélectionnez l'option "Project" puis cliquez sur "Finish" pour créer définitivement le patch. Procéder de cette façon vous permettra d'être certain que votre fichier correctif aura été créé correctement.

Création d'un patch avec NetBeans

Vous pouvez également utiliser l'IDE NetBeans afin de créer des fichiers correctifs. Il existe une vidéo qui explique la procédure à suivre pour créer un patch pour Joomla! : http://www.vimeo.com/11981229.

Fins de lignes et encodage

Après tout ajout, il est très important d'utiliser le bon type de fin de ligne. Le style de fin de ligne pour Joomla! est un unique retour à la ligne ou "style Unix". De plus, tous les fichiers doivent utiliser le codage UTF-8. Si vous utilisez Eclipse, vous pouvez modifier vos paramètres dans : Window -> Preferences -> General -> Workspace. Sélectionnez l'encodage des fichiers en UTF-8 et votre délimiteur de ligne sur "Unix".