Syntax array hw_getobjectbyquerycollobj int connection, int objectID, string query, int max hits Description The hw_getobjectbyquerycollobj function, which was added in PHP 3.0.3 and
Trang 1Syntax
array hw_getobjectbyquerycollobj( int connection,
int objectID, string query, int max hits)
Description
The hw_getobjectbyquerycollobj() function, which was added in PHP 3.0.3 and PHP 4.0, returns an array of object records that match the search specified by the
query parameter The scope is limited to the collection specified by the objectID
parameter The max_hits parameter enables you to cap the number of search
results returned (–1 is unlimited) Note that the search works only with indexed attributes
hw_getchilddoccoll()
Syntax
array hw_getchilddoccoll (int connection, int objectID)
Description
The hw_getchilddoccoll() function, which was added in PHP 3.0.3 and PHP 4.0, returns an array of object IDs that are children of the collection denoted by objectID
hw_getchilddoccollobj()
Syntax
array hw_getchilddoccollobj (int connection, int objectID)
Description
The hw_getchilddoccollobj() function, which was added in PHP 3.0.3 and PHP 4.0, returns an array of object records that are children of the collection denoted by
objectID
hw_getanchors()
Syntax
Trang 2Description
The hw_getanchors() function, which was added in PHP 3.0.3 and PHP 4.0, returns
an array of object IDs that are anchors of the document specified by objectID
hw_getanchorsobj()
Syntax
array hw_getanchorsobj (int connection, int objectID)
Description
The hw_getanchorsobj() function, which was added in PHP 3.0.3 and PHP 4.0, returns an array of object records that are anchors of the document specified by
objectID
hw_mv()
Syntax
int hw_mv (int connection, array object id array,
int source id, int destination id)
Description
The hw_mv() function, which was added in PHP 3.0.3 and PHP 4.0, moves the objects
in the object_id_array parameter from the source_id to the destination_id If
the destination_id parameter is set to 0, the objects in the object_id_array will
be unlinked from the source_id collection If this is the last instance of the object, it
will also be deleted
hw_identify()
Syntax
int hw_identify (string username, string password)
Trang 3Description
The hw_identify() function, which was added in PHP 3.0.3 and PHP 4.0, enables you to identify which user is making the request This is most often handled at the time that the connection to the server is established
hw_incollections()
Syntax
array hw_incollections (int connection, array object_id_array,
array collection_id_array, int return-collections)
Description
The hw_incollections() function, which was added in PHP 3.0.3 and PHP 4.0, verifies whether the objects listed in the object_id_array are part of the
collection_id_array If the return-collections parameter is 0, the intersection
of object IDs is returned in an array; if set to 1, the object IDs of the collections that have corresponding children in the object_id_array are returned
hw_info()
Syntax
string hw_info (int connection)
Description
The hw_info() function, which was added in PHP 3.0.3 and PHP 4.0, supplies information on the current status of the specified connection The return string is
formatted as follows: "<Serverstring>, <Host>, <Port>, <Username>, <Port of
Client>, <Byte swapping>"
hw_inscoll()
Syntax
int hw_inscoll (int connection, int objectID, array object array)
Trang 4new collection specified by the object_array parameter into the objectID
collection
hw_insdoc()
Syntax
int hw_insdoc (int connection, int parentID,
string object record, string text)
Description
The hw_insdoc() function, which was added in PHP 3.0.3 and PHP 4.0, places a new document with attributes specified in the object_record parameter into the
collection specified by the parentID parameter An object record will be inserted as
well as the text parameter, if it is present The hw_insertdocument() is more flexible and often used instead
hw_insertdocument()
Syntax
int hw_insertdocument (int connection, int parent id, int hw document)
Description
The hw_insertdocument() function, which was added in PHP 3.0.3 and PHP 4.0, places a new document into the collection specified by the parentID parameter The
document has to be created using hw_newdocument() prior to calling this function The object record of the hw_document should contain Type, DocumentType, Title, and Name at a minimum, with MimeType also recommended The return value is the new object ID or FALSE is unsuccessful
hw_insertobject()
Syntax
int hw_insertobject (int connection, string object rec, string
parameter)
Trang 5Description
The hw_insertobject() function, which was added in PHP 3.0.3 and PHP 4.0, inserts an object into the server The object_rec represents the object record of the
Hyperwave object to be inserted Consult the Hyperwave documentation for
parameter specifications
hw_mapid()
Syntax
int hw_mapid (int connection, nt server id, int object id)
Description
The hw_mapid() function, which was added in PHP 3.0.13 and PHP 4.0b4, enables you to map a global object ID on any Hyperwave server to a virtual object ID, even if you did not connect to the server The global ID is comprised of the server ID as well
as its object ID, where the server ID is the integer representation of the server's IP address Note that to utilize this functionality, Hyperwave must be compiled using the F_DISTRIBUTED flag in the hc_comm.c file
hw_modifyobject()
Syntax
in hw_modifyobject (int connection, int object to change,
array remove, array add, int mode)
Description
The hw_modifyobject() function, which was added in PHP 3.0.7 and PHP 4.0b2, enables you to modify attributes of an object's record The array parameters specify
attributes to remove and add, respectively To modify an existing attribute, you must remove the old one and add it back The mode parameter specifies whether to
process the changes recursively, with 1 indicating yes The following example modifies an attribute:
// $objid is the ID of the object to modify
// $connect is an existing HIS connection
$removearray = array("Name" => "oldname");
$addarray = array("Name" => "newname");