<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/book.yaf.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'class.yaf-request-simple.php',
    1 => 'Yaf_Request_Simple',
    2 => 'The Yaf_Request_Simple class',
  ),
  'up' => 
  array (
    0 => 'book.yaf.php',
    1 => 'Yaf',
  ),
  'prev' => 
  array (
    0 => 'yaf-request-http.isxmlhttprequest.php',
    1 => 'Yaf_Request_Http::isXmlHttpRequest',
  ),
  'next' => 
  array (
    0 => 'yaf-request-simple.construct.php',
    1 => 'Yaf_Request_Simple::__construct',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/yaf/yaf-request-simple.xml',
  ),
  'history' => 
  array (
  ),
  'extra_header_links' => 
  array (
    'rel' => 'alternate',
    'href' => '/manual/en/feeds/class.yaf-request-simple.atom',
    'type' => 'application/atom+xml',
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="class.yaf-request-simple" class="reference">

 <h1 class="title">The Yaf_Request_Simple class</h1>
 

 <div class="partintro"><p class="verinfo">(Yaf &gt;=1.0.0)</p>


  <div class="section" id="yaf-request-simple.intro">
   <h2 class="title">Introduction</h2>
   <p class="para">
    <span class="classname"><strong class="classname">Yaf_Request_Simple</strong></span> is particularlly used for test
    puporse. ie. simulate some espacial request under CLI mode.
   </p>
  </div>


  <div class="section" id="yaf-request-simple.synopsis">
   <h2 class="title">Class synopsis</h2>


   <div class="classsynopsis">
    <span class="ooclass"><strong class="classname"></strong></span>


    <div class="classsynopsisinfo">
     <span class="ooclass">
      <span class="modifier">class</span> <strong class="classname">Yaf_Request_Simple</strong>
     </span>

     <span class="ooclass">
      <span class="modifier">extends</span>
       <a href="class.yaf-request-abstract.php" class="classname">Yaf_Request_Abstract</a>
     </span>
     {</div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Constants */</div>
    <div class="fieldsynopsis">
     <span class="modifier">const</span>
     <span class="type"><a href="language.types.string.php" class="type string">string</a></span>
      <var class="fieldsynopsis_varname"><a href="class.yaf-request-simple.php#yaf-request-simple.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"><a href="language.types.string.php" class="type string">string</a></span>
      <var class="fieldsynopsis_varname"><a href="class.yaf-request-simple.php#yaf-request-simple.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="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
    <div class="constructorsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><a href="yaf-request-simple.construct.php" class="methodname">__construct</a></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$method</code><span class="initializer"> = ?</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$module</code><span class="initializer"> = ?</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$controller</code><span class="initializer"> = ?</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$action</code><span class="initializer"> = ?</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$params</code><span class="initializer"> = ?</span></span><br>)</div>

    <div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-simple.get.php" class="methodname">get</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-simple.getcookie.php" class="methodname">getCookie</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-simple.getfiles.php" class="methodname">getFiles</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-simple.getpost.php" class="methodname">getPost</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-simple.getquery.php" class="methodname">getQuery</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-simple.getrequest.php" class="methodname">getRequest</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-simple.isxmlhttprequest.php" class="methodname">isXmlHttpRequest</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>


    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Inherited methods */</div>
    <div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.clearparams.php" class="methodname">Yaf_Request_Abstract::clearParams</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.getactionname.php" class="methodname">Yaf_Request_Abstract::getActionName</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.getbaseuri.php" class="methodname">Yaf_Request_Abstract::getBaseUri</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.getcontrollername.php" class="methodname">Yaf_Request_Abstract::getControllerName</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.getenv.php" class="methodname">Yaf_Request_Abstract::getEnv</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$name</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$default</code><span class="initializer"> = ?</span></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.getexception.php" class="methodname">Yaf_Request_Abstract::getException</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.getlanguage.php" class="methodname">Yaf_Request_Abstract::getLanguage</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.getmethod.php" class="methodname">Yaf_Request_Abstract::getMethod</a></span>(): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.getmodulename.php" class="methodname">Yaf_Request_Abstract::getModuleName</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.getparam.php" class="methodname">Yaf_Request_Abstract::getParam</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$name</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$default</code><span class="initializer"> = ?</span></span>): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.getparams.php" class="methodname">Yaf_Request_Abstract::getParams</a></span>(): <span class="type"><a href="language.types.array.php" class="type array">array</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.getrequesturi.php" class="methodname">Yaf_Request_Abstract::getRequestUri</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.getserver.php" class="methodname">Yaf_Request_Abstract::getServer</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$name</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$default</code><span class="initializer"> = ?</span></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.iscli.php" class="methodname">Yaf_Request_Abstract::isCli</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.isdispatched.php" class="methodname">Yaf_Request_Abstract::isDispatched</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.isget.php" class="methodname">Yaf_Request_Abstract::isGet</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.ishead.php" class="methodname">Yaf_Request_Abstract::isHead</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.isoptions.php" class="methodname">Yaf_Request_Abstract::isOptions</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.ispost.php" class="methodname">Yaf_Request_Abstract::isPost</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.isput.php" class="methodname">Yaf_Request_Abstract::isPut</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.isrouted.php" class="methodname">Yaf_Request_Abstract::isRouted</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.isxmlhttprequest.php" class="methodname">Yaf_Request_Abstract::isXmlHttpRequest</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.setactionname.php" class="methodname">Yaf_Request_Abstract::setActionName</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$action</code></span>, <span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$format_name</code><span class="initializer"> = true</span></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.setbaseuri.php" class="methodname">Yaf_Request_Abstract::setBaseUri</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$uir</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.setcontrollername.php" class="methodname">Yaf_Request_Abstract::setControllerName</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$controller</code></span>, <span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$format_name</code><span class="initializer"> = true</span></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.setdispatched.php" class="methodname">Yaf_Request_Abstract::setDispatched</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.setmodulename.php" class="methodname">Yaf_Request_Abstract::setModuleName</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$module</code></span>, <span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$format_name</code><span class="initializer"> = true</span></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.setparam.php" class="methodname">Yaf_Request_Abstract::setParam</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$name</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$value</code><span class="initializer"> = ?</span></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.setrequesturi.php" class="methodname">Yaf_Request_Abstract::setRequestUri</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$uir</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="yaf-request-abstract.setrouted.php" class="methodname">Yaf_Request_Abstract::setRouted</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$flag</code><span class="initializer"> = ?</span></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>


   }</div>


  </div>



  <div class="section" id="yaf-request-simple.props">
   <h2 class="title">Properties</h2>
   <dl>
    
     <dt id="yaf-request-simple.props.module"><var class="varname">module</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
    
     <dt id="yaf-request-simple.props.controller"><var class="varname">controller</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
    
     <dt id="yaf-request-simple.props.action"><var class="varname">action</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
    
     <dt id="yaf-request-simple.props.method"><var class="varname">method</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
    
     <dt id="yaf-request-simple.props.params"><var class="varname">params</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
    
     <dt id="yaf-request-simple.props.language"><var class="varname">language</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
    
     <dt id="yaf-request-simple.props.exception"><var class="varname">_exception</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
    
     <dt id="yaf-request-simple.props.base-uri"><var class="varname">_base_uri</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
    
     <dt id="yaf-request-simple.props.uri"><var class="varname">uri</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
    
     <dt id="yaf-request-simple.props.dispatched"><var class="varname">dispatched</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
    
     <dt id="yaf-request-simple.props.routed"><var class="varname">routed</var></dt>
     <dd>
      <p class="para"/>
     </dd>
    
   </dl>
  </div>




  <div class="section" id="yaf-request-simple.constants">
   <h2 class="title">Predefined Constants</h2>
   <dl>

    
     <dt id="yaf-request-simple.constants.scheme-http"><strong><code><a href="class.yaf-request-simple.php#yaf-request-simple.constants.scheme-http">Yaf_Request_Simple::SCHEME_HTTP</a></code></strong></dt>
     <dd>
      <p class="para"/>
     </dd>
    

    
     <dt id="yaf-request-simple.constants.scheme-https"><strong><code><a href="class.yaf-request-simple.php#yaf-request-simple.constants.scheme-https">Yaf_Request_Simple::SCHEME_HTTPS</a></code></strong></dt>
     <dd>
      <p class="para"/>
     </dd>
    

   </dl>
  </div>



 </div>

 
























































<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="yaf-request-simple.construct.php">Yaf_Request_Simple::__construct</a> — Constructor of Yaf_Request_Simple</li><li><a href="yaf-request-simple.get.php">Yaf_Request_Simple::get</a> — The get purpose</li><li><a href="yaf-request-simple.getcookie.php">Yaf_Request_Simple::getCookie</a> — The getCookie purpose</li><li><a href="yaf-request-simple.getfiles.php">Yaf_Request_Simple::getFiles</a> — The getFiles purpose</li><li><a href="yaf-request-simple.getpost.php">Yaf_Request_Simple::getPost</a> — The getPost purpose</li><li><a href="yaf-request-simple.getquery.php">Yaf_Request_Simple::getQuery</a> — The getQuery purpose</li><li><a href="yaf-request-simple.getrequest.php">Yaf_Request_Simple::getRequest</a> — The getRequest purpose</li><li><a href="yaf-request-simple.isxmlhttprequest.php">Yaf_Request_Simple::isXmlHttpRequest</a> — Determin if request is AJAX request</li></ul>
</div>
<?php manual_footer($setup); ?>