PrestaShop 1.7：自定義模塊中正確獲取並顯示分類鏈接

本教程旨在解決PrestaShop 1.7自定義模塊中，嘗試獲取並顯示分類鏈接時遇到的“Undefined index: link”錯誤。我們將詳細講解如何利用PrestaShop的Link類，在後端PHP代碼中將鏈接對像傳遞給Smarty模板，並在前端模板中正確調用getCategoryLink方法動態生成分類URL，確保鏈接的正確性和可訪問性。

理解“Undefined index: link”錯誤

在PrestaShop 1.7中，當開發者嘗試在自定義模塊或模板中顯示分類列表時，可能會使用Category::getNestedCategories()方法來獲取分類數據。這個方法返回的是一個包含分類ID、名稱、重寫URL（link_rewrite）等信息的嵌套數組。然而，這個數組中並沒有一個預生成的link鍵來直接存儲分類的完整URL。

當您在Smarty模板中直接嘗試訪問{$mainCategory.link}時，由於link這個鍵在Category::getNestedCategories()返回的數組中並不存在，Smarty會拋出Notice: Undefined index: link的錯誤。這意味著您需要手動生成這些分類的URL。

解決方案：利用PrestaShop的Link類

PrestaShop提供了一個強大的Link類（$this->context->link），它是生成商店內各種URL（包括產品、分類、CMS頁面等）的標準和推薦方式。使用Link類可以確保生成的URL是SEO友好的，並且能夠正確處理多語言、多店鋪以及URL重寫規則。

要解決“Undefined index: link”錯誤並正確生成分類鏈接，您需要執行以下兩個步驟：

1. 後端PHP代碼：將Link對像傳遞給Smarty

在您的PrestaShop模塊的PHP文件中（例如，在hook方法或renderWidget方法中），您需要將$this->context->link對象賦值給Smarty模板。這樣，Smarty模板就能訪問到Link類的方法。

 <?php // 假設這是您的模塊主文件中的某個方法，例如renderWidget 或hookDisplayHome
// ...

// 獲取所有分類數據$allCategories = Category::getNestedCategories(null, $this->context->language->id);

// 將分類數據和Link 對象賦值給Smarty
$this->context->smarty->assign(array(
    'allCategories' => $allCategories,
    'link' => $this->context->link, // 關鍵步驟：將Link 對象賦值給Smarty
));

// 渲染模板return $this->fetch('module:'.$this->name.'/views/templates/widget/block.tpl');

// ...
?>

2. 前端Smarty模板：使用Link對像生成URL

在您的.tpl模板文件中，現在可以通過您在PHP中賦值的{$link}變量來訪問Link對象的方法。使用getCategoryLink()方法可以根據分類的ID和重寫URL來生成完整的分類鏈接。

 {* views/templates/widget/block.tpl *}

{foreach from=$allCategories item=mainCategory}
   {* 生成主分類鏈接*}
   <a href="%7B%24link->getCategoryLink(%24mainCategory.id_category,%20%24mainCategory.link_rewrite)%7Cescape:'html':'UTF-8'%7D" title="{$mainCategory.name|escape:'htmlall':'UTF-8'}">
       {$mainCategory.name|escape:'htmlall':'UTF-8'}
   </a>

   {* 遍歷子分類（如果存在） *}
   {if isset($mainCategory.children) && !empty($mainCategory.children)}
       

{foreach from=$mainCategory.children item=subCategory}
• {$subCategory.name|escape:'htmlall':'UTF-8'}
{/foreach}

{/if} {/foreach}

代碼解釋：

• $link->getCategoryLink($mainCategory.id_category, $mainCategory.link_rewrite): 這是核心部分。它調用了Link對象的getCategoryLink方法，並傳入了當前分類的id_category（分類ID）和link_rewrite（分類的URL重寫名稱）。這兩個參數是生成分類URL所必需的。
• |escape:'html':'UTF-8': 這是Smarty的轉義修飾符。它用於將輸出的URL進行HTML實體轉義，以防止潛在的跨站腳本（XSS）攻擊。對於所有輸出到HTML的內容，尤其是鏈接和文本內容，強烈推薦使用此修飾符來增強安全性。
• |escape:'htmlall':'UTF-8': 用於對title屬性或顯示文本進行更全面的HTML轉義。

完整示例與註意事項

為了提供一個更完整的上下文，以下是一個簡單的PrestaShop 1.7模塊示例，演示如何實現上述邏輯。

