创建Shipping Module

Magento系统自带了大概7种运费方式:平价、运费表、免运费、ups、usps、fedex、dhl等。不过这些依然无法满足我们的需求,这时候就需要创建一个shipping module 来实现了。创建一个shipping module 很简单,需要继承Mage_Shipping_Model_Carrier_Abstract抽象类, 实现Mage_Shipping_Model_Carrier_Interface接口类,这样就能利用函数collectRates来自定义计算运费的方式。这样就可以创建一个插件来自定义shipping method。

添加模块配置信息

首先,添加模块信息,创建文件app/etc/modules/Xbc_Ship.xml

 <config><modules><xbc_ship><active>true</active>
      <codepool>local</codepool>            
            <depends><mage_shipping></mage_shipping></depends> 
      <version>1.1.0</version></xbc_ship></modules></config> 

添加模块配置信息,创建文件app/code/local/Xbc/Ship/etc/config.xml

 <config><modules><xbc_ship><version>1.1.0</version></xbc_ship></modules> 
  <global>
    <helpers><ship><class>Xbc_Ship_Helper</class></ship></helpers> 
     <resources><ship_setup><setup><module>Xbc_Ship</module></setup> 
         <connection><use>core_setup</use></connection></ship_setup> 
      <ship_write><connection><use>core_write</use></connection></ship_write> 
      <ship_read><connection><use>core_read</use></connection></ship_read></resources> 
     <models><ship><class>Xbc_Ship_Model</class>
        <resourcemodel>ship_mysql4</resourcemodel></ship></models> 
  </global>    
     <default><carriers><cm_dhl><active>1</active>
                <debug>0</debug>
                <model>ship/carrier_cm_dhl</model>
                <name>DHL</name>
                <title>DHL</title>
                <description>DHL</description>
                <sort_order>0</sort_order></cm_dhl></carriers></default></config> 

实现自定义运费

创建文件app/code/local/Hofan/Ship/Model/Carrier/Cm/Dhl.php。

getConfigFlag('active')) {
                return false;
            }

            $result = Mage::getModel('shipping/rate_result');  
            $method = Mage::getModel('shipping/rate_result_method');  
            $method->setCarrier($this->_code);  
            $method->setCarrierTitle($this->getConfigData('title'));
            $method->setMethod($this->_code);  
            $method->setMethodTitle($this->getConfigData('name'));

            $debug = $this->getConfigData('debug');
            $rate = $this->getConfigData('rate');

            //get find the country id
            $country_id = $request->getDestCountryId();

            //Get all items
            $items = $request->getAllItems();
            $weight = $request->getPackageWeight();
            foreach ($items as $item){
                $_product = $item->getProduct();
                if ($_product instanceof Mage_Catalog_Model_Product) {
                    $product = Mage::getModel('catalog/product')->load($_product->getId());
                    if($_weight = $product->getWeight()){

                    }
                }
            }

            //get price
            $shippingPrice = 100;

            $method->setPrice($shippingPrice);
            $method->setCost($shippingPrice);
            $result->append($method);  
            return $result;  
        }  

        /**
         * Get allowed shipping methods
         *
         * @return array
         */
        public function getAllowedMethods()
        {
            return array($this->_code=>$this->getConfigData('name'));
        }
    }  

添加后台配置

