Anbindung von PHP-Bibliotheken von Drittanbietern in Joomla

PHP-Bibliotheken sind praktisch, weil auf sie von überall in der Anwendung aus zugegriffen werden kann: über ein Plugin, ein Komponentenmodell, ein Modul usw. Wenn jemand bereits ein ähnliches Problem gelöst und es als Bibliothek entworfen (und sogar aktualisiert) hat, Es ist sinnvoll, diese Bibliothek mit Ihrem Joomla zu verbinden. Um beispielsweise eine Zahlungsmethode für einen Online-Shop zu entwickeln, benötigen Sie die offizielle Bibliothek eines Zahlungsaggregators. Oder sind Sie mit dem offiziellen PHP SDK eines CRM zufrieden?

Komponist

Joomla unterstützt nicht die direkte Arbeit mit Composer. Um die Bibliothek in Ihrer Arbeit verwenden zu können, müssen Sie sie in eine Joomla-Erweiterungstypbibliothek „einschließen“ und installieren. Bei ernsthaften Projekten wird der Ansatz übernommen, Versionen aller Komponenten des Projekts zu korrigieren: Der Code wurde mehr als einmal überprüft, getestet und durfte in der Produktion funktionieren.

Sie erstellen ein Paket mit Ihrer Bibliothek und installieren es dort, wo Sie es benötigen. Wenn neue Versionen der Bibliothek veröffentlicht werden, aktualisieren Sie Ihren Wrapper und profitieren von allen Vorteilen der Arbeit mit Joomla-Erweiterungen: Erweiterungen auf die übliche Weise aktualisieren, auch über die CLI. Sehen Sie sich das Änderungsprotokoll der Erweiterung im Admin-Bereich an, BEVOR Sie sie aktualisieren usw.

Sehen Sie sich die Changelog-Erweiterung im Admin-Bereich an, BEVOR Sie auf Joomla 5 aktualisieren.

Joomla, PSR, Symfony

Joomla entspricht den PSR-Standards, daher ist es in dieser Hinsicht bequem, damit zu arbeiten. Einige Symfony-Pakete sind im Joomla-Kern enthalten (Konsole, String, Vardumper, Yaml, Fehlerhandler und andere). Wenn Sie also plötzlich weitere hinzufügen möchten, passen sie hinein und funktionieren gut. Was in Joomla außer Symfony-Komponenten noch wertvoll ist, können Sie in den Bibliotheken/Anbietern sehen.

Wie binde ich eine PHP-Bibliothek eines Drittanbieters in eine Joomla-Erweiterung ein?

Nichts Kompliziertes. Die Bibliotheksdateien befinden sich normalerweise im Ordner src. Neben diesem Ordner müssen Sie gemäß der Dokumentation (manual.joomla.org) ein XML-Manifest der Joomla-Erweiterung erstellen. Dann packen wir alles in ein Zip-Archiv und fertig! Es kann installiert werden.

Wenn Sie eigene Tabellen in der Datenbank benötigen, damit die Bibliothek funktioniert, müssen Sie bei der Installation oder Aktualisierung die erforderlichen Dateien mit SQL-Abfragen hinzufügen. Da Joomla 4 mit Namespaces arbeitet, ist es wichtig, diesen Namespace im XML-Manifest für die Erweiterung anzugeben. Hier ist ein gekürztes Beispiel eines XML-Manifests für die Joomla-Bibliothek.

<?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>

Der Tag bedeutet, dass der src-Ordner aus unserem Archiv nach JPATH_SITE/libraries/Webtolk/Amocrm kopiert wird. In den Im Abschnitt geben wir an, was aus dem Archiv ausgefüllt werden muss. Und WebtolkAmocrm besagt, dass der Namespace WebtolkAmocrm für den src-Ordner in JPATH_SITE/libraries/Webtolk/Amocrm registriert werden muss.

Wichtige Hinweise!

• Vor Joomla 4.2.7 war tatsächlich das Tag aus dem XML-Manifest funktionierte nicht. Daher war es notwendig, dem Bibliothekspaket ein System-Plugin hinzuzufügen, das den Namespace beim onAfterInitialize-Ereignis (Event Dispatcher) mithilfe der JLoader-Klasse registriert. Dementsprechend war es notwendig, ein Paket aus der Bibliothek und dem Plugin zu erstellen. Ab Joomla 4.2.7 wurde das Problem behoben und Sie können auf das Plugin verzichten.
• Bisher bedeutet Aktualisierung der Bibliothek eine Neuinstallation. Das heißt, die Erweiterung wird entfernt und installiert. Diese Entscheidung wurde irgendwo in den Tiefen der Versionen von Joomla 3.x getroffen. Warum? - versteckt unter den PR-Bergen. Wir müssen suchen. Warum ist das wichtig? Denn bei der Installation einer beliebigen Erweiterung wird ein Eintrag in der „Registrierung“ der Erweiterungen erstellt – in der Datenbank in der Tabelle #__extensions. Diese Tabelle hat 2 Spalten vom Typ TEXT – params und custom_data. Und das ist, das müssen Sie zugeben, eine beträchtliche Datenmenge. Wenn Sie einige Bibliotheksparameter mit JoomlaCMSHelperLibraryHelper in einer Datenbank speichern, müssen Sie dieses Verhalten des Installationsprogramms berücksichtigen und die gespeicherten Parameter vorab speichern und dann beim Aktualisieren der Bibliothek wieder zum Installationsskript der Erweiterung hinzufügen.

<?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;

}

Und entsprechend setzen wir in der postflight()-Methode die gespeicherten Parameter mit LibraryHelper::saveParams('Webtolk/Amocrm', $lib_params); zurück.

• Damit die Bibliothek funktioniert, muss sie im Erweiterungsmanager aktiviert werden (Menü – System – Verwaltung – Erweiterungen).
• Oft sind für das Funktionieren der Bibliothek bestimmte Parameter (API-Schlüssel, Token usw.) erforderlich, die von Personen im Joomla-Administrationsbereich angegeben werden müssen.Für diese Zwecke ist es praktisch, ein Plugin zu schreiben (Eine Erweiterungstypbibliothek verfügt nicht über eine eigene Schnittstelle zum Konfigurieren von Parametern.) Entweder die Systemgruppe oder Ihre eigene benutzerdefinierte Gruppe spielt keine Rolle. In Ihrer Bibliothek können Sie Plugin-Parameter ziemlich schnell wie folgt abrufen:

<?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');
   }

Ressourcen der Joomla-Community

• https://joomla.org/
• Joomla-Community-Chat in Mattermost
• WebTolk Joomla-Erweiterungen
• Dieser Artikel auf Russisch

Das obige ist der detaillierte Inhalt vonAnbindung von PHP-Bibliotheken von Drittanbietern in Joomla. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!