<!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 Yaf_Controller_Abstract class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="yaf-config-simple.valid.html">Yaf_Config_Simple::valid</a></div>
<div class="next" style="text-align: right; float: right;"><a href="yaf-controller-abstract.clone.html">Yaf_Controller_Abstract::__clone</a></div>
<div class="up"><a href="book.yaf.html">Yaf</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.yaf-controller-abstract" class="reference">
<h1 class="title">The Yaf_Controller_Abstract class</h1>
<div class="partintro"><p class="verinfo">(Yaf >=1.0.0)</p>
<div class="section" id="yaf-controller-abstract.intro">
<h2 class="title">Introduction</h2>
<p class="para">
<strong class="classname">Yaf_Controller_Abstract</strong> is the heart of Yaf's
system. MVC stands for Model-View-Controller and is a design pattern
targeted at separating application logic from display logic.
</p>
<p class="para">
Every custom controller shall inherit
<strong class="classname">Yaf_Controller_Abstract</strong>.
</p>
<p class="para">
You will find that you can not define __construct function for your custom
controller, thus, <strong class="classname">Yaf_Controller_Abstract</strong> provides
a magic method: <span class="methodname"><a href="yaf-controller-abstract.init.html" class="methodname">Yaf_Controller_Abstract::init()</a></span>.
</p>
<p class="para">
If you have defined a init() method in your custom controller, it will be
called as long as the controller was instantiated.
</p>
<p class="para">
Action may have arguments, when a request coming, if there are the same
name variable in the request parameters(see
<span class="methodname"><a href="yaf-request-abstract.getparam.html" class="methodname">Yaf_Request_Abstract::getParam()</a></span>) after routed,
Yaf will pass them to the action method
(see <span class="methodname"><a href="yaf-action-abstract.execute.html" class="methodname">Yaf_Action_Abstract::execute()</a></span>).
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
These arguments are directly fetched without filtering, it should be
carefully processed before use them.
</p>
</p></blockquote>
</p>
</div>
<div class="section" id="yaf-controller-abstract.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<span class="modifier">abstract</span>
<strong class="classname">Yaf_Controller_Abstract</strong>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Properties */</div>
<div class="fieldsynopsis">
<span class="modifier">public</span>
<var class="varname"><a href="class.yaf-controller-abstract.html#yaf-controller-abstract.props.actions">$<var class="varname">actions</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<var class="varname"><a href="class.yaf-controller-abstract.html#yaf-controller-abstract.props.module">$<var class="varname">_module</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<var class="varname"><a href="class.yaf-controller-abstract.html#yaf-controller-abstract.props.name">$<var class="varname">_name</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<var class="varname"><a href="class.yaf-controller-abstract.html#yaf-controller-abstract.props.request">$<var class="varname">_request</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<var class="varname"><a href="class.yaf-controller-abstract.html#yaf-controller-abstract.props.response">$<var class="varname">_response</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<var class="varname"><a href="class.yaf-controller-abstract.html#yaf-controller-abstract.props.invoke-args">$<var class="varname">_invoke_args</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<var class="varname"><a href="class.yaf-controller-abstract.html#yaf-controller-abstract.props.view">$<var class="varname">_view</var></a></var>
;</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">private</span> <span class="type">void</span> <span class="methodname"><a href="yaf-controller-abstract.clone.html" class="methodname">__clone</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">private</span> <span class="methodname"><a href="yaf-controller-abstract.construct.html" class="methodname">__construct</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">protected</span> <span class="type">bool</span> <span class="methodname"><a href="yaf-controller-abstract.display.html" class="methodname">display</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$tpl</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$parameters</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-controller-abstract.forward.html" class="methodname">forward</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$action</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$paramters</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-controller-abstract.getinvokearg.html" class="methodname">getInvokeArg</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-controller-abstract.getinvokeargs.html" class="methodname">getInvokeArgs</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="yaf-controller-abstract.getmodulename.html" class="methodname">getModuleName</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">Yaf_Request_Abstract</span> <span class="methodname"><a href="yaf-controller-abstract.getrequest.html" class="methodname">getRequest</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">Yaf_Response_Abstract</span> <span class="methodname"><a href="yaf-controller-abstract.getresponse.html" class="methodname">getResponse</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">Yaf_View_Interface</span> <span class="methodname"><a href="yaf-controller-abstract.getview.html" class="methodname">getView</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-controller-abstract.getviewpath.html" class="methodname">getViewpath</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-controller-abstract.init.html" class="methodname">init</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-controller-abstract.initview.html" class="methodname">initView</a></span>
([ <span class="methodparam"><span class="type">array</span> <code class="parameter">$options</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="yaf-controller-abstract.redirect.html" class="methodname">redirect</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$url</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">protected</span> <span class="type">string</span> <span class="methodname"><a href="yaf-controller-abstract.render.html" class="methodname">render</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$tpl</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$parameters</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-controller-abstract.setviewpath.html" class="methodname">setViewpath</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$view_directory</code></span>
)</div>
}</div>
</div>
<div class="section" id="yaf-controller-abstract.props">
<h2 class="title">Properties</h2>
<dl>
<dt id="yaf-controller-abstract.props.actions">
<span class="term"><var class="varname"><var class="varname">actions</var></var></span>
<dd>
<p class="para">
You can also define a action method in a separate PHP script by using
this property and <a href="class.yaf-action-abstract.html" class="classname">Yaf_Action_Abstract</a>.
<div class="example" id="example-4134">
<p><strong>Example #1 define action in a separate file</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">IndexController </span><span style="color: #007700">extends </span><span style="color: #0000BB">Yaf_Controller_Abstract </span><span style="color: #007700">{<br /> protected </span><span style="color: #0000BB">$actions </span><span style="color: #007700">= array(<br /> </span><span style="color: #FF8000">/** now dummyAction is defined in a separate file */<br /> </span><span style="color: #DD0000">"dummy" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"actions/Dummy_action.php"</span><span style="color: #007700">,<br /> );<br /><br /> </span><span style="color: #FF8000">/* action method may have arguments */<br /> </span><span style="color: #007700">public </span><span style="color: #0000BB">indexAction</span><span style="color: #007700">(</span><span style="color: #0000BB">$name</span><span style="color: #007700">, </span><span style="color: #0000BB">$id</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">/* $name and $id are unsafe raw data */<br /> </span><span style="color: #0000BB">assert</span><span style="color: #007700">(</span><span style="color: #0000BB">$name </span><span style="color: #007700">== </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">getRequest</span><span style="color: #007700">()-></span><span style="color: #0000BB">getParam</span><span style="color: #007700">(</span><span style="color: #DD0000">"name"</span><span style="color: #007700">));<br /> </span><span style="color: #0000BB">assert</span><span style="color: #007700">(</span><span style="color: #0000BB">$id </span><span style="color: #007700">== </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_request</span><span style="color: #007700">-></span><span style="color: #0000BB">getParam</span><span style="color: #007700">(</span><span style="color: #DD0000">"id"</span><span style="color: #007700">));<br /> }<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="example-4135">
<p><strong>Example #2 Dummy_action.php</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">DummyAction </span><span style="color: #007700">extends </span><span style="color: #0000BB">Yaf_Action_Abstract </span><span style="color: #007700">{<br /> </span><span style="color: #FF8000">/* a action class shall define this method as the entry point */<br /> </span><span style="color: #007700">public </span><span style="color: #0000BB">execute</span><span style="color: #007700">() {<br /> }<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</dd>
</dt>
<dt id="yaf-controller-abstract.props.module">
<span class="term"><var class="varname"><var class="varname">_module</var></var></span>
<dd>
<p class="para">
module name
</p>
</dd>
</dt>
<dt id="yaf-controller-abstract.props.name">
<span class="term"><var class="varname"><var class="varname">_name</var></var></span>
<dd>
<p class="para">
controller name
</p>
</dd>
</dt>
<dt id="yaf-controller-abstract.props.request">
<span class="term"><var class="varname"><var class="varname">_request</var></var></span>
<dd>
<p class="para">
current request object
</p>
</dd>
</dt>
<dt id="yaf-controller-abstract.props.response">
<span class="term"><var class="varname"><var class="varname">_response</var></var></span>
<dd>
<p class="para">
current response object
</p>
</dd>
</dt>
<dt id="yaf-controller-abstract.props.invoke-args">
<span class="term"><var class="varname"><var class="varname">_invoke_args</var></var></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="yaf-controller-abstract.props.view">
<span class="term"><var class="varname"><var class="varname">_view</var></var></span>
<dd>
<p class="para">
view engine object
</p>
</dd>
</dt>
</dl>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="yaf-controller-abstract.clone.html">Yaf_Controller_Abstract::__clone</a> — Yaf_Controller_Abstract can not be cloned</li><li><a href="yaf-controller-abstract.construct.html">Yaf_Controller_Abstract::__construct</a> — Yaf_Controller_Abstract constructor</li><li><a href="yaf-controller-abstract.display.html">Yaf_Controller_Abstract::display</a> — The display purpose</li><li><a href="yaf-controller-abstract.forward.html">Yaf_Controller_Abstract::forward</a> — foward to another action</li><li><a href="yaf-controller-abstract.getinvokearg.html">Yaf_Controller_Abstract::getInvokeArg</a> — The getInvokeArg purpose</li><li><a href="yaf-controller-abstract.getinvokeargs.html">Yaf_Controller_Abstract::getInvokeArgs</a> — The getInvokeArgs purpose</li><li><a href="yaf-controller-abstract.getmodulename.html">Yaf_Controller_Abstract::getModuleName</a> — Get module name</li><li><a href="yaf-controller-abstract.getrequest.html">Yaf_Controller_Abstract::getRequest</a> — Retrieve current request object</li><li><a href="yaf-controller-abstract.getresponse.html">Yaf_Controller_Abstract::getResponse</a> — Retrieve current response object</li><li><a href="yaf-controller-abstract.getview.html">Yaf_Controller_Abstract::getView</a> — Retrieve the view engine</li><li><a href="yaf-controller-abstract.getviewpath.html">Yaf_Controller_Abstract::getViewpath</a> — The getViewpath purpose</li><li><a href="yaf-controller-abstract.init.html">Yaf_Controller_Abstract::init</a> — Controller initializer</li><li><a href="yaf-controller-abstract.initview.html">Yaf_Controller_Abstract::initView</a> — The initView purpose</li><li><a href="yaf-controller-abstract.redirect.html">Yaf_Controller_Abstract::redirect</a> — Redirect to a URL</li><li><a href="yaf-controller-abstract.render.html">Yaf_Controller_Abstract::render</a> — Render view template</li><li><a href="yaf-controller-abstract.setviewpath.html">Yaf_Controller_Abstract::setViewpath</a> — The setViewpath purpose</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="yaf-config-simple.valid.html">Yaf_Config_Simple::valid</a></div>
<div class="next" style="text-align: right; float: right;"><a href="yaf-controller-abstract.clone.html">Yaf_Controller_Abstract::__clone</a></div>
<div class="up"><a href="book.yaf.html">Yaf</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