模塊PHP文件(yourmodule.php)

 <?php if (!defined(&#39;_PS_VERSION_&#39;)) {
    exit;
}

class YourModule extends Module
{
    public function __construct()
    {
        $this->name = 'yourmodule';
        $this->tab = 'front_office_features';
        $this->version = '1.0.0';
        $this->author = 'Your Name';
        $this->need_instance = 0;
        $this->ps_versions_compliancy = [
            'min' => '1.7',
            'max' => _PS_VERSION_,
        ];
        $this->bootstrap = true;

        parent::__construct();

        $this->displayName = $this->l('My Custom Category Display Module');
        $this->description = $this->l('Displays categories with correct links.');

        $this->confirmUninstall = $this->l('Are you sure you want to uninstall?');
    }

    public function install()
    {
        return parent::install() &&
               $this->registerHook('displayHome'); // 註冊一個鉤子，例如在首頁顯示}

    public function uninstall()
    {
        return parent::uninstall();
    }

    /**
     * 鉤子方法，用於渲染模塊內容* @param array $params
     * @return string
     */
    public function hookDisplayHome($params)
    {
        // 調用renderWidget 方法來處理邏輯和渲染return $this->renderWidget(null, $params);
    }

    /**
     * 渲染模塊內容的實際方法* @param string|null $hookName
     * @param array $configuration
     * @return string
     */
    public function renderWidget($hookName = null, array $configuration = [])
    {
        // 獲取所有分類數據，包括嵌套結構$allCategories = Category::getNestedCategories(null, $this->context->language->id);

        // 將分類數據和Link 對象賦值給Smarty
        $this->context->smarty->assign(array(
            'allCategories' => $allCategories,
            'link' => $this->context->link, // 關鍵：將Link 對象賦值給Smarty
        ));

        // 渲染模塊的Smarty 模板return $this->fetch('module:'.$this->name.'/views/templates/widget/block.tpl');
    }
}

模塊Smarty模板文件(views/templates/widget/block.tpl)

 <div class="custom-category-list">
    <h2>所有分類</h2>
    <ul>
        {foreach from=$allCategories item=mainCategory}
            <li>
                <a href="%7B%24link->getCategoryLink(%24mainCategory.id_category,%20%24mainCategory.link_rewrite)%7Cescape:'html':'UTF-8'%7D" title="{$mainCategory.name|escape:'htmlall':'UTF-8'}">
                    {$mainCategory.name|escape:'htmlall':'UTF-8'}
                </a>

                {if isset($mainCategory.children) && !empty($mainCategory.children)}
                    <ul>
                        {foreach from=$mainCategory.children item=subCategory}
                            <li>
                                <a href="%7B%24link->getCategoryLink(%24subCategory.id_category,%20%24subCategory.link_rewrite)%7Cescape:'html':'UTF-8'%7D" title="{$subCategory.name|escape:'htmlall':'UTF-8'}">
                                    {$subCategory.name|escape:'htmlall':'UTF-8'}
                                </a>
                            </li>
                        {/foreach}
                    </ul>
                {/if}
            </li>
        {/foreach}
    </ul>
</div>

注意事項：

• 上下文($this->context):在PrestaShop模塊中，$this->context是一個全局對象，提供了對當前商店、語言、貨幣、鏈接等核心信息的訪問。確保您在模塊的正確上下文中訪問它。
• 性能考量: Category::getNestedCategories方法在分類數量巨大時可能會消耗較多資源。對於極大規模的網站，如果此模塊被頻繁調用，可能需要考慮引入緩存機制來優化性能。
• 安全性:始終對輸出到HTML的內容進行轉義(|escape:'html':'UTF-8')，特別是從數據庫中讀取或用戶輸入的數據，以防止XSS（跨站腳本）攻擊。這是Web開發中的最佳實踐。
• SEO友好:使用Link類生成的URL是PrestaShop推薦的SEO友好方式，它會自動處理URL重寫規則、多語言和多店鋪路徑，確保鏈接的正確性和搜索引擎的可索引性。

總結

解決PrestaShop自定義模塊中“Undefined index: link”錯誤的關鍵在於理解Category::getNestedCategories方法返回的數據結構，它不直接包含預生成的分類URL。正確的做法是利用PrestaShop提供的Link類，在模塊的PHP代碼中將其賦值給Smarty模板，然後在Smarty模板中使用{$link->getCategoryLink($category.id_category, $category.link_rewrite)}方法動態生成分類鏈接。遵循此方法不僅能解決錯誤，還能確保生成的URL是安全、SEO友好且符合PrestaShop最佳實踐的。

以上是PrestaShop 1.7：自定義模塊中正確獲取並顯示分類鏈接的詳細內容。更多資訊請關注PHP中文網其他相關文章！