Connexion de bibliothèques PHP tierces dans Joomla

Les bibliothèques PHP sont pratiques car elles sont accessibles depuis n'importe où dans l'application : depuis un plugin, un modèle de composant, un module, etc. Si quelqu'un a déjà résolu un problème similaire et l'a conçu comme une bibliothèque (et l'a même mis à jour), il est logique de connecter cette bibliothèque à votre Joomla. Par exemple, pour développer un moyen de paiement pour une boutique en ligne, vous avez besoin de la bibliothèque officielle d'un agrégateur de paiement. Ou êtes-vous satisfait du SDK PHP officiel de certains CRM.

Compositeur

Joomla ne prend pas en charge l'utilisation directe de Composer. Afin d'utiliser la bibliothèque dans votre travail, vous devez la "envelopper" dans une bibliothèque de type extension Joomla et l'installer. Dans les projets sérieux, l'approche consistant à corriger les versions de tous les composants du projet est adoptée : le code a été vérifié plus d'une fois, testé et autorisé à fonctionner en production.

Vous créez un package avec votre bibliothèque, installez-le là où vous en avez besoin. Au fur et à mesure que de nouvelles versions de la bibliothèque sont publiées, vous mettez à jour votre wrapper et bénéficiez de tous les avantages de travailler avec les extensions Joomla : mise à jour des extensions de manière standard, y compris via la CLI. Consultez le Changelog de l'extension dans la zone d'administration AVANT la mise à jour, etc.

Affichez l'extension Changelog dans la zone d'administration AVANT la mise à jour vers Joomla 5.

Joomla, PSR, Symfony

Joomla est conforme aux normes PSR, il est donc pratique de travailler avec lui à cet égard. Certains packages Symfony sont inclus dans le noyau de Joomla (console, string, vardumper, yaml, gestionnaire d'erreurs et autres), donc si vous souhaitez soudainement en ajouter d'autres, ils s'intégreront et fonctionneront bien. Vous pouvez voir ce que vaut d'autre dans Joomla en plus des composants Symfony dans les bibliothèques/fournisseurs.

Comment envelopper une bibliothèque PHP tierce dans une extension Joomla ?

Rien de compliqué. Les fichiers de la bibliothèque se trouvent généralement dans le dossier src. À côté de ce dossier, vous devez créer un manifeste XML de l'extension Joomla selon la documentation (manual.joomla.org). Ensuite, nous emballons le tout dans une archive zip et c'est tout ! Il peut être installé.

Si vous avez besoin de vos propres tables dans la base de données pour que la bibliothèque fonctionne, vous devez ajouter les fichiers nécessaires avec des requêtes SQL lors de l'installation ou de la mise à jour. Puisque Joomla 4 fonctionne avec des espaces de noms, il est important de spécifier cet espace de noms dans le manifeste XML de l'extension. Voici un exemple abrégé de manifeste XML pour la bibliothèque Joomla.

<?xml version="1.0" encoding="UTF-8" ?>
<extension type="library" method="upgrade">
     <name>WebTolk AmoCRM library</name>
     <libraryname>Webtolk/Amocrm</libraryname>
     <version>1.2.1</version>
     ...
     <namespace path="src">Webtolk\Amocrm</namespace>
     <files>
          <folder>src</folder>
          <filename>amocrm.xml</filename>
     </files>
</extension>

Le La balise signifie que le dossier src de notre archive sera copié dans JPATH_SITE/libraries/Webtolk/Amocrm. Dans le répertoire section, nous indiquons ce qui doit être rempli à partir des archives. Et WebtolkAmocrm dit que l'espace de noms WebtolkAmocrm doit être enregistré pour le dossier src dans JPATH_SITE/libraries/Webtolk/Amocrm.

Remarques importantes !

• Avant Joomla 4.2.7, en effet, la balise à partir du manifeste XML n'a pas fonctionné. Par conséquent, il était nécessaire d'ajouter un plugin système au package de bibliothèque qui enregistrerait l'espace de noms sur l'événement onAfterInitialize (Event Dispatcher) à l'aide de la classe JLoader. En conséquence, il était nécessaire de créer un package à partir de la bibliothèque et du plugin. À partir de Joomla 4.2.7, cela a été corrigé et vous pouvez vous passer du plugin.
• Jusqu'à présent, mise à jour de la bibliothèque = réinstallation.C'est-à-dire que l'extension est supprimée et installée. Cette décision a été prise quelque part au plus profond des versions de Joomla 3.x. Pourquoi? - caché sous les montagnes de PR. Nous devons chercher. Pourquoi est-ce important ? Parce que lors de l'installation d'une extension, une entrée est créée dans le "registre" des extensions - dans la base de données dans la table #__extensions. Ce tableau comporte 2 colonnes de type TEXT - params et custom_data. Et cela, il faut l’admettre, représente une quantité considérable de données. Si vous stockez certains paramètres de bibliothèque dans une base de données à l'aide de JoomlaCMSHelperLibraryHelper, vous devez alors prendre en compte ce comportement du programme d'installation et pré-enregistrer, puis rajouter les paramètres enregistrés au script d'installation de l'extension lors de la mise à jour de la bibliothèque.

<?php
use Joomla\CMS\Helper\LibraryHelper;
use Joomla\CMS\Cache\Cache;

/**
 * Function called before extension installation/update/removal procedure commences.
 *
 * @param   string            $type     The type of change (install or discover_install, update, uninstall)
 * @param   InstallerAdapter  $adapter  The adapter calling this method
 *
 * @return  boolean  True on success
 *
 * @since   1.0.0
 */
public function preflight(string $type, InstallerAdapter $adapter): bool
{
    if ($type == 'uninstall')
    {
        return true;
    }

    /**
     *
     *  Joomla when updating extensions of the library type, it actually deletes them (along with the data in the database),
     *  and then installs it again.
     *  In order to avoid losing library data from the database, we are writing this crutch.
     *
     * @see https://github.com/joomla/joomla-cms/issues/39360
     *
     */

    if ($type == 'update')
    {
        $lib_params = LibraryHelper::getParams('Webtolk/Amocrm');
        $jconfig    = $this->app->getConfig();
        $options    = array(
            'defaultgroup' => 'wt_amo_crm_temp',
            'caching'      => true,
            'cachebase'    => $jconfig->get('cache_path'),
            'storage'      => $jconfig->get('cache_handler'),
        );
        $cache      = Cache::getInstance('', $options);
        $cache->store($lib_params, 'wt_amo_crm_temp');

    }

    return true;

}

Et dans la méthode postflight() en conséquence, nous remettons les paramètres enregistrés en utilisant LibraryHelper::saveParams('Webtolk/Amocrm', $lib_params);.

• Pour que la bibliothèque fonctionne, elle doit être activée dans le gestionnaire d'extensions (Menu - Système - Gestion - Extensions).
• Souvent, certains paramètres (clés API, jetons, etc.) sont nécessaires au fonctionnement de la bibliothèque, qui doivent être spécifiés par les personnes dans la zone d'administration de Joomla. À ces fins, il est pratique d'écrire un plugin (une bibliothèque de types d'extension ne possède pas sa propre interface de configuration des paramètres). Que ce soit celui du système ou votre propre groupe personnalisé n'a pas d'importance. Dans votre bibliothèque, vous pouvez obtenir les paramètres du plugin assez rapidement comme ceci :

<?php
use Joomla\CMS\Plugin\PluginHelper;
use Joomla\Registry\Registry;

if (PluginHelper::isEnabled('system', 'wt_amocrm'))
   {
      $plugin        = PluginHelper::getPlugin('system', 'wt_amocrm');
      $params        = \json_decode($plugin->params);
      $param = $params->param;
      // OR you can use Joomla\Registry\Registry
      $params = new Registry($plugin->params);
      $param = $params->get('param', 'defatul value if empty');
   }

Ressources de la communauté Joomla

• https://joomla.org/
• Chat de la communauté Joomla dans Mattermost
• Extensions WebTolk Joomla
• Cet article en russe

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!