<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Returns content of an object</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="hwapi.children.html">hw_api::children</a></div>
<div class="next" style="text-align: right; float: right;"><a href="hwapi.copy.html">hw_api::copy</a></div>
<div class="up"><a href="ref.hwapi.html">Hyperwave API Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="hwapi.content" class="refentry">
<div class="refnamediv">
<h1 class="refname">hw_api::content</h1>
<p class="verinfo">(PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN)</p><p class="refpurpose"><span class="refname">hw_api::content</span> — <span class="dc-title">Returns content of an object</span></p>
</div>
<div class="refsect1 description" id="refsect1-hwapi.content-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><span class="type HW_API_Content">HW_API_Content</span></span> <span class="methodname"><strong>hw_api::content</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$parameter</code></span>
)</div>
<p class="para rdfs-comment">
This function returns the content of a document as an object of type
<strong class="classname">hw_api_content</strong>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-hwapi.content-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">parameter</code></em></span>
<dd>
<p class="para">
The parameter array contains the required elements 'objectidentifier'
and the optional element 'mode'. The mode can be one of the constants
<strong><code>HW_API_CONTENT_ALLLINKS</code></strong>,
<strong><code>HW_API_CONTENT_REACHABLELINKS</code></strong> or
<strong><code>HW_API_CONTENT_PLAIN</code></strong>.
</p>
<p class="para">
<strong><code>HW_API_CONTENT_ALLLINKS</code></strong> means to insert all
anchors even if the destination is not reachable.
</p>
<p class="para">
<strong><code>HW_API_CONTENT_REACHABLELINKS</code></strong> tells this method
to insert only reachable links and
<strong><code>HW_API_CONTENT_PLAIN</code></strong> will lead to document
without any links.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-hwapi.content-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an instance of <strong class="classname">hw_api_content</strong>.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="hwapi.children.html">hw_api::children</a></div>
<div class="next" style="text-align: right; float: right;"><a href="hwapi.copy.html">hw_api::copy</a></div>
<div class="up"><a href="ref.hwapi.html">Hyperwave API Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
