<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>The routerShutdown purpose</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="yaf-plugin-abstract.preresponse.html">Yaf_Plugin_Abstract::preResponse</a></div>
<div class="next" style="text-align: right; float: right;"><a href="yaf-plugin-abstract.routerstartup.html">Yaf_Plugin_Abstract::routerStartup</a></div>
<div class="up"><a href="class.yaf-plugin-abstract.html">Yaf_Plugin_Abstract</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="yaf-plugin-abstract.routershutdown" class="refentry">
<div class="refnamediv">
<h1 class="refname">Yaf_Plugin_Abstract::routerShutdown</h1>
<p class="verinfo">(Yaf >=1.0.0)</p><p class="refpurpose"><span class="refname">Yaf_Plugin_Abstract::routerShutdown</span> — <span class="dc-title">The routerShutdown purpose</span></p>
</div>
<div class="refsect1 description" id="refsect1-yaf-plugin-abstract.routershutdown-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>Yaf_Plugin_Abstract::routerShutdown</strong></span>
( <span class="methodparam"><span class="type"><a href="class.yaf-request-abstract.html" class="type Yaf_Request_Abstract">Yaf_Request_Abstract</a></span> <code class="parameter">$request</code></span>
, <span class="methodparam"><span class="type"><a href="class.yaf-response-abstract.html" class="type Yaf_Response_Abstract">Yaf_Response_Abstract</a></span> <code class="parameter">$response</code></span>
)</div>
<p class="para rdfs-comment">
This hook will be trigged after the route process finished, this hook
is usually used for login check.
</p>
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function is
currently not documented; only its argument list is available.
</p></div>
</div>
<div class="refsect1 parameters" id="refsect1-yaf-plugin-abstract.routershutdown-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">request</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">response</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-yaf-plugin-abstract.routershutdown-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
</p>
</div>
<div class="refsect1 examples" id="refsect1-yaf-plugin-abstract.routershutdown-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-4155">
<p><strong>Example #1 <span class="function"><strong>Yaf_Plugin_Abstract::routerShutdown()</strong></span>example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">class </span><span style="color: #0000BB">UserInitPlugin </span><span style="color: #007700">extends </span><span style="color: #0000BB">Yaf_Plugin_Abstract </span><span style="color: #007700">{<br /><br /> public function </span><span style="color: #0000BB">routerShutdown</span><span style="color: #007700">(</span><span style="color: #0000BB">Yaf_Request_Abstract $request</span><span style="color: #007700">, </span><span style="color: #0000BB">Yaf_Response_Abstract $response</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$controller </span><span style="color: #007700">= </span><span style="color: #0000BB">$request</span><span style="color: #007700">-></span><span style="color: #0000BB">getControllerName</span><span style="color: #007700">();<br /><br /> </span><span style="color: #FF8000">/**<br /> * Use access controller is unecessary for APIs<br /> */<br /> </span><span style="color: #007700">if (</span><span style="color: #0000BB">in_array</span><span style="color: #007700">(</span><span style="color: #0000BB">strtolower</span><span style="color: #007700">(</span><span style="color: #0000BB">$controller</span><span style="color: #007700">), array(<br /> </span><span style="color: #DD0000">'api'</span><span style="color: #007700">, <br /> ))) {<br /> return </span><span style="color: #0000BB">TRUE</span><span style="color: #007700">;<br /> }<br /> <br /> if (</span><span style="color: #0000BB">Yaf_Session</span><span style="color: #007700">::</span><span style="color: #0000BB">getInstance</span><span style="color: #007700">()-></span><span style="color: #0000BB">has</span><span style="color: #007700">(</span><span style="color: #DD0000">"login"</span><span style="color: #007700">)) {<br /> return </span><span style="color: #0000BB">TRUE</span><span style="color: #007700">;<br /> }<br /> <br /> </span><span style="color: #FF8000">/* Use access check failed, need to login */<br /> </span><span style="color: #0000BB">$response</span><span style="color: #007700">-></span><span style="color: #0000BB">redirect</span><span style="color: #007700">(</span><span style="color: #DD0000">"http://yourdomain.com/login/"</span><span style="color: #007700">);<br /> return </span><span style="color: #0000BB">FALSE</span><span style="color: #007700">;<br /> }<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-yaf-plugin-abstract.routershutdown-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="yaf-plugin-abstract.routerstartup.html" class="methodname" rel="rdfs-seeAlso">Yaf_Plugin_Abstract::routerStartup()</a> - RouterStartup hook</span></li>
<li class="member"> <span class="methodname"><a href="yaf-plugin-abstract.dispatchloopstartup.html" class="methodname" rel="rdfs-seeAlso">Yaf_Plugin_Abstract::dispatchLoopStartup()</a> - The dispatchLoopStartup purpose</span></li>
<li class="member"> <span class="methodname"><a href="yaf-plugin-abstract.predispatch.html" class="methodname" rel="rdfs-seeAlso">Yaf_Plugin_Abstract::preDispatch()</a> - The preDispatch purpose</span></li>
<li class="member"> <span class="methodname"><a href="yaf-plugin-abstract.postdispatch.html" class="methodname" rel="rdfs-seeAlso">Yaf_Plugin_Abstract::postDispatch()</a> - The postDispatch purpose</span></li>
<li class="member"> <span class="methodname"><a href="yaf-plugin-abstract.dispatchloopshutdown.html" class="methodname" rel="rdfs-seeAlso">Yaf_Plugin_Abstract::dispatchLoopShutdown()</a> - The dispatchLoopShutdown purpose</span></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="yaf-plugin-abstract.preresponse.html">Yaf_Plugin_Abstract::preResponse</a></div>
<div class="next" style="text-align: right; float: right;"><a href="yaf-plugin-abstract.routerstartup.html">Yaf_Plugin_Abstract::routerStartup</a></div>
<div class="up"><a href="class.yaf-plugin-abstract.html">Yaf_Plugin_Abstract</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
