getbody.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 6bce1dbf90821e3c720776dd013dc796d14d9781 Maintainer: yannick Status: ready -->
<!-- Reviewed: yes Maintainer: yannick -->

<refentry xml:id="yaf-response-abstract.getbody" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>Yaf_Response_Abstract::getBody</refname>
  <refpurpose>Récupère un contenu existant</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <type>mixed</type><methodname>Yaf_Response_Abstract::getBody</methodname>
   <methodparam choice="opt"><type>string</type><parameter>key</parameter></methodparam>
  </methodsynopsis>
  <para>
   Récupère un contenu existant.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>key</parameter></term>
    <listitem>
     <para>
      La clé du contenu ; si vous n'en spécifiez pas une, alors
      Yaf_Response_Abstract::DEFAULT_BODY sera utilisé. Si vous passez
      la valeur &null;, alors tous les contenus seront retournés sous la forme
      d'un tableau.
      <note>
       <para>
        Ce paramètre a été introduit en version 2.2.0.
      </para>
      </note>
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>

  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Exemple avec <function>Yaf_Response_Abstract::getBody</function></title>
   <programlisting role="php">
<![CDATA[
<?php
$response = new Yaf_Response_Http();

$response->setBody("Hello")->setBody(" World", "footer");

var_dump($response->getBody()); //default 
var_dump($response->getBody(Yaf_Response_Abstract::DEFAULT_BODY)); //identique à ci-dessus
var_dump($response->getBody("footer"));
var_dump($response->getBody(NULL)); //récupère tout
?>
]]>
   </programlisting>
   &example.outputs.similar;
   <screen>
<![CDATA[
string(5) "Hello"
string(5) "Hello"
string(6) " World"
array(2) {
  ["content"]=>
  string(5) "Hello"
  ["footer"]=>
  string(6) " World"
}
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <simplelist>
   <member><methodname>Yaf_Response_Abstract::setBody</methodname></member>
   <member><methodname>Yaf_Response_Abstract::appendBody</methodname></member>
   <member><methodname>Yaf_Response_Abstract::prependBody</methodname></member>
   <member><methodname>Yaf_Response_Abstract::clearBody</methodname></member>
  </simplelist>
 </refsect1>

</refentry>

<!-- 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
-->