PHP4手册:函数库及函数(十八) Hyperwave 伺服器函式库-2
--------------------------------------------------------------------------------
函式:hw_GetObjectByQueryObj()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_GetObjectByQueryObj
搜寻物件。
语法: array hw_getobjectbyqueryobj(int connection, string query, int max_hits);
传回值: 阵列
函式种类: 网路系统
内容说明
本函式用来搜寻伺服器中的物件，并传回物件记录阵列。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 query 为为搜寻的字串。参数 max_hits 表合于条件的最大笔数，若设为 -1 则表示没有限制。
参考
hw_GetObjectByQuery()
--------------------------------------------------------------------------------
函式:hw_GetObjectByQueryColl()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_GetObjectByQueryColl
搜寻聚集物件。
语法: array hw_getobjectbyquerycoll(int connection, int objectID, string query, int max_hits);
传回值: 阵列
函式种类: 网路系统
内容说明
本函式用来搜寻伺服器中的物件聚集，并传回物件资料阵列。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 objectID 为指定的物件 ID 值。参数 query 为为搜寻的字串。参数 max_hits 表合于条件的最大笔数，若设为 -1 则表示没有限制。
参考
hw_GetObjectByQueryCollObj()
--------------------------------------------------------------------------------
函式:hw_GetObjectByQueryCollObj()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_GetObjectByQueryCollObj
搜寻聚集物件。
语法: array hw_getobjectbyquerycollobj(int connection, int objectID, string query, int max_hits);
传回值: 阵列
函式种类: 网路系统
内容说明
本函式用来搜寻伺服器中的物件聚集，并传回物件记录阵列。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 objectID 为指定的物件 ID 值。参数 query 为为搜寻的字串。参数 max_hits 表合于条件的最大笔数，若设为 -1 则表示没有限制。
参考
hw_GetObjectByQueryColl()
--------------------------------------------------------------------------------
函式:hw_GetChildDocColl()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_GetChildDocColl
取得全部子文件聚集。
语法: array hw_getchilddoccoll(int connection, int objectID);
传回值: 阵列
函式种类: 网路系统
内容说明
本函式用来取得指定文件的子文件聚集。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 objectID 为指定的物件 ID 值。
参考
hw_Children() hw_GetChildColl()
--------------------------------------------------------------------------------
函式:hw_GetChildDocCollObj()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_GetChildDocCollObj
取得全部子文件聚集记录。
语法: array hw_getchilddoccollobj(int connection, int objectID);
传回值: 阵列
函式种类: 网路系统
内容说明
本函式用来取得指定文件的子文件聚集记录。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 objectID 为指定的物件 ID 值。
参考
hw_ChildrenObj() hw_GetChildCollObj()
--------------------------------------------------------------------------------
函式:hw_GetAnchors()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_GetAnchors
取得文件的连结锚。
语法: array hw_getanchors(int connection, int objectID);
传回值: 阵列
函式种类: 网路系统
内容说明
本函式用来取得指定文件的连结锚 (ancher)。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 objectID 为指定的物件 ID 值。
--------------------------------------------------------------------------------
函式:hw_GetAnchorsObj()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_GetAnchorsObj
取得文件的连结锚记录。
语法: array hw_getanchorsobj(int connection, int objectID);
传回值: 阵列
函式种类: 网路系统
内容说明
本函式用来取得指定文件连结锚 (ancher) 的记录。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 objectID 为指定的物件 ID 值。
--------------------------------------------------------------------------------
函式:hw_Mv()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_Mv
移动物件。
语法: void hw_mv(int connection, array objrec, int from, int dest);
传回值: 无
函式种类: 网路系统
内容说明
本函式用来复制指定的物件。参数 connection 为连线代码。参数 objrec 为待复制的物件代码阵列。参数 from 及 dest 分别为来源及目的的代码。
参考
hw_Deleteobject() hw_Cp()
--------------------------------------------------------------------------------
函式:hw_Identify()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_Identify
使用者身份确认。
语法: void hw_identify(string username, string password);
传回值: 无
函式种类: 网路系统
内容说明
本函式用来确认使用者身份，只需在连线时认证即可。参数 username 及 password 分别为合法的帐号及密码。
参考
hw_Connect()
--------------------------------------------------------------------------------
函式:hw_InCollections()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_InCollections
检查物件聚集。
语法: array hw_incollections(int connection, array objids, array collids, int para);
传回值: 阵列
函式种类: 网路系统
内容说明
本函式用来复制指定的物件。参数 connection 为连线代码。参数 objids 为待检查的物件阵列。参数 collids 为物件聚集。参数 para 为传回聚集，若设为 0，表 objids 全都包含于 collids；若设为 1，则表 objids 部份包含于 collids。
--------------------------------------------------------------------------------
函式:hw_Info()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_Info
连线资讯。
语法: string hw_info(int connection);
传回值: 字串
函式种类: 网路系统
内容说明
本函式用来取得连线资讯。参数 connection 为连线代码。传回字串为 , , , , , 的格式
--------------------------------------------------------------------------------
函式:hw_InsColl()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_InsColl
插入聚集。
语法: int hw_inscoll(int connection, int objectID, array object_array);
传回值: 整数
函式种类: 网路系统
内容说明
本函式可新增一个聚集。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 objectID 为指定的物件 ID 值。参数 object_array 为物件阵列。传回值为新聚集的代码。
--------------------------------------------------------------------------------
函式:hw_InsDoc()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_InsDoc
插入文件。
语法: int hw_insdoc(int connection, int parentID, string object_record, string [text]);
传回值: 整数
函式种类: 网路系统
内容说明
本函式用来插入新文件。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 parentID 为指定的父物件 ID 值。参数 object_record 为欲插入的物件记录。参数 text 可省略，若设定为 text 则表示纯 (ASCII) 文字。传回值为新文件的代码。值得注意的是本函式通常只用来插入纯文字文件或物件记录，要插入任何格式的文件应用 hw_InsertDocument()
参考
hw_InsertDocument()
--------------------------------------------------------------------------------
函式:hw_InsertDocument()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_InsertDocument
上传文件。
语法: int hw_insertdocument(int connection, int parentID, int hw_document);
传回值: 整数
函式种类: 网路系统
内容说明
本函式用来上传任何格式的新文件。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 parentID 为指定的父物件 ID 值。参数 hw_document 为欲插入的文件。值得注意的是本函式上传文件前要先使用 hw_New_Document() 来建立新文件。
参考
hw_New_Document() hw_PipeDocument()
--------------------------------------------------------------------------------
函式:hw_InsertObject()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_InsertObject
插入物件记录。
语法: int hw_insertobject(int connection, string object_record, string parameter);
传回值: 整数
函式种类: 网路系统
内容说明
本函式用来插入新物件，物件可以是任何合于 Hyperwave 规定的物件，详细资讯请参考 HG-CSP 文件。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 object_record 为欲插入的物件记录。参数 parameter 为特殊的参数，例如 invisible，进一步资讯也请参考 HG-CSP 文件。
参考
hw_InsertDocument() hw_PipeDocument() hw_InsColl() hw_InsDoc()
--------------------------------------------------------------------------------
函式:hw_Modifyobject()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_Modifyobject
修改物件记录。
语法: boolean hw_modifyobject(int connection, int object_to_change, array remove, array add, int [mode]);
传回值: 布林值
函式种类: 网路系统
内容说明
本函式可用来移除、增加及修改物件。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 object_to_change 为待修改的物件。参数 remove 及 add 分别为要移除及加入的属性列示。参数 mode 通常省略，若要递回修改，则该参数设为 1。成功则传回 true。
使用范例
例一: 修改属性
// 之前的程式省略
$remarr = array("Name" => "books");
$addarr = array("Name" => "articles");
$hw_modifyobject($connect, $objid, $remarr, $addarr);
// 之后的程式省略
?>
例二: 新增属性
// 之前的程式省略
$remarr = array("Name" => 0);
$addarr = array("Name" => "articles");
$hw_modifyobject($connect, $objid, $remarr, $addarr);
// 之后的程式省略
?>
例三: 修改 title 属性
// 之前的程式省略
$remarr = array("Title" => "en:Books");
$addarr = array("Title" => "en:Articles");
$hw_modifyobject($connect, $objid, $remarr, $addarr);
// 之后的程式省略
?>
例四: 修改 title 属性
// 之前的程式省略
$remarr = array("Title" => array("en" => "Books"));
$addarr = array("Title" => array("en" => "Articles", "ge"=>"Artikel"));
$hw_modifyobject($connect, $objid, $remarr, $addarr);
// 之后的程式省略
?>
例五: 移除属性
// 之前的程式省略
$remarr = array("Title" => "");
$addarr = array("Title" => "en:Articles");
$hw_modifyobject($connect, $objid, $remarr, $addarr);
// 之后的程式省略
?>
--------------------------------------------------------------------------------
函式:hw_New_Document()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_New_Document
建立新文件。
语法: int hw_new_document(string object_record, string document_data, int document_size);
传回值: 整数
函式种类: 网路系统
内容说明
本函式用来建立新的 Hyperwave 文件。参数 object_record 为物件记录。参数 document_data 为文件资料。参数 document_size 为文件大小。值得注意的是本函式不能插入文件到 Hyperwave 伺服器上。
参考
hw_InsertDocument() hw_PipeDocument()
--------------------------------------------------------------------------------
函式:hw_Objrec2Array()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_Objrec2Array
物件记录转为阵列。
语法: array hw_objrec2array(string object_record);
传回值: 阵列
函式种类: 网路系统
内容说明
本函式将物件记录转换成物件阵列。参数 object_record 为物件记录。
--------------------------------------------------------------------------------
函式:hw_OutputDocument()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_OutputDocument
输出文件。
语法: boolean hw_outputdocument(int hw_document);
传回值: 布林值
函式种类: 网路系统
内容说明
本函式将文件输出到标准输出设备上，输出的文件不包含内文标记 (BODY Tag)。成功则传回 true。
--------------------------------------------------------------------------------
函式:hw_pConnect()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_pConnect
连上 Hyperwave 伺服器。
语法: int hw_pconnect(string host, int port, string [username], string [password]);
传回值: 整数
函式种类: 网路系统
内容说明
本函式用来维持与 Hyperwave 伺服器的连线。参数 host 为 Hyperwave 伺服器。参数 port 为连线的 port。参数 username 与 password 可省略，分别为连线使用的帐号及密码，若省略 username 则为匿名使用。成功则传回连线代码，供其它函式使用，失败则传回 false。若已连线上，则使用前回连线的资源。
参考
hw_Close() hw_Connect()
--------------------------------------------------------------------------------
函式:hw_PipeDocument()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_PipeDocument
取得文件。
语法: int hw_pipedocument(int connection, int objectID);
传回值: 整数
函式种类: 网路系统
内容说明
本函式可取回任何格式的文件。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 objectID 为指定的物件 ID 值。
参考
hw_GetText() hw_Free_Document() hw_DocumentBodyTag() hw_DocumentSize() hw_OutputDocument()
--------------------------------------------------------------------------------
函式:hw_Root()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_Root
取得根物件代码。
语法: int hw_root();
传回值: 整数
函式种类: 网路系统
内容说明
本函式用来取得根物件代码
--------------------------------------------------------------------------------
函式:hw_Unlock()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_Unlock
取消锁定。
语法: boolean hw_unlock(int connection, int objectID);
传回值: 布林值
函式种类: 网路系统
内容说明
本函式取消锁定指定的物件。参数 connection 为和 Hyperwave 伺服器的连线代码。参数 objectID 为指定的物件 ID 值。
参考
hw_GetAndLock()
--------------------------------------------------------------------------------
函式:hw_Who()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_Who
列出目前使用者。
语法: array hw_who(int connection);
传回值: 阵列
函式种类: 网路系统
内容说明
本函式用来列出目前正在使用 Hyperwave 伺服器的使用者。参数 connection 为和 Hyperwave 伺服器的连线代码。传回阵列资料包括帐号、姓名、使用时间....等等
--------------------------------------------------------------------------------
函式:hw_GetUsername()
--------------------------------------------------------------------------------
Hyperwave 伺服器函式库
hw_GetUsername
目前使用者名字。
语法: string hw_getusername(int connection);
传回值: 字串
函式种类: 网路系统
内容说明
本函式用来取得目前正在使用 Hyperwave 伺服器的使用者名字。参数 connection 为和 Hyperwave 伺服器的连线代码。
