Funciones de la API Hyperwave

Integración con Apache

La integración con Apache y otros posibles servidores ya está descrita en el módulo Hyperwave, el cual ha sido la primera extensión para conectar un Servidor Hyperwave.

Clases

La API proporcionada por la extensión HW_API está completamente orientada a objetos. Es similar a la interfaz de C++ del SDK de Hyperwave. Consiste en las siguientes clases.

HW_API
HW_API_Object
HW_API_Attribute
HW_API_Error
HW_API_Content
HW_API_Reason

Algunas clases básicas como HW_API_String, HW_API_String_Array, etc., las cuales ya existen en el SDK de Hyperwave, no han sido implementadas porque PHP tiene poderosos sustitutos para ellas.

Cada clase tiene ciertos métodos, cuyos nombres son idénticos a sus equivalentes del SDK de Hyperwave. El pasar argumentos a esta función difiere de todas las extensiones de PHP pero está cercano a la API de C++ del SDK de HW. En vez de pasar varios parámetros, éstos son puestos en un array asociativo y pasado como un parámetro. Los nombres de las claves son idénticos a aquellos documentados en el SDK de HW. Los parámetros más comunes están listados abajo. Si se requieren otros parámetros serán documentados y fuera necesrio.

objectIdentifier El nombre o id de un objeto, p.ej. "rootcollection", "0x873A8768 0x00000002".
parentIdentifier El nombre o id de un objeto que está considerado que es un padre.
object Una instancia de la clase HW_API_Object.
parameters Una instancia de la clase HW_API_Object.
version La versión de un objeto.
mode Un valor de tipo integer determina la manera en que se ejecuta una operación.
attributeSelector Cualquier array de cadenas, cada una conteniendo el nombre de un atributo. Se usa si recupera el registro de objetos y quiere incluir ciertos atributos.
objectQuery Una consulta para seleccionar ciertos objetos de una lista de objetos. Se usa para reducir el número de objetos que fueron despachados por una función como hw_api::children() o hw_api::find().

Nota:
Los métodos que devuelven un valor boolean pueden devolver TRUE, FALSE o un objeto HW_API_Error.

Tabla de contenidos

hw_api::checkin — Registra un objeto
hw_api::checkout — Verifica un objeto
hw_api::children — Devuelve los hijos de un objeto
hw_api::content — Devuelve el contenido de un objeto
hw_api::copy — Copia físicamente
hw_api::dbstat — Devuelve estadísticas sobre el servidor de base de datos
hw_api::dcstat — Devuelve estadísticas sobre el servidor de caché de documentos
hw_api::dstanchors — Devuelve una lista de todas las anclas de destino
hw_api::dstofsrcanchor — Devuelve el destino de un ancla fuente
hw_api::find — Busca objetos
hw_api::ftstat — Devuelve estadísticas sobre el servidor Fulltext
hw_api::hwstat — Devuelve estadísticas sobre el servidor Hyperwave
hw_api::identify — Conectarse al Servidor Hyperwave
hw_api::info — Devuelve información sobre la configuración del servidor
hw_api::insert — Inserta un objeto nuevo
hw_api::insertanchor — Inserta un objeto nuevo de tipo 'anchor'
hw_api::insertcollection — Inserta un objeto nuevo de tipo 'collection'
hw_api::insertdocument — Inserta un objeto nuevo de tipo 'document'
hw_api::link — Crea un link a un objeto
hw_api::lock — Bloquea un objeto
hw_api::move — Mueve un objeto de una colección a otra
hw_api::object — Recupera información de los atributos de un objeto
hw_api::objectbyanchor — Retorna el objeto propietario de un ancla
hw_api::parents — Devuelve los padres de un objeto
hw_api::remove — Eliminar un objeto
hw_api::replace — Reemplaza un objeto
hw_api::setcommittedversion — Consolida (commit) una versión diferente que la última versión
hw_api::srcanchors — Devuelve una lista de todas las anclas fuente
hw_api::srcsofdst — Devuelve la fuente de un objeto de destino
hw_api::unlock — Desbloquea un objeto bloqueado
hw_api::user — Devuelve el propietario de un objeto
hw_api::userlist — Devuelve la lista de todos los usuarios conectados
hw_api_attribute::key — Returns key of the attribute
hw_api_attribute::langdepvalue — Devuelve el valor de un atributo en un idioma determinado
hw_api_attribute::value — Devuelve el valor del atributo
hw_api_attribute::values — Devuelve todos los valores del atributo
hw_api_content::mimetype — Devuelve el tipo MIME
hw_api_content::read — Lee el contenido
hw_api_error::count — Devuelve el número de errores
hw_api_error::reason — Devuelve el primer motivo de error
hw_api_object::assign — Clona objeto
hw_api_object::attreditable — Comprueba si un atributo es editable
hw_api_object::count — Devuelve el número de atributos
hw_api_object::insert — Inserta un nuevo atributo
hw_api_object::remove — Elimina un atributo
hw_api_object::title — Devuelve el atributo title
hw_api_object::value — Devuelve el valor de un atributo
hw_api_reason::description — Devuelve la descripción de la razón
hw_api_reason::type — Devuelve el tipo de la razón
hwapi_attribute_new — Crea una instancia de la clase hw_api_attribute
hwapi_content_new — Crea una nueva instancia de la clase hw_api_content
hwapi_hgcsp — Devuelve un objeto de la clase hw_api
hwapi_object_new — Crea una nueva instancia de la clase hwapi_object_new