Menyambungkan perpustakaan PHP pihak ketiga dalam Joomla

Perpustakaan PHP adalah mudah kerana ia boleh diakses dari mana-mana sahaja dalam Aplikasi: daripada pemalam, model komponen, modul, dll. Jika seseorang telah menyelesaikan masalah yang sama dan mereka bentuknya sebagai perpustakaan (malah mengemas kininya), masuk akal untuk menyambungkan perpustakaan ini ke Joomla anda. Contohnya, untuk membangunkan kaedah pembayaran bagi kedai dalam talian, anda memerlukan perpustakaan rasmi pengagregat pembayaran. Atau adakah anda berpuas hati dengan PHP SDK rasmi beberapa CRM.

Komposer

Joomla tidak menyokong bekerja dengan Komposer secara langsung. Untuk menggunakan pustaka dalam kerja anda, anda perlu "membungkus"nya dalam pustaka jenis sambungan Joomla dan memasangnya. Dalam projek yang serius, pendekatan membetulkan versi semua komponen projek diguna pakai: kod telah disemak lebih daripada sekali, diuji dan dibenarkan untuk berfungsi dalam pengeluaran.

Anda membuat pakej dengan pustaka anda, pasangkannya di mana sahaja anda memerlukannya. Apabila versi pustaka baharu dikeluarkan, anda mengemas kini pembungkus anda dan mendapat semua kelebihan bekerja dengan sambungan Joomla: mengemas kini sambungan mengikut cara standard, termasuk melalui CLI. Lihat Changelog sambungan dalam kawasan pentadbir SEBELUM mengemas kini, dsb.

Lihat sambungan Changelog dalam kawasan pentadbir SEBELUM mengemas kini ke Joomla 5.

Joomla, PSR, Symfony

Joomla mematuhi piawaian PSR, jadi mudah untuk bekerja dengannya dalam hal ini. Sesetengah pakej Symfony disertakan dalam teras Joomla (konsol, rentetan, vardumper, yaml, pengendali ralat dan lain-lain), jadi jika anda tiba-tiba ingin menambah lagi, ia akan sesuai dan berfungsi dengan baik. Anda boleh melihat apa lagi yang bernilai dalam Joomla selain komponen Symfony dalam perpustakaan/vendor.

Bagaimana untuk membungkus perpustakaan PHP pihak ke-3 dalam sambungan Joomla?

Tiada apa-apa yang rumit. Fail perpustakaan biasanya terletak dalam folder src. Di sebelah folder ini, anda perlu mencipta manifes XML bagi sambungan Joomla mengikut dokumentasi (manual.joomla.org). Kemudian kami membungkus semuanya ke dalam arkib zip dan itu sahaja! Ia boleh dipasang.

Jika anda memerlukan jadual anda sendiri dalam pangkalan data untuk pustaka berfungsi, anda perlu menambah fail yang diperlukan dengan pertanyaan SQL semasa pemasangan atau kemas kini. Memandangkan Joomla 4 berfungsi dengan ruang nama, adalah penting untuk menentukan ruang nama ini dalam manifes XML untuk sambungan. Berikut ialah contoh ringkas manifes XML untuk pustaka 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>

tag bermakna folder src daripada arkib kami akan disalin ke JPATH_SITE/libraries/Webtolk/Amocrm. Dalam bahagian, kami menunjukkan perkara yang perlu diisi daripada arkib. Dan WebtolkAmocrm mengatakan bahawa ruang nama WebtolkAmocrm mesti didaftarkan untuk folder src dalam JPATH_SITE/libraries/Webtolk/Amocrm.

Nota penting!

• Sebelum Joomla 4.2.7, sebenarnya, tag daripada manifes XML tidak berfungsi. Oleh itu, adalah perlu untuk menambah pemalam sistem pada pakej perpustakaan yang akan mendaftarkan ruang nama pada acara onAfterInitialize (Event Dispatcher) menggunakan kelas JLoader. Oleh itu, adalah perlu untuk membina pakej daripada perpustakaan dan pemalam. Bermula dengan Joomla 4.2.7, ia telah dibetulkan dan anda boleh melakukannya tanpa pemalam.
• Setakat ini, mengemas kini perpustakaan = memasang semula. Iaitu, sambungan dialih keluar dan dipasang. Keputusan ini dibuat di bahagian dalam versi Joomla 3.x. kenapa? - tersembunyi di bawah pergunungan PR. Kita perlu mencari. Mengapa ini penting? Kerana apabila memasang sebarang sambungan, entri dibuat dalam "pendaftaran" sambungan - dalam pangkalan data dalam jadual #__extensions. Jadual ini mempunyai 2 lajur jenis TEXT - params dan custom_data. Dan ini, anda mesti mengakui, adalah sejumlah besar data. Jika anda menyimpan beberapa parameter perpustakaan dalam pangkalan data menggunakan JoomlaCMSHelperLibraryHelper, maka anda perlu mengambil kira tingkah laku pemasang ini dan pra-simpan dan kemudian tambahkan parameter yang disimpan kembali ke skrip pemasang sambungan apabila mengemas kini perpustakaan.

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

}

Dan dalam kaedah postflight() sewajarnya, kami meletakkan kembali parameter yang disimpan menggunakan LibraryHelper::saveParams('Webtolk/Amocrm', $lib_params);.

• Untuk pustaka berfungsi, ia mesti didayakan dalam pengurus sambungan (Menu - Sistem - Pengurusan - Sambungan).
• Selalunya, parameter tertentu (kunci API, token, dll.) diperlukan untuk pustaka berfungsi, yang mesti ditentukan oleh orang di kawasan pentadbir Joomla. Untuk tujuan ini, adalah mudah untuk menulis pemalam (pustaka jenis sambungan tidak mempunyai antara muka sendiri untuk mengkonfigurasi parameter). Sama ada sistem satu atau kumpulan tersuai anda sendiri tidak penting. Di dalam pustaka anda, anda boleh mendapatkan parameter pemalam dengan pantas seperti ini:

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

Sumber Komuniti Joomla

• https://joomla.org/
• Sembang Komuniti Joomla dalam Mattermost
• Pelanjutan WebTolk Joomla
• Artikel ini dalam bahasa Rusia

Atas ialah kandungan terperinci Menyambungkan perpustakaan PHP pihak ketiga dalam Joomla. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!