Hyperwave API Functions
Integration with Apache
The integration with Apache and possible other servers has been described in the separate chapter.
Classes
The API provided by the HW_API extension is fully object oriented. It is very similar to the C++ interface of the Hyperwave SDK. It consist of the following classes.
- HW_API
- HW_API_Object
- HW_API_Attribute
- HW_API_Error
- HW_API_Content
- HW_API_Reason
Each class has certain method, whose names are identical to its counterparts in the Hyperwave SDK. Passing arguments to this function differs from all the other PHP extensions but is close to the C++ API of the HW SDK. Instead of passing several parameters they are all put into an associated array and passed as one parameter. The names of the keys are identical to those documented in the HW SDK. The common parameters are listed below. If other parameters are required they will be documented if needed.
- objectIdentifier The name or id of an object, e.g. "rootcollection", "0x873A8768 0x00000002".
- parentIdentifier The name or id of an object which is considered to be a parent.
- object An instance of class HW_API_Object.
- parameters An instance of class HW_API_Object.
- version The version of an object.
- mode An integer value determine the way an operation is executed.
- attributeSelector Any array of strings, each containing a name of an attribute. This is used if you retrieve the object record and want to include certain attributes.
- objectQuery A query to select certain object out of a list of objects. This is used to reduce the number of objects which was delivered by a function like hw_api::children() or hw_api::find().
Note:
Methods returning boolean can return
TRUE,FALSEor HW_API_Error object.
Table of Contents
- 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 — Returns object of class hw_api
- hwapi_object_new — Creates a new instance of class hwapi_object_new
Vertaling niet beschikbaar
De PHP-handleiding is nog niet in het Nederlands vertaald, dus het scherm is in het Engels. Als u wilt, kunt u het ook in het Frans of in het Duits raadplegen.
Als je de moed voelt, kun je je vertaling aanbieden ;-)
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 30/01/2003 gemaakt, de laatste keer de 26/10/2018 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/php-rf-ref.hwapi.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.
