Hyperwave API 函数

Integration with Apache

The integration with Apache and possible other servers has been described in the separate chapter.

Classes

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.

HW_API HW_API_Object HW_API_Attribute HW_API_Error HW_API_Content HW_API_Reason Some basic classes like HW_API_String, HW_API_String_Array, etc., which exist in the Hyperwave SDK have not been implemented since PHP has powerful replacements for them.

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.

objectIdentifier The name or id of an object, e.g. "rootcollection", "0x873A8768 0x00000002". parentIdentifier The name or id of an object which is considered to be a parent. object An instance of class HW_API_Object. parameters An instance of class HW_API_Object. version The version of an object. mode An integer value determine the way an operation is executed. attributeSelector 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. objectQuery 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 hw_api::children() or hw_api::find().

Note:

Methods returning boolean can return TRUE, FALSE or HW_API_Error object.

Table of Contentshw_api::checkin — Checks in an objecthw_api::checkout — Checks out an objecthw_api::children — Returns children of an objecthw_api::content — Returns content of an objecthw_api::copy — Copies physicallyhw_api::dbstat — Returns statistics about database serverhw_api::dcstat — Returns statistics about document cache serverhw_api::dstanchors — Returns a list of all destination anchorshw_api::dstofsrcanchor — Returns destination of a source anchorhw_api::find — Search for objectshw_api::ftstat — Returns statistics about fulltext serverhw_api::hwstat — Returns statistics about Hyperwave serverhw_api::identify — Log into Hyperwave Serverhw_api::info — Returns information about server configurationhw_api::insert — Inserts a new objecthw_api::insertanchor — Inserts a new object of type anchorhw_api::insertcollection — Inserts a new object of type collectionhw_api::insertdocument — Inserts a new object of type documenthw_api::link — Creates a link to an objecthw_api::lock — Locks an objecthw_api::move — Moves object between collectionshw_api::object — Retrieve attribute informationhw_api::objectbyanchor — Returns the object an anchor belongs tohw_api::parents — Returns parents of an objecthw_api::remove — Delete an objecthw_api::replace — Replaces an objecthw_api::setcommittedversion — Commits version other than last versionhw_api::srcanchors — Returns a list of all source anchorshw_api::srcsofdst — Returns source of a destination objecthw_api::unlock — Unlocks a locked objecthw_api::user — Returns the own user objecthw_api::userlist — Returns a list of all logged in usershw_api_attribute::key — Returns key of the attributehw_api_attribute::langdepvalue — Returns value for a given languagehw_api_attribute::value — Returns value of the attributehw_api_attribute::values — Returns all values of the attributehw_api_content::mimetype — Returns mimetypehw_api_content::read — Read contenthw_api_error::count — Returns number of reasonshw_api_error::reason — Returns reason of errorhw_api_object::assign — Clones objecthw_api_object::attreditable — Checks whether an attribute is editablehw_api_object::count — Returns number of attributeshw_api_object::insert — Inserts new attributehw_api_object::remove — Removes attributehw_api_object::title — Returns the title attributehw_api_object::value — Returns value of attributehw_api_reason::description — Returns description of reasonhw_api_reason::type — Returns type of reasonhwapi_attribute_new — Creates instance of class hw_api_attributehwapi_content_new — Create new instance of class hw_api_contenthwapi_hgcsp — Returns object of class hw_apihwapi_object_new — Creates a new instance of class hwapi_object_new

add a note

User Contributed Notes

There are no user contributed notes for this page.