Predefined ConstantsHyperwave API Functions
Integration with Apache
The integration with Apache and possible other servers is already described in the Hyperwave module which has been the first extension to connect a Hyperwave Server.
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
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 Contents
- hw_api_attribute->key — بازگرداندن کلید ویژگی
- hw_api_attribute->langdepvalue — بازگرداندن مقدار زبان داده شده
- hw_api_attribute->value — بازگرداندن مقدار ویژگی
- hw_api_attribute->values — بازگرداندن تمام مقدارهای ویژگی
- hw_api_attribute — ساخت نمونه کلاس hw_api_attribute
- hw_api->checkin — Checks in an object
- hw_api->checkout — Checks out an object
- hw_api->children — Returns children of an object
- hw_api_content->mimetype — بازگرداندن mimetype
- hw_api_content->read — خواندن محتوا
- hw_api->content — Returns content of an object
- hw_api->copy — Copies physically
- hw_api->dbstat — بازگرداندن آمار درباره پایگاه داده
- hw_api->dcstat — بازگرداندن آمار درباره سرور کاشه سند
- hw_api->dstanchors — Returns a list of all destination anchors
- hw_api->dstofsrcanchor — Returns destination of a source anchor
- hw_api_error->count — بازگرداندن تعداد دلایل
- hw_api_error->reason — بازگرداندن دلیل خطا
- hw_api->find — Search for objects
- hw_api->ftstat — بازگرداندن آمار درباره سرور fulltext
- hwapi_hgcsp — Returns object of class hw_api
- hw_api->hwstat — بازگرداندن آمار درباره سرور Hyperwave
- hw_api->identify — Log into Hyperwave Server
- hw_api->info — بازگرداندن اطلاعات درباره تنظیمات سرور
- hw_api->insert — وارد نمودن شی جدید
- hw_api->insertanchor — وارد نمودن شی جدید نوع anchor
- hw_api->insertcollection — Inserts a new object of type collection
- hw_api->insertdocument — Inserts a new object of type document
- hw_api->link — Creates a link to an object
- hw_api->lock — Locks an object
- hw_api->move — انتقال شی بین مجموعه
- hw_api_content — ساخت شی جدید کلاس hw_api_content
- hw_api_object->assign — کپی شی
- hw_api_object->attreditable — بررسی قابلیت ویرایش ویژگی
- hw_api_object->count — بازگرداندن تعداد ویژگی
- hw_api_object->insert — وارد کردن ویژگی جدید
- hw_api_object — ساخت نمونه جدید کلاس hw_api_object
- hw_api_object->remove — حذف ویژگی
- hw_api_object->title — بازگرداندن عنوان ویژگی
- hw_api_object->value — بازگرداندن مقدار ویژگی
- hw_api->object — Retrieve attribute information
- hw_api->objectbyanchor — بازگرداندن شی مالک anchor
- hw_api->parents — Returns parents of an object
- hw_api_reason->description — بازگرداندن توضیج دلیل
- hw_api_reason->type — بازگرداندن نوع دلیل
- hw_api->remove — Delete an object
- hw_api->replace — Replaces an object
- hw_api->setcommittedversion — Commits version other than last version
- hw_api->srcanchors — Returns a list of all source anchors
- hw_api->srcsofdst — Returns source of a destination object
- hw_api->unlock — Unlocks a locked object
- hw_api->user — بازگرداندن شی کاربر
- hw_api->userlist — بازگرداندن فهرست کاربرهای وارد شده
add a note
User Contributed Notes
Hyperwave API Functions - [0 notes]