Source of: /manual/en/ref.hwapi.php
<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/book.hwapi.inc";
$setup = array (
'home' =>
array (
0 => 'index.php',
1 => 'PHP Manual',
),
'head' =>
array (
0 => 'UTF-8',
1 => 'en',
),
'this' =>
array (
0 => 'ref.hwapi.php',
1 => 'Hyperwave API Functions',
),
'up' =>
array (
0 => 'book.hwapi.php',
1 => 'Hyperwave API',
),
'prev' =>
array (
0 => 'hwapi.constants.php',
1 => 'Predefined Constants',
),
'next' =>
array (
0 => 'function.hwapi-attribute-key.php',
1 => 'hw_api_attribute->key',
),
);
$setup["toc"] = $TOC;
$setup["parents"] = $PARENTS;
manual_setup($setup);
manual_header();
?>
<div>
<h1 class="title">Hyperwave API Functions</h1>
<div class="partintro">
<div id="hwapi.apache" class="section">
<h2 class="title">Integration with Apache</h2>
<p class="para">
The integration with Apache and possible other servers is already
described in the <a href="ref.hw.php" class="link">Hyperwave module</a>
which has been the first extension to connect a Hyperwave Server.
</p>
</div>
<div id="hwapi.classes" class="section">
<h2 class="title">Classes</h2>
<p class="para">
The API provided by the HW_API extension is fully object oriented.
It is very similar to the C++ interface of the Hyperwave SDK.
It consist of the following classes.
</p><ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<b class="classname">HW_API</b>
</span>
</li>
<li class="listitem">
<span class="simpara">
<b class="classname">HW_API_Object</b>
</span>
</li>
<li class="listitem">
<span class="simpara">
<b class="classname">HW_API_Attribute</b>
</span>
</li>
<li class="listitem">
<span class="simpara">
<b class="classname">HW_API_Error</b>
</span>
</li>
<li class="listitem">
<span class="simpara">
<b class="classname">HW_API_Content</b>
</span>
</li>
<li class="listitem">
<span class="simpara">
<b class="classname">HW_API_Reason</b>
</span>
</li>
</ul><p>
Some basic classes like <b class="classname">HW_API_String</b>,
<b class="classname">HW_API_String_Array</b>, etc., which exist in the
Hyperwave SDK have not been implemented since PHP has powerful
replacements for them.
</p>
<p class="para">
Each class has certain method, whose names are identical to its
counterparts in the Hyperwave SDK. Passing arguments to this function
differs from all the other PHP extensions but is close to the C++ API of
the HW SDK. Instead of passing several parameters they are all put into
an associated array and passed as one parameter. The names of the keys
are identical to those documented in the HW SDK. The common parameters
are listed below. If other parameters are required they will be
documented if needed.
</p><ul class="itemizedlist">
<li class="listitem">
<span class="simpara">
<b class="classname">objectIdentifier</b> The name or id of an object,
e.g. "rootcollection", "0x873A8768 0x00000002".
</span>
</li>
<li class="listitem">
<span class="simpara">
<b class="classname">parentIdentifier</b> The name or id of an object
which is considered to be a parent.
</span>
</li>
<li class="listitem">
<span class="simpara">
<b class="classname">object</b> An instance of class HW_API_Object.
</span>
</li>
<li class="listitem">
<span class="simpara">
<b class="classname">parameters</b> An instance of class HW_API_Object.
</span>
</li>
<li class="listitem">
<span class="simpara">
<b class="classname">version</b> The version of an object.
</span>
</li>
<li class="listitem">
<span class="simpara">
<b class="classname">mode</b> An integer value determine the way an
operation is executed.
</span>
</li>
<li class="listitem">
<span class="simpara">
<b class="classname">attributeSelector</b> Any array of strings, each
containing a name of an attribute. This is used if you retrieve the
object record and want to include certain attributes.
</span>
</li>
<li class="listitem">
<span class="simpara">
<b class="classname">objectQuery</b> A query to select certain object
out of a list of objects. This is used to reduce the number of objects
which was delivered by a function like
<a href="function.hwapi-children.php" class="function">hw_api->children()</a> or <a href="function.hwapi-find.php" class="function">hw_api->find()</a>.
</span>
</li>
</ul><p>
</p>
<blockquote><p><b class="note">Note</b>:
Methods returning <a href="language.types.boolean.php" class="type boolean">boolean</a> can return <b><tt class="constant">TRUE</tt></b>, <b><tt class="constant">FALSE</tt></b> or
<b class="classname">HW_API_Error</b> object.
<br />
</p></blockquote>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="function.hwapi-attribute-key.php">hw_api_attribute->key</a> — Returns key of the attribute</li><li><a href="function.hwapi-attribute-langdepvalue.php">hw_api_attribute->langdepvalue</a> — Returns value for a given language</li><li><a href="function.hwapi-attribute-value.php">hw_api_attribute->value</a> — Returns value of the attribute</li><li><a href="function.hwapi-attribute-values.php">hw_api_attribute->values</a> — Returns all values of the attribute</li><li><a href="function.hwapi-attribute.php">hw_api_attribute</a> — Creates instance of class hw_api_attribute</li><li><a href="function.hwapi-checkin.php">hw_api->checkin</a> — Checks in an object</li><li><a href="function.hwapi-checkout.php">hw_api->checkout</a> — Checks out an object</li><li><a href="function.hwapi-children.php">hw_api->children</a> — Returns children of an object</li><li><a href="function.hwapi-content-mimetype.php">hw_api_content->mimetype</a> — Returns mimetype</li><li><a href="function.hwapi-content-read.php">hw_api_content->read</a> — Read content</li><li><a href="function.hwapi-content.php">hw_api->content</a> — Returns content of an object</li><li><a href="function.hwapi-copy.php">hw_api->copy</a> — Copies physically</li><li><a href="function.hwapi-dbstat.php">hw_api->dbstat</a> — Returns statistics about database server</li><li><a href="function.hwapi-dcstat.php">hw_api->dcstat</a> — Returns statistics about document cache server</li><li><a href="function.hwapi-dstanchors.php">hw_api->dstanchors</a> — Returns a list of all destination anchors</li><li><a href="function.hwapi-dstofsrcanchor.php">hw_api->dstofsrcanchor</a> — Returns destination of a source anchor</li><li><a href="function.hwapi-error-count.php">hw_api_error->count</a> — Returns number of reasons</li><li><a href="function.hwapi-error-reason.php">hw_api_error->reason</a> — Returns reason of error</li><li><a href="function.hwapi-find.php">hw_api->find</a> — Search for objects</li><li><a href="function.hwapi-ftstat.php">hw_api->ftstat</a> — Returns statistics about fulltext server</li><li><a href="function.hwapi-hgcsp.php">hwapi_hgcsp</a> — Returns object of class hw_api</li><li><a href="function.hwapi-hwstat.php">hw_api->hwstat</a> — Returns statistics about Hyperwave server</li><li><a href="function.hwapi-identify.php">hw_api->identify</a> — Log into Hyperwave Server</li><li><a href="function.hwapi-info.php">hw_api->info</a> — Returns information about server configuration</li><li><a href="function.hwapi-insert.php">hw_api->insert</a> — Inserts a new object</li><li><a href="function.hwapi-insertanchor.php">hw_api->insertanchor</a> — Inserts a new object of type anchor</li><li><a href="function.hwapi-insertcollection.php">hw_api->insertcollection</a> — Inserts a new object of type collection</li><li><a href="function.hwapi-insertdocument.php">hw_api->insertdocument</a> — Inserts a new object of type document</li><li><a href="function.hwapi-link.php">hw_api->link</a> — Creates a link to an object</li><li><a href="function.hwapi-lock.php">hw_api->lock</a> — Locks an object</li><li><a href="function.hwapi-move.php">hw_api->move</a> — Moves object between collections</li><li><a href="function.hwapi-new-content.php">hw_api_content</a> — Create new instance of class hw_api_content</li><li><a href="function.hwapi-object-assign.php">hw_api_object->assign</a> — Clones object</li><li><a href="function.hwapi-object-attreditable.php">hw_api_object->attreditable</a> — Checks whether an attribute is editable</li><li><a href="function.hwapi-object-count.php">hw_api_object->count</a> — Returns number of attributes</li><li><a href="function.hwapi-object-insert.php">hw_api_object->insert</a> — Inserts new attribute</li><li><a href="function.hwapi-object-new.php">hw_api_object</a> — Creates a new instance of class hw_api_object</li><li><a href="function.hwapi-object-remove.php">hw_api_object->remove</a> — Removes attribute</li><li><a href="function.hwapi-object-title.php">hw_api_object->title</a> — Returns the title attribute</li><li><a href="function.hwapi-object-value.php">hw_api_object->value</a> — Returns value of attribute</li><li><a href="function.hwapi-object.php">hw_api->object</a> — Retrieve attribute information</li><li><a href="function.hwapi-objectbyanchor.php">hw_api->objectbyanchor</a> — Returns the object an anchor belongs to</li><li><a href="function.hwapi-parents.php">hw_api->parents</a> — Returns parents of an object</li><li><a href="function.hwapi-reason-description.php">hw_api_reason->description</a> — Returns description of reason</li><li><a href="function.hwapi-reason-type.php">hw_api_reason->type</a> — Returns type of reason</li><li><a href="function.hwapi-remove.php">hw_api->remove</a> — Delete an object</li><li><a href="function.hwapi-replace.php">hw_api->replace</a> — Replaces an object</li><li><a href="function.hwapi-setcommittedversion.php">hw_api->setcommittedversion</a> — Commits version other than last version</li><li><a href="function.hwapi-srcanchors.php">hw_api->srcanchors</a> — Returns a list of all source anchors</li><li><a href="function.hwapi-srcsofdst.php">hw_api->srcsofdst</a> — Returns source of a destination object</li><li><a href="function.hwapi-unlock.php">hw_api->unlock</a> — Unlocks a locked object</li><li><a href="function.hwapi-user.php">hw_api->user</a> — Returns the own user object</li><li><a href="function.hwapi-userlist.php">hw_api->userlist</a> — Returns a list of all logged in users</li></ul>
</div>
<?php manual_footer(); ?>
