yaf-request-http.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<phpdoc:classref xml:id="class.yaf-request-http" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The Yaf_Request_Http class</title>
 <titleabbrev>Yaf_Request_Http</titleabbrev>

 <partintro>

<!-- {{{ Yaf_Request_Http intro -->
  <section xml:id="yaf-request-http.intro">
   &reftitle.intro;
   <para>
    Any request from client is initialized as a
    <classname>Yaf_Request_Http</classname>.
    you can get the request information like, uri query and 
    post parameters via methods of this class.
    <note>
     <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
      <methodname>Yaf_Request_Http::getQuery</methodname> or
      <methodname>Yaf_Request_Http::getPost</methodname>. 
     </para>
     <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.
     </para>
     <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
     </para>
    </note>
   </para>
  </section>
<!-- }}} -->

  <section xml:id="yaf-request-http.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass><classname>Yaf_Request_Http</classname></ooclass>

<!-- {{{ Class synopsis -->
    <classsynopsisinfo>
     <ooclass>
      <classname>Yaf_Request_Http</classname>
     </ooclass>
     
     <ooclass>
      <modifier>extends</modifier>
      <classname>Yaf_Request_Abstract</classname>
     </ooclass>
    </classsynopsisinfo>
<!-- }}} -->
    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>

    
    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.yaf-request-http')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[not(@role='procedural')])" />
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.yaf-request-http')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
    
    <classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.yaf-request-abstract')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />

   </classsynopsis>
<!-- }}} -->

  </section>

  
<!-- {{{ Yaf_Request_Http properties -->
  <section xml:id="yaf-request-http.props">
   &reftitle.properties;
   <variablelist>
    <varlistentry xml:id="yaf-request-http.props.module">
     <term><varname>module</varname></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="yaf-request-http.props.controller">
     <term><varname>controller</varname></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="yaf-request-http.props.action">
     <term><varname>action</varname></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="yaf-request-http.props.method">
     <term><varname>method</varname></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="yaf-request-http.props.params">
     <term><varname>params</varname></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="yaf-request-http.props.language">
     <term><varname>language</varname></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="yaf-request-http.props.exception">
     <term><varname>_exception</varname></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="yaf-request-http.props.base-uri">
     <term><varname>_base_uri</varname></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="yaf-request-http.props.uri">
     <term><varname>uri</varname></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="yaf-request-http.props.dispatched">
     <term><varname>dispatched</varname></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>
    <varlistentry xml:id="yaf-request-http.props.routed">
     <term><varname>routed</varname></term>
     <listitem>
      <para></para>
     </listitem>
    </varlistentry>
   </variablelist>
  </section>
<!-- }}} -->


 </partintro>

 &reference.yaf.entities.yaf-request-http;

</phpdoc:classref>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->