如果完成了上面的步骤,你可以添加后台配置文件。创建文件app/code/local/Xbc/Ship/etc/system.xml

 <config><sections><carriers translate="label" module="ship"><groups><cm_dhl translate="label"><label>Hofan DHL</label>
                      <frontend_type>text</frontend_type>
                      <sort_order>0</sort_order>
                      <show_in_default>1</show_in_default>
                      <show_in_website>1</show_in_website>
                      <show_in_store>1</show_in_store>
                      <model>ship/carrier_cm_dhl</model>
                       <fields><active translate="label"><label>Enabled</label>
                                        <frontend_type>select</frontend_type>
                                        <source_model>adminhtml/system_config_source_yesno</source_model>
                                        <sort_order>10</sort_order>
                                        <show_in_default>1</show_in_default>
                                        <show_in_website>1</show_in_website>
                                        <show_in_store>1</show_in_store></active> 
                                 <debug translate="label"><label>Debug Mode</label>
                                        <frontend_type>select</frontend_type>
                                        <source_model>adminhtml/system_config_source_yesno</source_model>
                                        <sort_order>20</sort_order>
                                        <show_in_default>1</show_in_default>
                                        <show_in_website>1</show_in_website>
                                        <show_in_store>1</show_in_store></debug> 
                                 <title translate="label"><label>Title</label>
                                        <frontend_type>text</frontend_type>
                                        <sort_order>30</sort_order>
                                        <show_in_default>1</show_in_default>
                                        <show_in_website>1</show_in_website>
                                        <show_in_store>1</show_in_store></title> 
                                 <name translate="label"><label>Method Name</label>
                                        <frontend_type>text</frontend_type>
                                        <sort_order>40</sort_order>
                                        <show_in_default>1</show_in_default>
                                        <show_in_website>1</show_in_website>
                                        <show_in_store>1</show_in_store></name> 
                                 <description translate="label"><label>Description</label>
                                        <frontend_type>textarea</frontend_type>
                                        <sort_order>50</sort_order>
                                        <show_in_default>1</show_in_default>
                                        <show_in_website>1</show_in_website>
                                        <show_in_store>1</show_in_store></description> 
                                 <sort_order translate="label"><label>Sort Order</label>
                                        <frontend_type>text</frontend_type>
                                        <sort_order>100</sort_order>
                                        <show_in_default>1</show_in_default>
                                        <show_in_website>1</show_in_website>
                                        <show_in_store>1</show_in_store></sort_order></fields></cm_dhl></groups></carriers></sections></config> 

该插件在Magento CE 1.6.2上测试通过。

参考资料

Adding New Shipping Module In Magento

自定义Magento导航目录

Magento的默认主题中导航目录是垂直下拉式菜单:鼠标滑过时会显示下级菜单。实际上你如果要把菜单改成水平下拉式的话,最好的方式重写目录导航的block,自定义生成你所需要的导航样式。定义目录导航的文件位于/app/code/core/Mage/Catalog/Block/Navigation.php。主要由这renderCategoriesMenuHtml和_renderCategoryMenuItemHtml两个函数来实现。

函数renderCategoriesMenuHtml取出所有一级目录,然后丢给renderCategoryMenuItemHtml去循环判断是否有子目录,如果子目录是可显示的话,才能在前台显示。其实可以由一个递归函数来实现嘛。为此,我写一个小插件来实现这个功能。

首先添加插件的模块信息app/etc/modules/Cm_Menu.xml

 <config><modules><cm_menu><active>true</active>
      <codepool>local</codepool>
      <version>1.0.0</version></cm_menu></modules></config> 

添加模块配置信息,重写了catalog/navigation这个block

 <config><modules><cm_menu><version>1.0.0</version></cm_menu></modules> 
  <global><helpers><menu>
        <class>Cm_Menu_Helper</class>
      </menu></helpers> 
    <blocks><menu>
            <class>Cm_Menu_Block</class>
        </menu>

         <catalog><rewrite><navigation>Cm_Menu_Block_Navigation</navigation></rewrite></catalog></blocks></global></config>  

自定义renderMenu函数来生成导航。Cm_Menu_Block_Navigation 继承Mage_Catalog_Block_Navigation,这样就可以使用在phtml使用自定义的函数。

