<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.yaf-request-abstract.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'yaf-request-abstract.getpost.php',
    1 => 'Yaf_Request_Abstract::getPost',
    2 => 'Fetch a POST parameter',
  ),
  'up' => 
  array (
    0 => 'class.yaf-request-abstract.php',
    1 => 'Yaf_Request_Abstract',
  ),
  'prev' => 
  array (
    0 => 'yaf-request-abstract.getparams.php',
    1 => 'Yaf_Request_Abstract::getParams',
  ),
  'next' => 
  array (
    0 => 'yaf-request-abstract.getquery.php',
    1 => 'Yaf_Request_Abstract::getQuery',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/yaf/yaf_request_abstract/getpost.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="yaf-request-abstract.getpost" class="refentry">
 <div class="refnamediv">
<h1 class="refname">Yaf_Request_Abstract::getPost</h1>
<p class="verinfo">(Yaf &gt;=3.2.2)</p><p class="refpurpose"><span class="refname">Yaf_Request_Abstract::getPost</span> &mdash; <span class="dc-title">Fetch a POST parameter</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-yaf-request-abstract.getpost-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><strong>Yaf_Request_Abstract::getPost</strong></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 class="initializer"> = ?</span></span>, <span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</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>

  <p class="simpara">Retrieves a variable from $_POST.</p>
 </div>


 <div class="refsect1 parameters" id="refsect1-yaf-request-abstract.getpost-parameters">
  <h3 class="title">Parameters</h3>
  <dl>
   
    <dt><code class="parameter">name</code></dt>
    <dd>
<p class="simpara">The variable name. If omitted, the whole array is returned.</p>
    </dd>
   
   
    <dt><code class="parameter">default</code></dt>
    <dd>
<p class="simpara">The value to return if the variable is not found.</p>
    </dd>
   
  </dl>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-yaf-request-abstract.getpost-returnvalues">
  <h3 class="title">Return Values</h3>
<p class="simpara">The POST parameter value, or <code class="parameter">default</code> if it is not set.</p>
 </div>


 <div class="refsect1 examples" id="refsect1-yaf-request-abstract.getpost-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="example-1">
   <p><strong>Example #1 <span class="methodname"><strong>Yaf_Request_Abstract::getPost()</strong></span> example</strong></p>
   <div class="example-contents">
<div class="phpcode"><pre><code style="color: #000000"><span style="color: #0000BB">&lt;?php
</span><span style="color: #007700">class </span><span style="color: #0000BB">LoginController </span><span style="color: #007700">extends </span><span style="color: #0000BB">Yaf_Controller_Abstract
</span><span style="color: #007700">{
    public function </span><span style="color: #0000BB">indexAction</span><span style="color: #007700">()
    {
        </span><span style="color: #FF8000">// Assuming the form was submitted with POST /login
        </span><span style="color: #007700">if (</span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getRequest</span><span style="color: #007700">()-&gt;</span><span style="color: #0000BB">isPost</span><span style="color: #007700">()) {
            </span><span style="color: #0000BB">$username </span><span style="color: #007700">= </span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getRequest</span><span style="color: #007700">()-&gt;</span><span style="color: #0000BB">getPost</span><span style="color: #007700">(</span><span style="color: #DD0000">"username"</span><span style="color: #007700">);
            </span><span style="color: #0000BB">$remember </span><span style="color: #007700">= </span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getRequest</span><span style="color: #007700">()-&gt;</span><span style="color: #0000BB">getPost</span><span style="color: #007700">(</span><span style="color: #DD0000">"remember"</span><span style="color: #007700">, </span><span style="color: #DD0000">"no"</span><span style="color: #007700">);

            </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$username</span><span style="color: #007700">, </span><span style="color: #0000BB">$remember</span><span style="color: #007700">);
        }
    }
}
</span><span style="color: #0000BB">?&gt;</span></code></pre></div>
   </div>

   <div class="example-contents"><p>The above example will output
something similar to:</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">string(8) &quot;laruence&quot;
string(3) &quot;yes&quot;</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-yaf-request-abstract.getpost-seealso">
  <h3 class="title">See Also</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="yaf-request-abstract.getquery.php" class="methodname" rel="rdfs-seeAlso">Yaf_Request_Abstract::getQuery()</a> - Fetch a query parameter</span></li>
   <li><span class="methodname"><a href="yaf-request-abstract.getrequest.php" class="methodname" rel="rdfs-seeAlso">Yaf_Request_Abstract::getRequest()</a> - Fetch a REQUEST variable</span></li>
   <li><span class="methodname"><strong>Yaf_Request_Abstract::getPost()</strong></span></li>
   <li><span class="methodname"><a href="yaf-request-abstract.getcookie.php" class="methodname" rel="rdfs-seeAlso">Yaf_Request_Abstract::getCookie()</a> - Fetch a COOKIE variable</span></li>
   <li><span class="methodname"><a href="yaf-request-abstract.getfiles.php" class="methodname" rel="rdfs-seeAlso">Yaf_Request_Abstract::getFiles()</a> - Fetch uploaded files</span></li>
   <li><span class="methodname"><a href="yaf-request-abstract.getparam.php" class="methodname" rel="rdfs-seeAlso">Yaf_Request_Abstract::getParam()</a> - Retrieve a parameter</span></li>
  </ul>
 </div>

</div><?php manual_footer($setup); ?>