Source of: /manual/en/function.hwapi-content.php


<?php

include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';

$TOC = array();

$PARENTS = array();

include_once dirname(__FILE__) ."/toc/ref.hwapi.inc";

$setup = array (

  'home' => 

  array (

    0 => 'index.php',

    1 => 'PHP Manual',

  ),

  'head' => 

  array (

    0 => 'UTF-8',

    1 => 'en',

  ),

  'this' => 

  array (

    0 => 'function.hwapi-content.php',

    1 => 'hw_api->content',

  ),

  'up' => 

  array (

    0 => 'ref.hwapi.php',

    1 => 'Hyperwave API Functions',

  ),

  'prev' => 

  array (

    0 => 'function.hwapi-content-read.php',

    1 => 'hw_api_content->read',

  ),

  'next' => 

  array (

    0 => 'function.hwapi-copy.php',

    1 => 'hw_api->copy',

  ),

);

$setup["toc"] = $TOC;

$setup["parents"] = $PARENTS;

manual_setup($setup);



manual_header();

?>

<div id="function.hwapi-content" class="refentry">

 <div class="refnamediv">

  <h1 class="refname">hw_api-&gt;content</h1>

  <p class="verinfo">(PHP 4, PHP 5 &lt; 5.2.0, PECL hwapi SVN)</p><p class="refpurpose"><span class="refname">hw_api-&gt;content</span> &mdash; <span class="dc-title">Returns content of an object</span></p>



 </div>

 

 <a name="function.hwapi-content.description"></a><div class="refsect1 description">

  <h3 class="title">Description</h3>

  <div class="classsynopsis">

   <div class="ooclass"><b class="classname">hw_api</b></div>

   <div class="methodsynopsis dc-description">

    <span class="type">HW_API_Content</span> <span class="methodname"><b>content</b></span>

     ( <span class="methodparam"><span class="type">array</span> <tt class="parameter">$parameter</tt></span>

    )</div>



  </div>

  <p class="para">

   This function returns the content of a document as an object of type

   <b class="classname">hw_api_content</b>. 

  </p>

 </div>





 <a name="function.hwapi-content.parameters"></a><div class="refsect1 parameters">

  <h3 class="title">Parameters</h3>

  <p class="para">

   </p><dl>



    <dt class="varlistentry">



     <span class="term"><i><tt class="parameter">parameter</tt></i>

</span>



     </dt><dd class="listitem">



      <p class="para">

       The parameter array contains the required elements &#039;objectidentifier&#039;

       and the optional element &#039;mode&#039;. The mode can be one of the constants

       <b><tt class="constant">HW_API_CONTENT_ALLLINKS</tt></b>,

       <b><tt class="constant">HW_API_CONTENT_REACHABLELINKS</tt></b> or 

       <b><tt class="constant">HW_API_CONTENT_PLAIN</tt></b>.

      </p>

      <p class="para">

       <b><tt class="constant">HW_API_CONTENT_ALLLINKS</tt></b> means to insert all

       anchors even if the destination is not reachable.

      </p>

      <p class="para">

       <b><tt class="constant">HW_API_CONTENT_REACHABLELINKS</tt></b> tells this method

       to insert only reachable links and

       <b><tt class="constant">HW_API_CONTENT_PLAIN</tt></b> will lead to document

       without any links.

      </p>

     </dd>



    

   </dl>

<p>

  </p>

 </div>





 <a name="function.hwapi-content.returnvalues"></a><div class="refsect1 returnvalues">

  <h3 class="title">Return Values</h3>

  <p class="para">

   Returns an instance of <b class="classname">hw_api_content</b>.

  </p>

 </div>





</div><?php manual_footer(); ?>
Our source is open

Source of: /manual/en/function.hwapi-content.php
