📄 ref.hwapi.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html> <head> <title>Hyperwave API Functions</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> </head> <body><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="book.hwapi.html">Hyperwave API</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.hwapi-attribute-key.html">hw_api_attribute->key</a></div> <div class="up"><a href="book.hwapi.html">Hyperwave API</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div><hr /><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.html" 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. <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> 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. <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.html" class="function">hw_api->children()</a> or <a href="function.hwapi-find.html" class="function">hw_api->find()</a>. </span> </li> </ul> </p> <blockquote><p><b class="note">Note</b>: Methods returning <a href="language.types.boolean.html" class="type boolean">boolean</a> can return <b><tt>TRUE</tt></b>, <b><tt>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.html">hw_api_attribute->key</a> 鈥
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -