<!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_Http class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="yaf-request-abstract.setrouted.html">Yaf_Request_Abstract::setRouted</a></div>
<div class="next" style="text-align: right; float: right;"><a href="yaf-request-http.clone.html">Yaf_Request_Http::__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-request-http" class="reference">
<h1 class="title">The Yaf_Request_Http class</h1>
<div class="partintro"><p class="verinfo">(Yaf >=1.0.0)</p>
<div class="section" id="yaf-request-http.intro">
<h2 class="title">Introduction</h2>
<p class="para">
Any request from client is initialized as a
<strong class="classname">Yaf_Request_Http</strong>.
you can get the rquest information like, uri query and
post parameters via methods of this class.
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
For security, $_GET/$_POST are readonly in Yaf, which means
if you set a value to these global variables, you can not get it from
<span class="methodname"><a href="yaf-request-http.getquery.html" class="methodname">Yaf_Request_Http::getQuery()</a></span> or
<span class="methodname"><a href="yaf-request-http.getpost.html" class="methodname">Yaf_Request_Http::getPost()</a></span>.
</p>
<p class="para">
But there do is some usage need such feature, like unit testing. thus
Yaf can be built with --enable-yaf-debug, which will allow Yaf read the
value user set via script.
</p>
<p class="para">
in such case, Yaf will throw a E_STRICT warning to remind you about
that: Strict Standards: you are running yaf in debug mode
</p>
</p></blockquote>
</p>
</div>
<div class="section" id="yaf-request-http.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_Http</strong>
</span>
<span class="ooclass">
<span class="modifier">extends</span>
<a href="class.yaf-request-abstract.html" class="classname">Yaf_Request_Abstract</a>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Properties */</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">private</span> <span class="type">void</span> <span class="methodname"><a href="yaf-request-http.clone.html" class="methodname">__clone</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><a href="yaf-request-http.construct.html" class="methodname">__construct</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$request_uri</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$base_uri</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="yaf-request-http.get.html" class="methodname">get</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">mixed</span> <span class="methodname"><a href="yaf-request-http.getcookie.html" class="methodname">getCookie</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-http.getfiles.html" class="methodname">getFiles</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="yaf-request-http.getpost.html" class="methodname">getPost</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">mixed</span> <span class="methodname"><a href="yaf-request-http.getquery.html" class="methodname">getQuery</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">mixed</span> <span class="methodname"><a href="yaf-request-http.getraw.html" class="methodname">getRaw</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-http.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">bool</span> <span class="methodname"><a href="yaf-request-http.isxmlhttprequest.html" class="methodname">isXmlHttpRequest</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Inherited 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">Yaf_Request_Abstract::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">Yaf_Request_Abstract::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">Yaf_Request_Abstract::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">Yaf_Request_Abstract::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">Yaf_Request_Abstract::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">Yaf_Request_Abstract::getLanguage</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-request-abstract.getmethod.html" class="methodname">Yaf_Request_Abstract::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">Yaf_Request_Abstract::getModuleName</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="yaf-request-abstract.getparam.html" class="methodname">Yaf_Request_Abstract::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">array</span> <span class="methodname"><a href="yaf-request-abstract.getparams.html" class="methodname">Yaf_Request_Abstract::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">Yaf_Request_Abstract::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">Yaf_Request_Abstract::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">bool</span> <span class="methodname"><a href="yaf-request-abstract.iscli.html" class="methodname">Yaf_Request_Abstract::isCli</a></span>
( <span class="methodparam">void</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.isdispatched.html" class="methodname">Yaf_Request_Abstract::isDispatched</a></span>
( <span class="methodparam">void</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.isget.html" class="methodname">Yaf_Request_Abstract::isGet</a></span>
( <span class="methodparam">void</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.ishead.html" class="methodname">Yaf_Request_Abstract::isHead</a></span>
( <span class="methodparam">void</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.isoptions.html" class="methodname">Yaf_Request_Abstract::isOptions</a></span>
( <span class="methodparam">void</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.ispost.html" class="methodname">Yaf_Request_Abstract::isPost</a></span>
( <span class="methodparam">void</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.isput.html" class="methodname">Yaf_Request_Abstract::isPut</a></span>
( <span class="methodparam">void</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.isrouted.html" class="methodname">Yaf_Request_Abstract::isRouted</a></span>
( <span class="methodparam">void</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.isxmlhttprequest.html" class="methodname">Yaf_Request_Abstract::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">Yaf_Request_Abstract::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">Yaf_Request_Abstract::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">Yaf_Request_Abstract::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">Yaf_Request_Abstract::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">Yaf_Request_Abstract::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">bool</span> <span class="methodname"><a href="yaf-request-abstract.setparam.html" class="methodname">Yaf_Request_Abstract::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">Yaf_Request_Abstract::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">Yaf_Request_Abstract::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-http.props">
<h2 class="title">Properties</h2>
<dl>
<dt id="yaf-request-http.props.module"><var class="varname"><var class="varname">module</var></var></dt>
<dd>
<p class="para"/>
</dd>
<dt id="yaf-request-http.props.controller"><var class="varname"><var class="varname">controller</var></var></dt>
<dd>
<p class="para"/>
</dd>
<dt id="yaf-request-http.props.action"><var class="varname"><var class="varname">action</var></var></dt>
<dd>
<p class="para"/>
</dd>
<dt id="yaf-request-http.props.method"><var class="varname"><var class="varname">method</var></var></dt>
<dd>
<p class="para"/>
</dd>
<dt id="yaf-request-http.props.params"><var class="varname"><var class="varname">params</var></var></dt>
<dd>
<p class="para"/>
</dd>
<dt id="yaf-request-http.props.language"><var class="varname"><var class="varname">language</var></var></dt>
<dd>
<p class="para"/>
</dd>
<dt id="yaf-request-http.props.exception"><var class="varname"><var class="varname">_exception</var></var></dt>
<dd>
<p class="para"/>
</dd>
<dt id="yaf-request-http.props.base-uri"><var class="varname"><var class="varname">_base_uri</var></var></dt>
<dd>
<p class="para"/>
</dd>
<dt id="yaf-request-http.props.uri"><var class="varname"><var class="varname">uri</var></var></dt>
<dd>
<p class="para"/>
</dd>
<dt id="yaf-request-http.props.dispatched"><var class="varname"><var class="varname">dispatched</var></var></dt>
<dd>
<p class="para"/>
</dd>
<dt id="yaf-request-http.props.routed"><var class="varname"><var class="varname">routed</var></var></dt>
<dd>
<p class="para"/>
</dd>
</dl>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="yaf-request-http.clone.html">Yaf_Request_Http::__clone</a> — Yaf_Request_Http can not be cloned</li><li><a href="yaf-request-http.construct.html">Yaf_Request_Http::__construct</a> — Constructor of Yaf_Request_Http</li><li><a href="yaf-request-http.get.html">Yaf_Request_Http::get</a> — Retrieve variable from client</li><li><a href="yaf-request-http.getcookie.html">Yaf_Request_Http::getCookie</a> — Retrieve Cookie variable</li><li><a href="yaf-request-http.getfiles.html">Yaf_Request_Http::getFiles</a> — The getFiles purpose</li><li><a href="yaf-request-http.getpost.html">Yaf_Request_Http::getPost</a> — Retrieve POST variable</li><li><a href="yaf-request-http.getquery.html">Yaf_Request_Http::getQuery</a> — Fetch a query parameter</li><li><a href="yaf-request-http.getraw.html">Yaf_Request_Http::getRaw</a> — Retrieve Raw request body</li><li><a href="yaf-request-http.getrequest.html">Yaf_Request_Http::getRequest</a> — The getRequest purpose</li><li><a href="yaf-request-http.isxmlhttprequest.html">Yaf_Request_Http::isXmlHttpRequest</a> — Determin if request is Ajax Request</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="yaf-request-abstract.setrouted.html">Yaf_Request_Abstract::setRouted</a></div>
<div class="next" style="text-align: right; float: right;"><a href="yaf-request-http.clone.html">Yaf_Request_Http::__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>
