Zend Framework动作助手Redirector用法。分享给大家供大家参考,具体如下:
Redirector 提供另一种实现方式,帮助程序重定向到内部或者外部页面;
转向器(Redirector)助手让你使用一个转向器对象帮助程序重定向到新的URL。与_redirect()方法相比,它具有多项优势。例如能够在转向器对象中预先配置整个站点的行为,或者使用与Zend_Controller_Action::_forward()相似的gotoSimple($action, $controller, $module, $params)接口。
转向器拥有影响重定向行为的大量方法:
setCode() 设置重定向过程中使用的HTTP响应码。
setExit() 在重定向后强制执行exit()方法。默认已设定。
setGotoSimple()设置默认的URL,当没有提供参数给gotoSimple()方法时转向该URL。可以使用类似Zend_Controller_Action::_forward()的API:setGotoSimple($action, $controller = null, $module = null, array $params = array());
setGotoRoute()设置基于一个注册路由器的URL。通过传入一个键/值数组和一个路由器名,它将根据路由器的类型和定义来组织URL。
setGotoUrl()设置默认的URL,当没有参数传入gotoUrl(),将使用该URL。接受单个URL字符串。
setPrependBase()在setGotoUrl()、gotoUrl()或者gotoUrlAndExit()指定的URL前面,加入请求对象的基地址(base URL)。
setUseAbsoluteUri()强制转向器在重定向时使用绝对的URI。当该选项设定后,将使用$_SERVER[‘HTTP_HOST’]、 $_SERVER[‘SERVER_PORT’]和 $_SERVER[‘HTTPS‘]以及重定向方法指定的URL,来形成一个完整的URI。该选项目前默认关闭,将来的版本可能会默认开启。
此外,转向器中还有大量方法来执行实际的重定向。
gotoSimple()使用setGotoSimple()(类似_forward()的API)来构建URL并执行重定向。
gotoRoute()使用setGotoRoute()(路由组装route-assembly)来构建URL并执行重定向。
gotoUrl()使用setGotoUrl() URL字符串)来构造URL并执行重定向。
最后,你可以在任何时刻使用getRedirectUrl()确定当前的重定向URL。
基础用例
Example #5 设定选项
这个例子改变了几个选项,包括设定重定向时使用的HTTP状态码为303,重定向时不默认退出,以及定义了默认的URL供重定向使用。
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 | classSomeController extendsZend_Controller_Action{  /**   * Redirector - defined for code completion   *   * @var Zend_Controller_Action_Helper_Redirector   */  {    $this->_redirector = $this->_helper->getHelper('Redirector');    // Set the default options for the redirector    // Since the object is registered in the helper broker, these    // become relevant for all actions from this point forward    $this->_redirector->setCode(303)             ->setExit(false)             ->setGotoSimple("this-action",                     "some-controller");  }  publicfunctionmyAction()  {    /* do some stuff */    // Redirect to a previously registered URL, and force an exit    // to occur when done:    $this->_redirector->redirectAndExit();    return; // never reached  }} | 
Example #6 使用默认设定
这个例子假定使用默认设定,也就意味着任何重定向将导致立即退出。
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | // ALTERNATIVE EXAMPLEclassAlternativeController extendsZend_Controller_Action{  /**   * Redirector - defined for code completion   *   * @var Zend_Controller_Action_Helper_Redirector   */  protected$_redirector= null;  publicfunctioninit()  {    $this->_redirector = $this->_helper->getHelper('Redirector');  }  publicfunctionmyAction()  {    /* do some stuff */    $this->_redirector      ->gotoUrl('/my-controller/my-action/param1/test/param2/test2');    return; // never reached since default is to goto and exit  }} | 
Example #7 使用goto()的_forward()API
gotoSimple()’s API 模拟了Zend_Controller_Action::_forward()。主要的不同在于它通过传入的参数构造URL,使用默认路由器的默认格式:module/:controller/:action/*。然后重定向而不是继续动作链循环。
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | classForwardController extendsZend_Controller_Action{  /**   * Redirector - defined for code completion   *   * @var Zend_Controller_Action_Helper_Redirector   */  protected$_redirector= null;  publicfunctioninit()  {    $this->_redirector = $this->_helper->getHelper('Redirector');  }  publicfunctionmyAction()  {    /* do some stuff */    // Redirect to 'my-action' of 'my-controller' in the current    // module, using the params param1 => test and param2 => test2    $this->_redirector->gotoSimple('my-action',    'my-controller',    null,    array('param1'=> 'test',       'param2'=> 'test2'       )    );  }} | 
Example #8 通过gotoRoute()使用路由组装(route assembly)
下面的例子使用了路由器的assemble()方法,基于传入参数的关联数组来创建URL。假定下面的路由已经注册:
| 1 2 3 4 5 6 7 |   'blog/:year/:month/:day/:id',  array('controller'=> 'archive',     'module'=> 'blog',     'action'=> 'view'));$router->addRoute('blogArchive', $route); | 
给定一个数组,其中年份为2006,月份为4,日期为24,id为42,据此可以组装URL/blog/2006/4/24/42。
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | classBlogAdminController extendsZend_Controller_Action{  /**   * Redirector - defined for code completion   *   * @var Zend_Controller_Action_Helper_Redirector   */  protected$_redirector= null;  publicfunctioninit()  {    $this->_redirector = $this->_helper->getHelper('Redirector');  }  publicfunctionreturnAction()  {    /* do some stuff */    // Redirect to blog archive. Builds the following URL:    // /blog/2006/4/24/42    $this->_redirector->gotoRoute(      array('year'=> 2006,         'month'=> 4,         'day'=> 24,         'id'=> 42),      'blogArchive'    );  }} | 
Zend_Controller_Action_Helper_Redirector的源码。
通过源代码不难看出实现方法,以及常见的使用方法。
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 | <?php/** * @see Zend_Controller_Action_Helper_Abstract */require_once'Zend/Controller/Action/Helper/Abstract.php';/** * @category  Zend * @package  Zend_Controller * @subpackage Zend_Controller_Action_Helper * @copyright Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com) * @license  http://framework.zend.com/license/new-bsd   New BSD License */classZend_Controller_Action_Helper_Redirector extendsZend_Controller_Action_Helper_Abstract{  /**   * HTTP status code for redirects   * @var int   */  protected$_code= 302;  /**   * Whether or not calls to _redirect() should exit script execution   * @var boolean   */  protected$_exit= true;  /**   * Whether or not _redirect() should attempt to prepend the base URL to the   * passed URL (if it's a relative URL)   * @var boolean   */  protected$_prependBase= true;  /**   * Url to which to redirect   * @var string   */  protected$_redirectUrl= null;  /**   * Whether or not to use an absolute URI when redirecting   * @var boolean   */  protected$_useAbsoluteUri= false;  /**   * Whether or not to close the session before exiting   * @var boolean   */  protected$_closeSessionOnExit= true;  /**   * Retrieve HTTP status code to emit on {@link _redirect()} call   *   * @return int   */  publicfunctiongetCode()  {    return$this->_code;  }  /**   * Validate HTTP status redirect code   *   * @param int $code   * @throws Zend_Controller_Action_Exception on invalid HTTP status code   * @return true   */  protectedfunction_checkCode($code)  {    $code= (int)$code;    if((300 > $code) || (307 < $code) || (304 == $code) || (306 == $code)) {      require_once'Zend/Controller/Action/Exception.php';      thrownewZend_Controller_Action_Exception('Invalid redirect HTTP status code ('. $code. ')');    }    returntrue;  }  /**   * Retrieve HTTP status code for {@link _redirect()} behaviour   *   * @param int $code   * @return Zend_Controller_Action_Helper_Redirector Provides a fluent interface   */  publicfunctionsetCode($code)  {    $this->_checkCode($code);    $this->_code = $code;    return$this;  }  /**   * Retrieve flag for whether or not {@link _redirect()} will exit when finished.   *   * @return boolean   */  publicfunctiongetExit()  {    return$this->_exit;  }  /**   * Retrieve exit flag for {@link _redirect()} behaviour   *   * @param boolean $flag   * @return Zend_Controller_Action_Helper_Redirector Provides a fluent interface   */  publicfunctionsetExit($flag)  {    $this->_exit = ($flag) ? true : false;    return$this;  }  /**   * Retrieve flag for whether or not {@link _redirect()} will prepend the   * base URL on relative URLs   *   * @return boolean   */  publicfunctiongetPrependBase()  {    return$this->_prependBase;  }  /**   * Retrieve 'prepend base' flag for {@link _redirect()} behaviour   *   * @param boolean $flag   * @return Zend_Controller_Action_Helper_Redirector Provides a fluent interface   */  publicfunctionsetPrependBase($flag)  {    $this->_prependBase = ($flag) ? true : false;    return$this;  }  /**   * Retrieve flag for whether or not {@link redirectAndExit()} shall close the session before   * exiting.   *   * @return boolean   */  publicfunctiongetCloseSessionOnExit()  {    return$this->_closeSessionOnExit;  }  /**   * Set flag for whether or not {@link redirectAndExit()} shall close the session before exiting.   *   * @param boolean $flag   * @return Zend_Controller_Action_Helper_Redirector Provides a fluent interface   */  publicfunctionsetCloseSessionOnExit($flag)  {    $this->_closeSessionOnExit = ($flag) ? true : false;    return$this;  }  /**   * Return use absolute URI flag   *   * @return boolean   */  publicfunctiongetUseAbsoluteUri()  {    return$this->_useAbsoluteUri;  }  /**   * Set use absolute URI flag   *   * @param boolean $flag   * @return Zend_Controller_Action_Helper_Redirector Provides a fluent interface   */  publicfunctionsetUseAbsoluteUri($flag= true)  {    $this->_useAbsoluteUri = ($flag) ? true : false;    return$this;  }  /**   * Set redirect in response object   *   * @return void   */  protectedfunction_redirect($url)  {      $host= (isset($_SERVER['HTTP_HOST'])?$_SERVER['HTTP_HOST']:'');      $proto= (isset($_SERVER['HTTPS'])&&$_SERVER['HTTPS']!=="off") ? 'https': 'http';      $port= (isset($_SERVER['SERVER_PORT'])?$_SERVER['SERVER_PORT']:80);      $uri= $proto. '://'. $host;      if((('http'== $proto) && (80 != $port)) || (('https'== $proto) && (443 != $port))) {        // do not append if HTTP_HOST already contains port        if(strrchr($host, ':') === false) {          $uri.= ':'. $port;        }      }      $url= $uri. '/'. ltrim($url, '/');    }    $this->_redirectUrl = $url;    $this->getResponse()->setRedirect($url, $this->getCode());  }  /**   * Retrieve currently set URL for redirect   *   * @return string   */  publicfunctiongetRedirectUrl()  {    return$this->_redirectUrl;  }  /**   * Determine if the baseUrl should be prepended, and prepend if necessary   *   * @param string $url   * @return string   */  protectedfunction_prependBase($url)  {    if($this->getPrependBase()) {      $request= $this->getRequest();        $base= rtrim($request->getBaseUrl(), '/');        if(!empty($base) && ('/'!= $base)) {          $url= $base. '/'. ltrim($url, '/');        } else{          $url= '/'. ltrim($url, '/');        }      }    }    return$url;  }  /**   * Set a redirect URL of the form /module/controller/action/params   *   * @param string $action   * @param string $controller   * @param string $module   * @param array $params   * @return void   */  publicfunctionsetGotoSimple($action, $controller= null, $module= null, array$params= array())  {    $dispatcher= $this->getFrontController()->getDispatcher();    $request= $this->getRequest();    $curModule= $request->getModuleName();    $useDefaultController= false;    if(null === $controller&& null !== $module) {      $useDefaultController= true;    }    if(null === $module) {      $module= $curModule;    }    if($module== $dispatcher->getDefaultModule()) {      $module= '';    }    if(null === $controller&& !$useDefaultController) {      $controller= $request->getControllerName();      if(empty($controller)) {        $controller= $dispatcher->getDefaultControllerName();      }    }    $params[$request->getModuleKey()]   = $module;    $params[$request->getControllerKey()] = $controller;    $params[$request->getActionKey()]   = $action;    $router= $this->getFrontController()->getRouter();    $url= $router->assemble($params, 'default', true);    $this->_redirect($url);  }  /**   * Build a URL based on a route   *   * @param array  $urlOptions   * @param string $name Route name   * @param boolean $reset   * @param boolean $encode   * @return void   */  publicfunctionsetGotoRoute(array$urlOptions= array(), $name= null, $reset= false, $encode= true)  {    $router= $this->getFrontController()->getRouter();    $url= $router->assemble($urlOptions, $name, $reset, $encode);    $this->_redirect($url);  }  /**   * Set a redirect URL string   *   * By default, emits a 302 HTTP status header, prepends base URL as defined   * in request object if url is relative, and halts script execution by   * calling exit().   *   * $options is an optional associative array that can be used to control   * redirect behaviour. The available option keys are:   * - exit: boolean flag indicating whether or not to halt script execution when done   * - prependBase: boolean flag indicating whether or not to prepend the base URL when a relative URL is provided   * - code: integer HTTP status code to use with redirect. Should be between 300 and 307.   *   * _redirect() sets the Location header in the response object. If you set   * the exit flag to false, you can override this header later in code   * execution.   *   * If the exit flag is true (true by default), _redirect() will write and   * close the current session, if any.   *   * @param string $url   * @param array $options   * @return void   */  publicfunctionsetGotoUrl($url, array$options= array())  {    // prevent header injections    $url= str_replace(array("n", "r"), '', $url);    if(null !== $options) {      if(isset($options['exit'])) {        $this->setExit(($options['exit']) ? true : false);      }      if(isset($options['prependBase'])) {        $this->setPrependBase(($options['prependBase']) ? true : false);      }      if(isset($options['code'])) {        $this->setCode($options['code']);      }    }    // If relative URL, decide if we should prepend base URL    if(!preg_match('|^[a-z]+://|', $url)) {      $url= $this->_prependBase($url);    }    $this->_redirect($url);  }  /**   * Perform a redirect to an action/controller/module with params   *   * @param string $action   * @param string $controller   * @param string $module   * @param array $params   * @return void   */  publicfunctiongotoSimple($action, $controller= null, $module= null, array$params= array())  {    $this->setGotoSimple($action, $controller, $module, $params);    if($this->getExit()) {      $this->redirectAndExit();    }  }  /**   * Perform a redirect to an action/controller/module with params, forcing an immdiate exit   *   * @param mixed $action   * @param mixed $controller   * @param mixed $module   * @param array $params   * @return void   */  publicfunctiongotoSimpleAndExit($action, $controller= null, $module= null, array$params= array())  {    $this->setGotoSimple($action, $controller, $module, $params);    $this->redirectAndExit();  }  /**   * Redirect to a route-based URL   *   * Uses route's assemble method tobuild the URL; route is specified by $name;   * default route is used if none provided.   *   * @param array  $urlOptions Array of key/value pairs used to assemble URL   * @param string $name   * @param boolean $reset   * @param boolean $encode   * @return void   */  publicfunctiongotoRoute(array$urlOptions= array(), $name= null, $reset= false, $encode= true)  {    $this->setGotoRoute($urlOptions, $name, $reset, $encode);    if($this->getExit()) {      $this->redirectAndExit();    }  }  /**   * Redirect to a route-based URL, and immediately exit   *   * Uses route's assemble method tobuild the URL; route is specified by $name;   * default route is used if none provided.   *   * @param array  $urlOptions Array of key/value pairs used to assemble URL   * @param string $name   * @param boolean $reset   * @return void   */  publicfunctiongotoRouteAndExit(array$urlOptions= array(), $name= null, $reset= false)  {    $this->setGotoRoute($urlOptions, $name, $reset);    $this->redirectAndExit();  }  /**   * Perform a redirect to a url   *   * @param string $url   * @param array $options   * @return void   */  publicfunctiongotoUrl($url, array$options= array())  {    $this->setGotoUrl($url, $options);    if($this->getExit()) {      $this->redirectAndExit();    }  }  /**   * Set a URL string for a redirect, perform redirect, and immediately exit   *   * @param string $url   * @param array $options   * @return void   */  publicfunctiongotoUrlAndExit($url, array$options= array())  {    $this->setGotoUrl($url, $options);    $this->redirectAndExit();  }  /**   * exit(): Perform exit for redirector   *   * @return void   */  publicfunctionredirectAndExit()  {    if($this->getCloseSessionOnExit()) {      // Close session, if started      if(class_exists('Zend_Session', false) && Zend_Session::isStarted()) {        Zend_Session::writeClose();      } elseif(isset($_SESSION)) {        session_write_close();      }    }    $this->getResponse()->sendHeaders();    exit();  }  /**   * direct(): Perform helper when called as   * $this->_helper->redirector($action, $controller, $module, $params)   *   * @param string $action   * @param string $controller   * @param string $module   * @param array $params   * @return void   */  publicfunctiondirect($action, $controller= null, $module= null, array$params= array())  {    $this->gotoSimple($action, $controller, $module, $params);  }  /**   * Overloading   *   * Overloading for old 'goto', 'setGoto', and 'gotoAndExit' methods   *   * @param string $method   * @param array $args   * @return mixed   * @throws Zend_Controller_Action_Exception for invalid methods   */  publicfunction__call($method, $args)  {    $method= strtolower($method);    if('goto'== $method) {      returncall_user_func_array(array($this, 'gotoSimple'), $args);    }    if('setgoto'== $method) {      returncall_user_func_array(array($this, 'setGotoSimple'), $args);    }    if('gotoandexit'== $method) {      returncall_user_func_array(array($this, 'gotoSimpleAndExit'), $args);    }    require_once'Zend/Controller/Action/Exception.php';    thrownewZend_Controller_Action_Exception(sprintf('Invalid method "%s" called on redirector', $method));  }} | 
联系信息:邮箱aoxolcom@163.com或见网站底部。




















请登录后发表评论
注册
社交帐号登录