Manifest Files trong Joomla: Hướng Dẫn Chi Tiết Cho Nhà Phát Triển

Trong thế giới của Joomla, **manifest files** đóng vai trò then chốt trong việc quản lý và cài đặt các **extension**. Chúng chứa đựng thông tin quan trọng về **extension**, từ chi tiết cài đặt chung đến các tham số cấu hình cụ thể. Bài viết này sẽ đi sâu vào cấu trúc, cú pháp và cách sử dụng **manifest files** trong Joomla, giúp bạn hiểu rõ cách chúng hoạt động và cách tận dụng chúng để tối ưu hóa quy trình phát triển và quản lý **extension** của mình. Dù bạn là một nhà phát triển Joomla dày dặn kinh nghiệm hay chỉ mới bắt đầu, hướng dẫn này sẽ cung cấp những kiến thức cần thiết để làm chủ **manifest files**.

Manifest File Là Gì Và Tại Sao Chúng Quan Trọng?

**Manifest file** là một file XML chứa các metadata (dữ liệu về dữ liệu) của một **extension Joomla**. Nó cung cấp cho Joomla biết thông tin về **extension** như tên, phiên bản, tác giả, mô tả, các file cần cài đặt, và các tham số cấu hình. Khi bạn cài đặt một **extension** thông qua trình quản lý **extension** của Joomla, hệ thống sẽ đọc **manifest file** để biết cách cài đặt **extension** đó một cách chính xác. Nếu không có **manifest file**, Joomla sẽ không thể nhận diện và cài đặt **extension** một cách tự động và dễ dàng.

Quy Ước Đặt Tên Manifest File

Tên của **manifest file** rất quan trọng. Trong Joomla 2.5 và 3, file có thể được đặt tên là `manifest.xml` hoặc `.xml`. Tuy nhiên, trong Joomla 4, việc sử dụng `manifest.xml` có thể gây ra lỗi với cơ chế ánh xạ namespace tự động. Vì vậy, tốt nhất là bạn nên đặt tên file theo tên của **extension** (ví dụ: `com_example.xml`). File này phải nằm ở thư mục gốc của gói cài đặt **extension**.

Cấu Trúc Cú Pháp Của Manifest File

**Manifest file** được cấu trúc bằng XML, với một số thẻ và thuộc tính nhất định để mô tả các thành phần khác nhau của **extension**. Dưới đây là một số thành phần quan trọng:

Phần tử gốc (``)

Thẻ `` là phần tử gốc của **manifest file**. Nó bao bọc tất cả các thông tin khác của **extension**. Thẻ này có một số thuộc tính quan trọng:

• `type`: Xác định loại **extension** (ví dụ: `component`, `module`, `plugin`, `template`).
• `version`: Cho biết phiên bản Joomla mà **extension** được phát triển cho (ví dụ: `2.5`, `3.0`). Thuộc tính này không được sử dụng trong Joomla 4 trở lên.
• `method`: Xác định phương thức cài đặt (`install` hoặc `upgrade`). Nếu không có thuộc tính này, mặc định là `install`.
• `client`: Áp dụng cho module, xác định vị trí module sẽ được cài đặt (`site` hoặc `administrator`).
• `group`: Áp dụng cho plugin, xác định nhóm plugin (ví dụ: `system`, `content`).

Metadata

Metadata cung cấp thông tin chung về **extension**, bao gồm:

• ``: Tên của **extension** (ví dụ: `com_banners`).
• ``: Tên tác giả (ví dụ: `Joomla! Project`).
• ``: Ngày tạo hoặc phát hành (ví dụ: `April 2006`).
• ``: Thông tin bản quyền.
• ``: Thông tin giấy phép.
• ``: Địa chỉ email của tác giả.
• ``: URL đến website của tác giả.
• ``: Số phiên bản của **extension** (ví dụ: `1.6.0`).
• ``: Mô tả về **extension**. Đây là một trường có thể dịch được.
• ``: Tên nội bộ của **component**. Nếu bỏ qua, tên sẽ được làm sạch và sử dụng.

Lưu ý rằng `` và `` là các trường có thể dịch được, giúp hiển thị tên và mô tả của **extension** bằng ngôn ngữ của người dùng.

Files (Front-end và Back-end)

Thẻ `` được sử dụng để chỉ định các file cần sao chép vào thư mục front-end hoặc back-end. Bạn có thể sử dụng thuộc tính `folder` để chỉ định thư mục nguồn trong gói ZIP. Mỗi file cần sao chép được biểu diễn bằng một thẻ ``. Để sao chép một thư mục, bạn có thể sử dụng thẻ ``. Ví dụ:

    
        <files folder="from-folder">
            <filename>example.php</filename>
            <folder>examples</folder>
        </files>
    
    

Đối với **plugin**, thuộc tính `plugin` trên thẻ `` cần trỏ đến file chứa class của **plugin**.

Media Files

Thẻ `` được sử dụng để chỉ định các file media (ví dụ: hình ảnh, CSS, JavaScript) cần sao chép vào thư mục `media`. Điều này rất quan trọng để đảm bảo các tài sản web có thể truy cập được. Ví dụ:

    
        <media folder="media" destination="com_example">
            <filename>com_example_logo.png</filename>
            <folder>css</folder>
            <folder>js</folder>
        </media>
    
    

Administration Section

Phần `` được sử dụng để chỉ định các file và menu liên kết cho khu vực quản trị của **component**. Chỉ các **component** mới có phần này. Thẻ `

    
        <languages folder="language">
            <language tag="en-GB">en-GB/en-GB.com_example.ini</language>
        </languages>
    
    

    
         <install>
            <sql>
                <file driver="mysql" charset="utf8">sql/example.install.sql</file>
            </sql>
        </install>
        <uninstall>
            <sql>
                <file driver="mysql" charset="utf8">sql/example.uninstall.sql</file>
            </sql>
        </uninstall>

        <update>
        <schemas>
            <schemapath type="mysql">sql/updates/mysql</schemapath>
            <schemapath type="sqlsrv">sql/updates/sqlsrv</schemapath>
        </schemas>
    </update>
    
    

    
        <?xml version="1.0" encoding="utf-8"?>
        <extension type="library" method="upgrade" version="4.0">
            <name>My Test library.</name>
            <libraryname>mytest</libraryname>
            <files>
                <folder>Classes</folder>
                <folder>language</folder>
                <filename>mytest.php</filename>
            </files>
        </extension>