核心概念：模板、布局、块

Magento 1.9 的页面渲染机制是基于三个核心组件的协同工作：布局、块 和 模板。

magento 1.9 模板
（图片来源网络，侵删）

  1. 布局

    • 作用：布局文件是 XML 文件，它定义了页面上有哪些“区域”（Block）以及这些区域应该显示什么“内容”（Template）。
    • 比喻：就像一张建筑蓝图，它规定了房子的结构（哪里是客厅，哪里是卧室），但并不规定客厅里沙发是什么颜色、什么款式。
    • 文件位置：app/design/frontend/{package}/{theme}/layout/ 目录下。
    • 关键元素：
      • <layout>: 根节点，定义布局名称。
      • <block>: 定义一个块，并指定其类型、名称和模板文件。
      • <reference>: 引用并修改一个已存在的块（向头部添加一个 JS 文件）。
      • <action>: 在一个块上执行一个操作（设置块的模板、添加一个子块）。

  2. 块

    • 作用：块是 PHP 类，负责处理页面的逻辑和业务数据，它将数据从模型中取出，并准备传递给模板文件进行渲染。
    • 比喻：是房子的“承重墙”和“水电系统”，它支撑结构，并准备好电力、水源等，为最终的装修（模板）提供基础。
    • 文件位置：核心块位于 app/code/core/Mage/Page/Block/，自定义块通常放在 app/code/local/{YourNamespace}/{YourModule}/Block/。
    • 关键方法：
      • get...(): 获取数据的方法，getTitle(), getProducts()。
      • set...(): 设置数据的方法。
      • getChildHtml(): 极其重要，用于渲染其子块，这是将布局文件中定义的父子关系转化为实际输出的核心方法。

  3. 模板

    • 作用：模板文件是 .phtml 文件，包含 HTML 和 PHP 代码，它负责接收来自块的数据，并将其格式化成最终的 HTML 输出到浏览器。
    • 比喻：就是房子的“内部装修”，它使用蓝图（布局）和水电系统（块）提供的数据，最终呈现出一个美观、功能完整的房间。
    • 文件位置：app/design/frontend/{package}/{theme}/template/ 目录下。
    • 语法：主要是 PHP 代码，用于循环、判断和输出变量的 echo。<?php echo $this->getTitle(); ?>。

三者关系总结： 布局 决定页面上放什么 块 和放在哪里，块 负责准备数据，模板 负责用这些数据生成最终的 HTML。

magento 1.9 模板
（图片来源网络，侵删）

文件结构

Magento 1.9 的主题文件结构遵循严格的命名约定，这有助于 Magento 自动加载正确的文件。

app/
└── design/
    └── frontend/
        └── {package_name}/
            └── {theme_name}/
                ├── layout/          # 布局文件
                │   ├── page.xml    # 全局页面布局（定义了 head, content, footer 等主要结构）
                │   ├── catalog.xml # 目录相关页面布局
                │   └── ...         # 其他模块的布局文件
                ├── template/       # 模板文件
                │   ├── page/       # 页面级别的模板
                │   │   ├── 1column.phtml
                │   │   ├── 2columns-left.phtml
                │   │   └── ...
                │   ├── catalog/    # 目录/产品相关的模板
                │   │   ├── product/
                │   │   │   └── view.phtml
                │   │   └── ...
                │   └── ...         # 其他模块的模板
                ├── skin/           # 静态资源文件（CSS, JS, images, fonts）
                │   ├── frontend/
                │   │   └── {package_name}/{theme_name}/
                │   │       ├── css/
                │   │       ├── js/
                │   │       └── images/
                │   └── ...
                └── locale/         # 语言包文件

重要说明：

  • {package_name}：包名，通常代表一个品牌或系列，如 default, mycompany。
  • {theme_name}：主题名，如 default, modern, custom。
  • skin 目录：存放 CSS、JavaScript 和图片等静态文件，在模板中，通常使用 Mage::getDesign()->getSkinUrl('images/my-image.jpg') 来获取其 URL。

工作流程：一个页面的诞生

