php-doc-en/reference/hwapi/functions/hwapi-content.xml

<?xml version='1.0' encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.hwapi-content">
 <refnamediv>
  <refname>hw_api->content</refname>
  <refpurpose>Returns content of an object</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <classsynopsis>
   <ooclass><classname>hw_api</classname></ooclass>
   <methodsynopsis>
    <type>HW_API_Content</type><methodname>content</methodname>
    <methodparam><type>array</type><parameter>parameter</parameter></methodparam>
   </methodsynopsis>
  </classsynopsis>
  <para>
   This function returns the content of a document as an object of type
   <classname>hw_api_content</classname>. 
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>parameter</parameter></term>
     <listitem>
      <para>
       The parameter array contains the required elements 'objectidentifier'
       and the optional element 'mode'. The mode can be one of the constants
       <constant>HW_API_CONTENT_ALLLINKS</constant>,
       <constant>HW_API_CONTENT_REACHABLELINKS</constant> or 
       <constant>HW_API_CONTENT_PLAIN</constant>.
      </para>
      <para>
       <constant>HW_API_CONTENT_ALLLINKS</constant> means to insert all
       anchors even if the destination is not reachable.
      </para>
      <para>
       <constant>HW_API_CONTENT_REACHABLELINKS</constant> tells this method
       to insert only reachable links and
       <constant>HW_API_CONTENT_PLAIN</constant> will lead to document
       without any links.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an instance of <classname>hw_api_content</classname>.
  </para>
 </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
-->