创建 Joomla 库

Joomla 库是一组可重用的类或函数，可在多个扩展之间共享。库有助于组织和重用代码，从而提高开发效率和可维护性。

在本指南中，我们将创建一个 Joomla 库并学习如何在 Joomla 项目中使用它。

文件夹结构

Joomla 库的文件夹结构如下

libraries/
    yourlibraryname/
        src/
            YourLibrary.php
        yourlibraryname.xml

库的关键部分

• src/YourLibrary.php：这是库的主文件。它包含类定义和库将提供的函数。
• yourlibraryname.xml：此文件包含库的元数据。

扩展清单文件

libraries/yourlibraryname/yourlibraryname.xml

<?xml version="1.0" encoding="utf-8"?>
<extension type="library" method="upgrade">
    <name>Joomla 5 Example Library</name>
    <libraryname>JoomlaExampleLibrary</libraryname>
    <author>Author Name</author>
    <creationDate>2024-09-08</creationDate>
    <license>GNU General Public License version 2 or later</license>
    <version>1.0.0</version>
    <description>Showcase on how to create a Joomla 5 library to reuse code.</description>
    <namespace path="src">VendorName\LibraryName</namespace>
    <files>
        <folder>src</folder>
    </files>
</extension>

库类

您将在该类中定义库将提供的函数。以下是一个简单库类的示例

libraries/yourlibraryname/src/YourLibrary.php

<?php
namespace VendorName\LibraryName;

class YourLibrary
{
    public static function helloWorld()
    {
        return "Hello, World!";
    }
    
     public function greet($name)
    {
        return "Hello, " . $name . "!";
    }

}

打包库以供安装

创建完库后，您需要将其打包以供安装。您可以通过创建一个具有以下结构的 zip 文件来做到这一点

yourlibraryname.zip
    ├── yourlibraryname.xml
    └── src/
        └── YourLibrary.php

创建完 zip 文件后，您可以使用 Joomla 管理员后端的 Joomla 扩展管理器安装该库。

安装

1. 转到 Joomla 管理员后端。
2. 转到扩展 > 管理 > 安装。
3. 上传包含该库的 zip 文件。

用法

要在 Joomla 扩展中使用该库，您需要在代码中包含该库。以下是如何使用该库的示例

<?php
use VendorName\LibraryName\YourLibrary;

$library = new YourLibrary();
echo $library->greet("John");

echo YourLibrary::helloWorld();