以一个产品详情页为例,其渲染流程如下：

  1. URL 请求：用户访问 http://yourstore.com/product/example-product.html。
  2. 路由与控制器：Magento 的路由系统将 URL 解析到对应的控制器，Mage_Catalog_ProductController 的 viewAction。
  3. 加载布局：在 viewAction 中，代码会调用 $this->loadLayout()，这个方法会执行以下操作：
    • 加载默认的布局文件 page.xml。
    • 根据当前请求的模块（这里是 catalog）和动作（view），加载 catalog.xml 中对应的布局更新句柄，<catalog_product_view />。
    • 将所有 XML 文件合并成一个完整的布局对象。
  4. 生成 HTML：调用 $this->renderLayout()，这个方法会：
    • 从布局对象中找到根块（通常是 root 块，其模板在 page/ 目录下，如 2columns-left.phtml）。
    • 调用根块的 toHtml() 方法。
    • 根块的 toHtml() 方法会使用 getChildHtml() 方法来渲染其所有子块（如 header, left, content, footer）。
    • 每个子块同样会调用 getChildHtml()，直到所有块都被渲染。
    • 在渲染过程中,每个块会加载其指定的 .phtml 模板文件，并执行其中的 PHP 代码，将数据输出为 HTML。

常用模板代码和技巧

在 .phtml 模板文件中，你经常需要使用以下代码：

获取块对象

$this 在模板中始终指向当前块的实例。

// 获取当前块的标题
<?php echo $this->getTitle(); ?>
// 调用块的方法
<?php echo $this->getSomeCustomMethod(); ?>

渲染子块

这是模板结构化的核心。

// 在父模板中，2columns-left.phtml
<div class="col-main">
    <?php echo $this->getChildHtml('content') ?>
</div>
<div class="col-left">
    <?php echo $this->getChildHtml('left') ?>
</div>

获取 URL

// 获取皮肤目录下的 URL
<img src="<?php echo $this->getSkinUrl('images/my-logo.png') ?>" alt="Logo" />
// 获取指定路由的 URL
<a href="<?php echo $this->getUrl('customer/account') ?>">My Account</a>
// 获取当前页面的 URL
<a href="<?php echo $this->getUrl('*/*/*', ['_current' => true, '_use_rewrite' => true]) ?>">Refresh</a>

获取静态块

静态块是在后台 CMS 中创建的可复用内容片段。

// 'home_banner' 是静态块的标识符
<?php echo $this->getLayout()->createBlock('cms/block')->setBlockId('home_banner')->toHtml(); ?>

获取产品/分类信息

通常在循环中,$_product 或 $_category 变量已经由块准备好。

<?php foreach ($_products as $_product): ?>
    <h2><?php echo $_product->getName() ?></h2>
    <p><?php echo $_product->getShortDescription() ?></p>
    <img src="<?php echo $this->helper('catalog/image')->init($_product, 'small_image')->resize(200); ?>" />
    <span><?php echo $this->getPriceHtml($_product, true) ?></span>
<?php endforeach; ?>

调用辅助函数

Helper 是用来封装可复用逻辑的类。

// 调用名为 'data' 的 helper 的 'getCurrencyRate' 方法
<?php echo $this->helper('data')->getCurrencyRate(); ?>
// 调用 'catalog' helper 的 'getPriceHtml' 方法
<?php echo $this->helper('catalog')->getPriceHtml($_product); ?>

最佳实践和注意事项

  1. 不要修改核心文件：永远不要直接修改 app/code/core/ 目录下的文件，所有的定制都应该在 app/design/frontend/ (主题) 或 app/code/local/ (模块/块) 中进行。
  2. 重写而非复制：当你需要修改一个核心块（如 Mage_Catalog_Block_Product_List）时，最佳实践是创建一个自己的块类来重写它，而不是直接复制和修改核心文件，这样可以避免升级 Magento 时被覆盖。
  3. 使用缓存：Magento 1.9 严重依赖缓存（Layout XML, Block HTML, FPC），修改模板后，记得在后台 System > Cache Management 中刷新相应的缓存，否则你可能看不到更改。
  4. 利用 Magento 的内置功能：尽量使用 Magento 提供的 Block 和 Helper，而不是自己从头写 PHP 逻辑，显示产品列表，使用 catalog/product_list 块比自己写循环和数据库查询要好得多。
  5. 保持结构清晰：遵循 Magento 的文件结构，将模板、布局、静态资源文件放在正确的位置，方便自己和他人维护。
  6. 使用开发者工具：安装并使用 Magento Template Hints（在后台 > System > Configuration > Developer > Debug 中开启），开启后，页面上会显示每个块对应的模板文件路径和类名，极大地加快了定位模板的速度。

希望这份详细的指南能帮助你更好地理解和操作 Magento 1.9 的模板系统！