<!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_Request_Abstract class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="yaf-registry.set.html">Yaf_Registry::set</a></div>
<div class="next" style="text-align: right; float: right;"><a href="yaf-request-abstract.getactionname.html">Yaf_Request_Abstract::getActionName</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-request-abstract" class="reference">
<h1 class="title">The Yaf_Request_Abstract class</h1>
<div class="partintro"><p class="verinfo">(Yaf >=1.0.0)</p>
<div class="section" id="yaf-request-abstract.intro">
<h2 class="title">Introduction</h2>
<p class="para">
</p>
</div>
<div class="section" id="yaf-request-abstract.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">Yaf_Request_Abstract</strong>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Constants */</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">string</span>
<var class="fieldsynopsis_varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.constants.scheme-http"><var class="varname">SCHEME_HTTP</var></a></var>
<span class="initializer"> = http</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">string</span>
<var class="fieldsynopsis_varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.constants.scheme-https"><var class="varname">SCHEME_HTTPS</var></a></var>
<span class="initializer"> = https</span>
;</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Properties */</div>
<div class="fieldsynopsis">
<span class="modifier">public</span>
<var class="varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.props.module">$<var class="varname">module</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">public</span>
<var class="varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.props.controller">$<var class="varname">controller</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">public</span>
<var class="varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.props.action">$<var class="varname">action</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">public</span>
<var class="varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.props.method">$<var class="varname">method</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<var class="varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.props.params">$<var class="varname">params</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<var class="varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.props.language">$<var class="varname">language</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<var class="varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.props.exception">$<var class="varname">_exception</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<var class="varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.props.base-uri">$<var class="varname">_base_uri</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<var class="varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.props.uri">$<var class="varname">uri</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<var class="varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.props.dispatched">$<var class="varname">dispatched</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<var class="varname"><a href="class.yaf-request-abstract.html#yaf-request-abstract.props.routed">$<var class="varname">routed</var></a></var>
;</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.getactionname.html" class="methodname">getActionName</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-request-abstract.getbaseuri.html" class="methodname">getBaseUri</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-request-abstract.getcontrollername.html" class="methodname">getControllerName</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-request-abstract.getenv.html" class="methodname">getEnv</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$default</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.getexception.html" class="methodname">getException</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-request-abstract.getlanguage.html" class="methodname">getLanguage</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-request-abstract.getmethod.html" class="methodname">getMethod</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-request-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">void</span> <span class="methodname"><a href="yaf-request-abstract.getparam.html" class="methodname">getParam</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$default</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.getparams.html" class="methodname">getParams</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-request-abstract.getrequesturi.html" class="methodname">getRequestUri</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-request-abstract.getserver.html" class="methodname">getServer</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$default</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.iscli.html" class="methodname">isCli</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-request-abstract.isdispatched.html" class="methodname">isDispatched</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-request-abstract.isget.html" class="methodname">isGet</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-request-abstract.ishead.html" class="methodname">isHead</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-request-abstract.isoptions.html" class="methodname">isOptions</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-request-abstract.ispost.html" class="methodname">isPost</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-request-abstract.isput.html" class="methodname">isPut</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-request-abstract.isrouted.html" class="methodname">isRouted</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-request-abstract.isxmlhttprequest.html" class="methodname">isXmlHttpRequest</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-request-abstract.setactionname.html" class="methodname">setActionName</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$action</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="yaf-request-abstract.setbaseuri.html" class="methodname">setBaseUri</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$uir</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.setcontrollername.html" class="methodname">setControllerName</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$controller</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.setdispatched.html" class="methodname">setDispatched</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-request-abstract.setmodulename.html" class="methodname">setModuleName</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$module</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.setparam.html" class="methodname">setParam</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.setrequesturi.html" class="methodname">setRequestUri</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$uir</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-abstract.setrouted.html" class="methodname">setRouted</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$flag</code></span>
] )</div>
}</div>
</div>
<div class="section" id="yaf-request-abstract.props">
<h2 class="title">Properties</h2>
<dl>
<dt id="yaf-request-abstract.props.module">
<span class="term"><var class="varname"><var class="varname">module</var></var></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="yaf-request-abstract.props.controller">
<span class="term"><var class="varname"><var class="varname">controller</var></var></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="yaf-request-abstract.props.action">
<span class="term"><var class="varname"><var class="varname">action</var></var></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="yaf-request-abstract.props.method">
<span class="term"><var class="varname"><var class="varname">method</var></var></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="yaf-request-abstract.props.params">
<span class="term"><var class="varname"><var class="varname">params</var></var></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="yaf-request-abstract.props.language">
<span class="term"><var class="varname"><var class="varname">language</var></var></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="yaf-request-abstract.props.exception">
<span class="term"><var class="varname"><var class="varname">_exception</var></var></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="yaf-request-abstract.props.base-uri">
<span class="term"><var class="varname"><var class="varname">_base_uri</var></var></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="yaf-request-abstract.props.uri">
<span class="term"><var class="varname"><var class="varname">uri</var></var></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="yaf-request-abstract.props.dispatched">
<span class="term"><var class="varname"><var class="varname">dispatched</var></var></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="yaf-request-abstract.props.routed">
<span class="term"><var class="varname"><var class="varname">routed</var></var></span>
<dd>
<p class="para"/>
</dd>
</dt>
</dl>
</div>
<div class="section" id="yaf-request-abstract.constants">
<h2 class="title">Predefined Constants</h2>
<dl>
<dt id="yaf-request-abstract.constants.scheme-http">
<span class="term"><strong><code>Yaf_Request_Abstract::SCHEME_HTTP</code></strong></span>
<dd>
<p class="para"/>
</dd>
</dt>
<dt id="yaf-request-abstract.constants.scheme-https">
<span class="term"><strong><code>Yaf_Request_Abstract::SCHEME_HTTPS</code></strong></span>
<dd>
<p class="para"/>
</dd>
</dt>
</dl>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="yaf-request-abstract.getactionname.html">Yaf_Request_Abstract::getActionName</a> — The getActionName purpose</li><li><a href="yaf-request-abstract.getbaseuri.html">Yaf_Request_Abstract::getBaseUri</a> — The getBaseUri purpose</li><li><a href="yaf-request-abstract.getcontrollername.html">Yaf_Request_Abstract::getControllerName</a> — The getControllerName purpose</li><li><a href="yaf-request-abstract.getenv.html">Yaf_Request_Abstract::getEnv</a> — Retrieve ENV varialbe</li><li><a href="yaf-request-abstract.getexception.html">Yaf_Request_Abstract::getException</a> — The getException purpose</li><li><a href="yaf-request-abstract.getlanguage.html">Yaf_Request_Abstract::getLanguage</a> — The getLanguage purpose</li><li><a href="yaf-request-abstract.getmethod.html">Yaf_Request_Abstract::getMethod</a> — The getMethod purpose</li><li><a href="yaf-request-abstract.getmodulename.html">Yaf_Request_Abstract::getModuleName</a> — The getModuleName purpose</li><li><a href="yaf-request-abstract.getparam.html">Yaf_Request_Abstract::getParam</a> — The getParam purpose</li><li><a href="yaf-request-abstract.getparams.html">Yaf_Request_Abstract::getParams</a> — The getParams purpose</li><li><a href="yaf-request-abstract.getrequesturi.html">Yaf_Request_Abstract::getRequestUri</a> — The getRequestUri purpose</li><li><a href="yaf-request-abstract.getserver.html">Yaf_Request_Abstract::getServer</a> — Retrieve SERVER variable</li><li><a href="yaf-request-abstract.iscli.html">Yaf_Request_Abstract::isCli</a> — The isCli purpose</li><li><a href="yaf-request-abstract.isdispatched.html">Yaf_Request_Abstract::isDispatched</a> — The isDispatched purpose</li><li><a href="yaf-request-abstract.isget.html">Yaf_Request_Abstract::isGet</a> — The isGet purpose</li><li><a href="yaf-request-abstract.ishead.html">Yaf_Request_Abstract::isHead</a> — The isHead purpose</li><li><a href="yaf-request-abstract.isoptions.html">Yaf_Request_Abstract::isOptions</a> — The isOptions purpose</li><li><a href="yaf-request-abstract.ispost.html">Yaf_Request_Abstract::isPost</a> — The isPost purpose</li><li><a href="yaf-request-abstract.isput.html">Yaf_Request_Abstract::isPut</a> — The isPut purpose</li><li><a href="yaf-request-abstract.isrouted.html">Yaf_Request_Abstract::isRouted</a> — The isRouted purpose</li><li><a href="yaf-request-abstract.isxmlhttprequest.html">Yaf_Request_Abstract::isXmlHttpRequest</a> — The isXmlHttpRequest purpose</li><li><a href="yaf-request-abstract.setactionname.html">Yaf_Request_Abstract::setActionName</a> — The setActionName purpose</li><li><a href="yaf-request-abstract.setbaseuri.html">Yaf_Request_Abstract::setBaseUri</a> — set base URI</li><li><a href="yaf-request-abstract.setcontrollername.html">Yaf_Request_Abstract::setControllerName</a> — The setControllerName purpose</li><li><a href="yaf-request-abstract.setdispatched.html">Yaf_Request_Abstract::setDispatched</a> — The setDispatched purpose</li><li><a href="yaf-request-abstract.setmodulename.html">Yaf_Request_Abstract::setModuleName</a> — The setModuleName purpose</li><li><a href="yaf-request-abstract.setparam.html">Yaf_Request_Abstract::setParam</a> — The setParam purpose</li><li><a href="yaf-request-abstract.setrequesturi.html">Yaf_Request_Abstract::setRequestUri</a> — The setRequestUri purpose</li><li><a href="yaf-request-abstract.setrouted.html">Yaf_Request_Abstract::setRouted</a> — The setRouted purpose</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="yaf-registry.set.html">Yaf_Registry::set</a></div>
<div class="next" style="text-align: right; float: right;"><a href="yaf-request-abstract.getactionname.html">Yaf_Request_Abstract::getActionName</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>
