Funciones de la API Hyperwave

Integración con Apache

La integración con Apache y con otros servidores está descrita en el capítulo aparte.

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