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().
Nota:
Los métodos que devuelven un valor boolean pueden devolver
TRUE,FALSEo un objeto HW_API_Error.
Tabla de contenidos
- 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 — Creates instance of class hw_api_attribute
- hwapi_content_new — Create new instance of class 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
add a note
User Contributed Notes
Funciones de la API Hyperwave