Constantes predefinidasFunciones 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
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().
Note:
Los métodos que devuelven un valor boolean pueden devolver TRUE, FALSE o un objeto HW_API_Error.
Table of Contents
- hw_api_attribute->key — Devuelve la clave del atributo
- hw_api_attribute->langdepvalue — Devuelve el valor para un lenguaje dado
- hw_api_attribute->value — Devuelve el valor del atributo
- hw_api_attribute->values — Devuelve todos los valores del atributo
- hw_api_attribute — Crea una instancia de la clase hw_api_attribute
- hw_api->checkin — Registra un objeto
- hw_api->checkout — Libera un objeto
- hw_api->children — Devuelve los hijos de un objeto
- hw_api_content->mimetype — Devuelve el tipo mime
- hw_api_content->read — Lee contenido
- hw_api->content — Devuelve el contenido de un objeto
- hw_api->copy — Copia físicamente
- hw_api->dbstat — Devuelve las estadísticas sobre el servidor de bases de datos
- hw_api->dcstat — Devuelve las estadísticas sobre el servidor caché de documetos
- hw_api->dstanchors — Devuelve una lista de todas las anclas de destino
- hw_api->dstofsrcanchor — Devuelve el ancla destino de un origen
- hw_api_error->count — Devuelve el número de razones
- hw_api_error->reason — Devuelve la razón del error
- hw_api->find — Busca objetos
- hw_api->ftstat — Devuelve las estadísticas sobre el servidor de texto completo
- hwapi_hgcsp — Devuelve un objeto de la clase hw_api
- hw_api->hwstat — Devuelve las estadísticas sobre el servidor Hyperwave
- hw_api->identify — Ingresar en el Servidor Hyperwave
- hw_api->info — Devuelve información sobre la configuración del servidor
- hw_api->insert — Inserta un nuevo objeto
- hw_api->insertanchor — Inserta un nuevo objeto de tipo ancla
- hw_api->insertcollection — Inserta un nuevo objeto de tipo colección
- hw_api->insertdocument — Inserta un nuevo objeto de tipo documento
- hw_api->link — Crea un enlace a un objeto
- hw_api->lock — Bloquea un objeto
- hw_api->move — Mueve un objeto entre colecciones
- hw_api_content — Crea una nueva instancia de la clase hw_api_content
- hw_api_object->assign — Clona un 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 — Crea una nueva instancia de la clase hw_api_object
- hw_api_object->remove — Elimina un atributo
- hw_api_object->title — Devuelve el título de un atributo
- hw_api_object->value — Devuelve el valor de un atributo
- hw_api->object — Recupera la información de un atributo
- hw_api->objectbyanchor — Devuelve el objeto al que pertenece un ancla
- hw_api->parents — Devuelve los padres de un objeto
- hw_api_reason->description — Devuelve la descripción de una razón
- hw_api_reason->type — Devuelve el tipo de una razón
- hw_api->remove — Borra un objeto
- hw_api->replace — Reemplaza un objeto
- hw_api->setcommittedversion — Asigna una versión diferente de la última versión
- hw_api->srcanchors — Devuelve una lista de todas las anclas fuente
- hw_api->srcsofdst — Devuelve el origen de un objeto destino
- hw_api->unlock — Desbloquea un objeto bloqueado
- hw_api->user — Devuelve el objeto usuario propietario
- hw_api->userlist — Devuelve una lista de todos los usuarios identificados
add a note
User Contributed Notes
Funciones de la API Hyperwave