Функции Hyperwave API
Интеграция с Apache
Интеграция с Apache и возможными другими серверами была описана в отдельной главе.
Классы
API, предоставляемый модулем HW_API, полностью объектно-ориентирован. Он очень похожи на интерфейс C++ Hyperwave SDK. Состоит из следующих классов.
- HW_API
- HW_API_Object
- HW_API_Attribute
- HW_API_Error
- HW_API_Content
- HW_API_Reason
У каждого класса есть определенный метод, имена которого идентичны его аналогам в Hyperwave SDK. Передача аргументов в эту функцию отличается от всех других модулей PHP, но близка к C++ API HW SDK. Вместо передачи нескольких параметров все они помещаются в связанный массив и передаются как один параметр. Названия ключей идентичны тем, которые задокументированы в HW SDK. Общие параметры перечислены ниже. Если требуются другие параметры, они будут документированы при необходимости.
- objectIdentifier Имя или идентификатор объекта, например, "rootcollection", "0x873A8768 0x00000002".
- parentIdentifier Имя или идентификатор объекта, который считается родительским.
- object Экземпляр класса HW_API_Object.
- parameters Экземпляр класса HW_API_Object.
- version Версия объекта.
- mode Целочисленное значение определяет способ выполнения операции.
- attributeSelector Любой массив строк, каждая из которых содержит имя атрибута. Используется, если вы извлекаете запись объекта и хотите включить определенные атрибуты.
- objectQuery Запрос на выбор определенного объекта из списка объектов. Используется для уменьшения количества объектов, которые были доставлены такой функцией, как hw_api::children() или hw_api::find().
Замечание:
Методы возвращают логическое значение (boolean), могут вернуть
TRUE,FALSEили объект HW_API_Error.
Содержание
- 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 — Returns content of an object
- hw_api::copy — Copies physically
- hw_api::dbstat — Returns statistics about database server
- hw_api::dcstat — Returns statistics about document cache server
- hw_api::dstanchors — Returns a list of all destination anchors
- hw_api::dstofsrcanchor — Returns destination of a source anchor
- hw_api::find — Search for objects
- hw_api::ftstat — Returns statistics about fulltext server
- hw_api::hwstat — Returns statistics about Hyperwave server
- hw_api::identify — Log into Hyperwave Server
- hw_api::info — Returns information about server configuration
- hw_api::insert — Inserts a new object
- hw_api::insertanchor — Inserts a new object of type 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 — Moves object between collections
- hw_api::object — Retrieve attribute information
- hw_api::objectbyanchor — Returns the object an anchor belongs to
- hw_api::parents — Returns parents of an object
- 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 — Returns the own user object
- hw_api::userlist — Returns a list of all logged in users
- hw_api_attribute::key — Returns key of the attribute
- hw_api_attribute::langdepvalue — Returns value for a given language
- hw_api_attribute::value — Returns value of the attribute
- hw_api_attribute::values — Returns all values of the attribute
- hw_api_content::mimetype — Returns mimetype
- hw_api_content::read — Read content
- hw_api_error::count — Returns number of reasons
- hw_api_error::reason — Returns reason of error
- hw_api_object::assign — Clones object
- hw_api_object::attreditable — Checks whether an attribute is editable
- hw_api_object::count — Returns number of attributes
- hw_api_object::insert — Inserts new attribute
- hw_api_object::remove — Removes attribute
- hw_api_object::title — Returns the title attribute
- hw_api_object::value — Returns value of attribute
- hw_api_reason::description — Returns description of reason
- hw_api_reason::type — Returns type of reason
- hwapi_attribute_new — Создает экземпляр класса hw_api_attribute
- hwapi_content_new — Создает новый экземпляр класса hw_api_content
- hwapi_hgcsp — Возвращает объект класса hw_api
- hwapi_object_new — Создает новый экземпляр класса hwapi_object_new
add a note
User Contributed Notes
There are no user contributed notes for this page.
