magento 自定义url路径 和 filter data 小结

背景是往一个第三方的搜索插件里面加入filter功能。

首先是路径，插件自己定义了一个router，类似于cms。那首先说说router好了，从入口一路追查的话，会发现最后进入的是Mage_Core_Controller_Varien_Front类下面的dispatch()函数。

  public function dispatch()
    {
        $request = $this->getRequest();

        // If pre-configured, check equality of base URL and requested URL
        $this->_checkBaseUrl($request);

        $request->setPathInfo()->setDispatched(false);

        $this->_getRequestRewriteController()->rewrite();

        Varien_Profiler::start('mage::dispatch::routers_match');
        $i = 0;
        while (!$request->isDispatched() && $i++ < 100) {
            foreach ($this->_routers as $router) {
                /** @var $router Mage_Core_Controller_Varien_Router_Abstract */
                if ($router->match($request)) {
                    break;
                }
            }
        }
        Varien_Profiler::stop('mage::dispatch::routers_match');
        if ($i>100) {
            Mage::throwException('Front controller reached 100 router match iterations');
        }
        // This event gives possibility to launch something before sending output (allow cookie setting)
        Mage::dispatchEvent('controller_front_send_response_before', array('front'=>$this));
        Varien_Profiler::start('mage::app::dispatch::send_response');
        $this->getResponse()->sendResponse();
        Varien_Profiler::stop('mage::app::dispatch::send_response');
        Mage::dispatchEvent('controller_front_send_response_after', array('front'=>$this));
        return $this;
    }

前面的代码是把url链接里的各项参数放到request类里面，方便后面调用，从第14行开始，magento会把所有继承自Mage_Core_Controller_Varien_Router_Abstract类的函数拉出来一个个循环match函数，直到找到一个匹配request的。

也就是说假如我想自定义路径，就可以继承Mage_Core_Controller_Varien_Router_Abstract类，然后在match函数里写上自己的路由规则，一旦匹配就跳转到自己想他去的controller类。

不过很显然插件自定义的router并不能很好的完成filter的工作，首先贴上，插件的原来的代码：

 public function match(Zend_Controller_Request_Http $request)
    {
        $identifier = trim($request->getPathInfo(), '/');

        $condition = new Varien_Object(array(
            'identifier' => $identifier,
            'continue' => true,
        ));

        $identifier = $condition->getIdentifier();

        if ($condition->getRedirectUrl()) {
            Mage::app()->getFrontController()->getResponse()
                ->setRedirect($condition->getRedirectUrl())
                ->sendResponse();
            $request->setDispatched(true);

            return true;
        }

        if (!$condition->getContinue()) {
            return false;
        }

        $page = Mage::getModel('searchlandingpage/page')->checkIdentifier($identifier);
//代码原理很简单，对url里的路径拆解，然后查询这个路径是否在自定义的表里面，checkIdentifier（）就是sql查询。
        if (!$page) {
            return false;
        }

        $request->setModuleName('searchlandingpage')
            ->setControllerName('page')
            ->setActionName('view')
            ->setParam('q', $page->getQueryText())
            ->setParam('id', $page->getId());
//若查询到了就设置request里的各项参数，告诉magento跳转到这里去
        $request->setAlias(
            Mage_Core_Model_Url_Rewrite::REWRITE_REQUEST_PATH_ALIAS,
            $identifier
        );

        return true;
    }

修改后：

 public function match(Zend_Controller_Request_Http $request)
    {
        $helper = Mage::helper('ajaxpriceslider');
        $suffix = Mage::getStoreConfig('catalog/seo/category_url_suffix');
        $identifier = ltrim($request->getPathInfo(), '/');
        $identifier = substr($identifier, 0, strlen($identifier) - strlen($suffix));
        $urlSplit = explode($helper->getRoutingSuffix(), $identifier, 2);
        
        if(isset($urlSplit[0])){
            $cat = $urlSplit[0];
        }else{
            $cat = $identifier;
        }
//这里主要作用是给自定义的路径添加magento的后缀， 如  xxx.html 之类

        $condition = new Varien_Object(array(
            'identifier' => $cat,
            'continue' => true,
        ));

        $cat = $condition->getIdentifier();

        if ($condition->getRedirectUrl()) {
            Mage::app()->getFrontController()->getResponse()
                ->setRedirect($condition->getRedirectUrl())
                ->sendResponse();
            $request->setDispatched(true);

            return true;
        }

        if (!$condition->getContinue()) {
            return false;
        }

        $page = Mage::getModel('searchlandingpage/page')->checkIdentifier($cat);

        if (!$page) {
            return false;
        }

        $request->setModuleName('searchlandingpage')
            ->setControllerName('page')
            ->setActionName('view')
            ->setParam('q', $page->getQueryText())
            ->setParam('id', $page->getId());

        $request->setAlias(
            Mage_Core_Model_Url_Rewrite::REWRITE_REQUEST_PATH_ALIAS,
            $cat.$suffix
        );
　　　　// 解析url参数，例如xxx.com/search/chiken_run/shopby/color/brown,green,white-and-green.html的网址，shopby后面的参数会被解析成array('color'=>'brown,green,white-and-green')
        $params = explode('/', trim($urlSplit[1], '/'));
        $layerParams = array();
        $total = count($params);
        for ($i = 0; $i < $total - 1; $i++) {
            if (isset($params[$i + 1])) {
                $layerParams[$params[$i]] = urldecode($params[$i + 1]);
                ++$i;
            }
        }

        
        $layerParams += $request->getPost();
        $request->setParams($layerParams);

        // 这个生成链接用
        Mage::register('layer_params', $layerParams);
        $controllerClassName = $this->_validateControllerClassName('Mirasvit_SearchLandingPage', 'page');

        $controllerInstance =  Mage::getControllerInstance($controllerClassName, $request, $this->getFront()->getResponse());
        // 这个是立即执行自己定义的controller类的view函数，不这样做的话，magento会继续加载两个系统router  然后修改了$params,导致我删选数据出问题
        $request->setDispatched(true);
        $controllerInstance->dispatch('view');
        
        return true;
    }

以上路径修改完了，在点击删选的时候 ajax寻址就能寻到了，但是返回的数据还是有问题的，这时候就需要修改 刚刚定义的controller下面的view函数了。

其实修改就一步，将$this->renderLayout();修改成

　　　　　　if ($this->getRequest()->isAjax()) {
                $listing = $this->getLayout()->getBlock('search_result_list')->toHtml();//根据页面的layout不同，这里的getBlock也会不同，下面也是
                $layer = $this->getLayout()->getBlock('catalogsearch.leftnav')->toHtml();

                // Fix urls that contain '___SID=U'
                $urlModel = Mage::getSingleton('core/url');
                $listing = $urlModel->sessionUrlVar($listing);
                $layer = $urlModel->sessionUrlVar($layer);

                $response = array(
                    'listing' => $listing,
                    'layer' => $layer
                );

                $this->getResponse()->setHeader('Content-Type', 'application/json', true);
                $this->getResponse()->setBody(json_encode($response));
            } else {
                $this->renderLayout();
            }

到这一步删选功能正常了，至于他是如何工作的，我有空补上