getStoreCategories() as $child) {
                if ($child->getIsActive()) {
                    $activeCategories[] = $child;
                }
            }
        }else{
            if (!$category->getIsActive()) {
                return '';
            }   
            // get all children
            if (Mage::helper('catalog/category_flat')->isEnabled()) {
                $children = (array)$category->getChildrenNodes();
            } else {
                $children = $category->getChildren();
            }
            foreach ($children as $child) {
                if ($child->getIsActive()) {
                    $activeCategories[] = $child;
                }
            }
        }
        $activeCategoriesCount = count($activeCategories);
        $hasActiveCategoriesCount = ($activeCategoriesCount > 0);
        //only check parent category 
        if($level == 0 && $category == ''){
            if (!$hasActiveCategoriesCount) {
                return '';
            }
        }
        $_html = '';
        $j = 0;
        if($level == 0 && $category == ''){
            foreach ($activeCategories as $category) {
                $_html .= $this->renderMenu( $level, $category , ($j == 0));
                $j++;
            }
            return $_html;
        }else{
            $_url = $this->getCategoryUrl($category);
            $_name = $this->escapeHtml($category->getName());
            //$_child = Mage::getModel( 'catalog/category' )->load($category->getId());
            //$_description = $_child->getDescription();
            if(!$_description){
                $_description = $_name;
            }
            $html = array();
            foreach ($activeCategories as $category) {
                $_html .= $this->renderMenu( $level + 1, $category , ($j == 0));
                $j++;
            }
            $classes = array();
            if ($isFirst) {
                $classes[] = 'fore';
            } 
            if($level == 0){
                $classes[] = 'item';
                $attributes = array();
                if (count($classes) > 0) {
                    $attributes['class'] = implode(' ', $classes);
                }
                $htmlLi = ' <div'; foreach="" ($attributes="" as="" $attrname="">$attrValue) {
                    $htmlLi .= ' ' . $attrName . '="' . str_replace('"', '\"', $attrValue) . '"';
                }
                $htmlLi .= '>';
                $html[] = $htmlLi;

                $html[] = '<span>';
                $html[] = '

### ';
                $html[] = '['.$_name.']('.$_url.' "'.$_description.'")';
                $html[] = '

';
                $html[] = '</span>';
                $html[] = '

<div class="i-mc">';
                $html[] = '

<div class="subitem">';
                $html[] = $_html;   
                $html[] = '</div>

';
                $html[] = '</div>

';
                $html[] = '';
            }
            if($level == 1){
                $attributes = array();
                if (count($classes) > 0) {
                    $attributes['class'] = implode(' ', $classes);
                }
                $htmlLi = ' <dl'; foreach="" ($attributes="" as="" $attrname="">$attrValue) {
                    $htmlLi .= ' ' . $attrName . '="' . str_replace('"', '\"', $attrValue) . '"';
                }
                $htmlLi .= '>';
                $html[] = $htmlLi;

                $html[] = '

<dt>';
                $html[] = '['.$_name.']('.$_url.' "'.$_description.'")';
                $html[] = '</dt>

';
                $html[] = '

<dd>';
                $html[] = $_html;
                $html[] = '</dd>

';
                $html[] = '';
            }
            if($level == 2){
                $html[] = '_';
                $html[] = '['.$_name.']('.$_url.' "'.$_description.'")';
                $html[] = '_';
            }
            $_html = implode("\n", $html);
            return $_html;
        }
    }
}
?></dl';></div';> 

在renderMenu函数中,函数有3个参数,$level,$category,$j。$level参数是目录的层级,参数$category是子目录的实例。目录的层级限制在3层以内,在第一次循环的的时候,$level=0,会从系统取出全部的一级目录分类,存入$activeCategories数组中,通过计算$activeCategories数组的个数来判断时候是否存在二级目录。如果存在二级目录,再丢给renderMenu函数自己,此时$level=0,$category参数是子目录的实例,根据不同的$level进行循环,得到最后的目录列表。

将block的type换成

在模板中只需要调用renderMenu函数

renderMenu();?>

本插件在Magento CE 1.6.2 上测试通过

Magento的Module layout update

在Magento中xml是模块配置的利器,有时开发一个Magento的模块时,需要添加模块的layout update。

添加前台的layout XML需要在模块的config.xml添加frontend节点。

<frontend><layout><updates><name><file>name.xml</file></name></updates></layout></frontend> 

添加后台的layout xml需要在config.xml添加adminhtml节点

<adminhtml><layout><updates><name><file>name.xml</file></name></updates></layout></adminhtml> 

需要注意的是name.xml的位置,Magento 查找layout文件的顺序为

/app/design/frontend/default/default/layout/name.xml
/app/design/frontend/base/default/layout/name.xml

推荐放在

/app/design/frontend/default/default/layout/name.xml</```
即可。

在name.xml文件中可以修改页面的布局。

<layout><customer_account_create><reference name="head"><action method="addItem" ifconfig="customer/address/enabled"><type>skin_js</type><name>js/name.js</name><params></params></action></reference></customer_account_create></layout>
“`

在这个name.xml中向head添加了一段js。神奇的地方在于可以在xml里自定义加载条件,如ifconfig属性。

Magento解析到该模块的layout xml时会判断ifconfig属性的值为true or false。根据ifconfig的值来决定是否执行addItem方法。

换成php语言的逻辑如下:

if(customer/address/enabled == true){
//exe addItem method
//add name.js to head
}

注意name.js的路径和name.xml的类似,同样是从查找顺序为:

/skin/frontend/default/default/js/name.js
/skin/frontend/base/default/js/name.js