diff --git a/reference/hwapi/configure.xml b/reference/hwapi/configure.xml index 3a5ce9d5a9..b9b938064d 100644 --- a/reference/hwapi/configure.xml +++ b/reference/hwapi/configure.xml @@ -1,9 +1,9 @@ - +
- &reftitle.install; +&reftitle.install; - Après avoir installé le SDK Hyperwave, compilez PHP avec l'option + After installing the Hyperwave SDK, configure PHP with .
diff --git a/reference/hwapi/functions/hwapi-attribute-key.xml b/reference/hwapi/functions/hwapi-attribute-key.xml index 2be4bfe06a..71d10fe03a 100644 --- a/reference/hwapi/functions/hwapi-attribute-key.xml +++ b/reference/hwapi/functions/hwapi-attribute-key.xml @@ -1,10 +1,10 @@ - + hw_api_attribute->key - Retourne la clé d'un attribut + Returns key of the attribute Description @@ -13,11 +13,10 @@ void - key retourne le nom de l'attribut. + Returns the name of the attribute. - Voir aussi - hwapi_attribute_value. + See also hwapi_attribute_value. diff --git a/reference/hwapi/functions/hwapi-attribute-langdepvalue.xml b/reference/hwapi/functions/hwapi-attribute-langdepvalue.xml index a4e8bac8ad..bd0aaa63f3 100644 --- a/reference/hwapi/functions/hwapi-attribute-langdepvalue.xml +++ b/reference/hwapi/functions/hwapi-attribute-langdepvalue.xml @@ -1,10 +1,10 @@ - + hw_api_attribute->langdepvalue - Retourne la valeur d'un attribut dans une langue + Returns value for a given language Description @@ -13,12 +13,10 @@ stringlanguage - hw_api_attribute->langdepvalue retourne la valeur - de l'attribut dans la langue language. + Returns the value in the given language of the attribute. - Voir aussi - hwapi_attribute_value. + See also hwapi_attribute_value. diff --git a/reference/hwapi/functions/hwapi-attribute-value.xml b/reference/hwapi/functions/hwapi-attribute-value.xml index 2e81164e87..0c3410d500 100644 --- a/reference/hwapi/functions/hwapi-attribute-value.xml +++ b/reference/hwapi/functions/hwapi-attribute-value.xml @@ -1,24 +1,23 @@ - + hw_api_attribute->value - Retourne la valeur de l'attribut HW + Returns value of the attribute Description - stringhw_api_attribute->value + stringvalue void - hw_api_attribute->value retourne la valeur de l'attribut. + Returns the value of the attribute. - Voir aussi - hwapi_attribute_key et - hwapi_attribute_values. + See also hwapi_attribute_key, + hwapi_attribute_values. diff --git a/reference/hwapi/functions/hwapi-attribute-values.xml b/reference/hwapi/functions/hwapi-attribute-values.xml index 4d85c2b2f7..2d48d56dc0 100644 --- a/reference/hwapi/functions/hwapi-attribute-values.xml +++ b/reference/hwapi/functions/hwapi-attribute-values.xml @@ -1,12 +1,10 @@ - + hw_api_attribute->values - - Retourne toutes les valeurs de l'attribut sous la forme d'un tableau de chaînes - + Returns all values of the attribute Description @@ -15,12 +13,10 @@ void - hw_api_attribute->values retourne toutes - les valeurs de l'attribut sous la forme d'un tableau de chaînes. + Returns all values of the attribute as an array of strings. - Voir aussi - hwapi_attribute_value. + See also hwapi_attribute_value. diff --git a/reference/hwapi/functions/hwapi-attribute.xml b/reference/hwapi/functions/hwapi-attribute.xml index 343e23b77c..5b59ee6a51 100644 --- a/reference/hwapi/functions/hwapi-attribute.xml +++ b/reference/hwapi/functions/hwapi-attribute.xml @@ -1,10 +1,10 @@ - + hw_api_attribute - Crée une nouvelle instance de la classe hw_api_attribute + Creates instance of class hw_api_attribute Description @@ -14,10 +14,7 @@ stringvalue - hw_api_attribute->attribute - crée une nouvelle instance de la classe - hw_api_attribute avec le nom name - et la valeur value. + Creates a new instance of hw_api_attribute with the given name and value. diff --git a/reference/hwapi/functions/hwapi-checkin.xml b/reference/hwapi/functions/hwapi-checkin.xml index 15d5a22b49..bfb427eb46 100644 --- a/reference/hwapi/functions/hwapi-checkin.xml +++ b/reference/hwapi/functions/hwapi-checkin.xml @@ -1,10 +1,10 @@ - + hw_api->checkin - Archive un objet + Checks in an object Description @@ -13,72 +13,70 @@ arrayparameter - hw_api->checkin archive un objet ou - une hiérarchie d'objets. Le paramètre obligatoire - parameter contient un 'objectIdentifier' - et les éléments optionnels 'version', 'comment', 'mode' et - 'objectQuery'. 'version' spécifie la version de l'objet. - Elle est constituée de version majeure et mineure, séparée par des - virgules. Si une version n'existe pas, la version mineure est incrémentée. - 'mode' peut être l'une des constantes suivantes : + This function checks in an object or a whole hiearchie of objects. + The parameters array contains the required element + 'objectIdentifier' and the optional element 'version', 'comment', 'mode' + and + 'objectQuery'. 'version' sets the version of the object. It consists of + the major and minor version separated by a period. If the version is not + set, the minor version is incremented. 'mode' can be one of the following + values: - HW_API_CHECKIN_NORMAL + HW_API_CHECKIN_NORMAL - Archive et valide l'objet. L'objet doit être un document. + Checks in and commits the object. The object must be a document. - HW_API_CHECKIN_RECURSIVE + HW_API_CHECKIN_RECURSIVE - Si l'objet à archiver est une collection, tous les fils seront - vérifié récursivement, si ils sont des documents. Tenter d'archiver - une collectoin générera une erreur. + If the object to check in is a collection, all children will be + checked in recursively if they are documents. Trying to check in + a collection would result in an error. - HW_API_CHECKIN_FORCE_VERSION_CONTROL + HW_API_CHECKIN_FORCE_VERSION_CONTROL - Archive un objet même si il ne passe pas sous le contrôle de - versions. + Checks in an object even if it is not under version control. - HW_API_CHECKIN_REVERT_IF_NOT_CHANGED + HW_API_CHECKIN_REVERT_IF_NOT_CHANGED - Vérifie si il existe une version différente de la dernière version. - A moins que cela ne soit le cas, l'objet sera alors archivé. + Check if the new version is different from the last version. Unless + this is the case the object will be checked in. - HW_API_CHECKIN_KEEP_TIME_MODIFIED + HW_API_CHECKIN_KEEP_TIME_MODIFIED - Conserve la date de modification du plus récent objet. + Keeps the time modified from the most recent object. - HW_API_CHECKIN_NO_AUTO_COMMIT + HW_API_CHECKIN_NO_AUTO_COMMIT - L'objet n'est pas automatiquement validé lors de l'archivage. + The object is not automatically commited on checkin. - Voir aussi - hwapi_checkout. + See also hwapi_checkout. diff --git a/reference/hwapi/functions/hwapi-checkout.xml b/reference/hwapi/functions/hwapi-checkout.xml index 0caf30dd44..487b8e28a5 100644 --- a/reference/hwapi/functions/hwapi-checkout.xml +++ b/reference/hwapi/functions/hwapi-checkout.xml @@ -1,10 +1,10 @@ - + hw_api->checkout - Extrait un objet + Checks out an object Description @@ -13,17 +13,16 @@ arrayparameter - hw_api->checkout extrait un objet ou - toute une hiérarchie d'objets. Le paramètre parameter - contient l'élément obligatoire 'objectIdentifier' et les éléments - optionnels 'version', 'mode' et 'objectQuery'. 'mode' peut prendre l'une des - valeurs suivantes : + This function checks out an object or a whole hiearchie of objects. + The parameters array contains the required element + 'objectIdentifier' and the optional element 'version', 'mode' + and 'objectQuery'. 'mode' can be one of the following values: HW_API_CHECKIN_NORMAL - Extrait un objet. L'objet doit être un document. + Checks out an object. The object must be a document. @@ -31,17 +30,16 @@ HW_API_CHECKIN_RECURSIVE - Si l'objet à extraire est une collection, tous les fils seront - extraits récursivement, si ce sont des documents. Extraire une - collection générera une erreur. + If the object to check out is a collection, all children will be + checked out recursively if they are documents. Trying to check out + a collection would result in an error. - Voir aussi - hwapi_checkin. + See also hwapi_checkin. diff --git a/reference/hwapi/functions/hwapi-children.xml b/reference/hwapi/functions/hwapi-children.xml index 8c012eea48..acdb1441ba 100644 --- a/reference/hwapi/functions/hwapi-children.xml +++ b/reference/hwapi/functions/hwapi-children.xml @@ -1,10 +1,10 @@ - + hw_api->children - Retourne le fils d'un objet + Returns children of an object Description @@ -13,19 +13,19 @@ arrayparameter - hw_api->children retrouve le fils d'une collection - ou l'attribut d'un document. Le fils peut être ensuite filtré en - spécifiant une requête d'objet. Le paramètre parameter - contient les éléments requis 'objectIdentifier' et les éléments - optionnels 'attributeSelector' et 'objectQuery'. + Retrieves the children of a collection or the attributes of a document. + The children can be further filtered by specifying an object query. + The parameter array + contains the required elements 'objectIdentifier' and the optional + elements 'attributeSelector' and 'objectQuery'. - La valeur retournée est un tableau d'objets de type - HW_API_Object ou + The return value is an array of objects of type + HW_API_Object or HW_API_Error. - Voir aussi hwapi_parents. + See also hwapi_parents. diff --git a/reference/hwapi/functions/hwapi-content-mimetype.xml b/reference/hwapi/functions/hwapi-content-mimetype.xml index 31ae607169..72802104ac 100644 --- a/reference/hwapi/functions/hwapi-content-mimetype.xml +++ b/reference/hwapi/functions/hwapi-content-mimetype.xml @@ -1,10 +1,10 @@ - + hw_api_content->mimetype - Retourne le type MIME + Returns mimetype Description @@ -13,7 +13,7 @@ void - hw_api_content->mimetype retourne le type MIME du contenu. + Returns the mimetype of the content. diff --git a/reference/hwapi/functions/hwapi-content-read.xml b/reference/hwapi/functions/hwapi-content-read.xml index d0b58383a1..f11f48ee54 100644 --- a/reference/hwapi/functions/hwapi-content-read.xml +++ b/reference/hwapi/functions/hwapi-content-read.xml @@ -1,10 +1,10 @@ - + hw_api_content->read - Lit le contenu + Read content Description @@ -14,8 +14,8 @@ integerlen - hw_api_content->read lit len octets dans le - buffer buffer. + Reads len bytes from the content into the given + buffer. diff --git a/reference/hwapi/functions/hwapi-content.xml b/reference/hwapi/functions/hwapi-content.xml index 9b2b9e5b1e..a887efe1de 100644 --- a/reference/hwapi/functions/hwapi-content.xml +++ b/reference/hwapi/functions/hwapi-content.xml @@ -1,10 +1,10 @@ - + hw_api->content - Retourne le contenu d'un objet + Returns content of an object Description @@ -13,22 +13,19 @@ arrayparameter - hw_api->content retourne le contenu d'un - document sous la forme d'un objet de type - hw_api_content. Le paramètre - parameter est un tableau qui contient - l'élément obligatoire 'objectidentifier' et l'élément optionnel - 'mode'. Le mode peut être l'une des constantes suivantes : + This function returns the content of a document as an object of type + hw_api_content. The parameter array + contains the required elements 'objectidentifier' and the optional + element 'mode'. The mode can be one of the constants HW_API_CONTENT_ALLLINKS, - HW_API_CONTENT_REACHABLELINKS ou + HW_API_CONTENT_REACHABLELINKS or HW_API_CONTENT_PLAIN. - HW_API_CONTENT_ALLLINKS signifie qu'il faut insérer - toutes les ancres même si la destination n'est pas accessible. - HW_API_CONTENT_REACHABLELINKS indique à - hw_api_content qu'il faut insérer uniquement les - destinations accessibles, et - HW_API_CONTENT_PLAIN conduit à un document sans - aucun liens. + HW_API_CONTENT_ALLLINKS means to insert all + anchors even if the destination is not reachable. + HW_API_CONTENT_REACHABLELINKS tells + hw_api_content to insert only reachable links and + HW_API_CONTENT_PLAIN will lead to + document without any links. diff --git a/reference/hwapi/functions/hwapi-copy.xml b/reference/hwapi/functions/hwapi-copy.xml index a8fe0fcaf4..d743c7056b 100644 --- a/reference/hwapi/functions/hwapi-copy.xml +++ b/reference/hwapi/functions/hwapi-copy.xml @@ -1,5 +1,5 @@ - + @@ -13,17 +13,15 @@ arrayparameter - hw_api->copy fait une copie physique incluant - le contenu éventuel, et retourne un nouvel objet, ou un objet d'erreur. - Le paramètre parameter est un tableau, qui - contient les éléments obligatoires 'objectIdentifier' et - 'destinationParentIdentifier' et l'élément optionnel - 'attributeSelector'. + This function will make a physical copy including the content if it + exists and returns the new object or an error object. + The parameter array contains the + required elements 'objectIdentifier' and 'destinationParentIdentifier'. + The optional parameter is 'attributeSelector'` - Voir aussi - hwapi_move et - hwapi_link. + See also hwapi_move, + hwapi_link. diff --git a/reference/hwapi/functions/hwapi-dbstat.xml b/reference/hwapi/functions/hwapi-dbstat.xml index 9b143a40c2..23f106882c 100644 --- a/reference/hwapi/functions/hwapi-dbstat.xml +++ b/reference/hwapi/functions/hwapi-dbstat.xml @@ -1,10 +1,10 @@ - + hw_api->dbstat - Retourne des statistiques sur le serveur de bases + Returns statistics about database server Description @@ -13,13 +13,11 @@ arrayparameter - dbstat retourne des statistiques sur le serveur de bases. - Voir aussi - hwapi_dcstat, - hwapi_hwstat et - hwapi_ftstat. + See also hwapi_dcstat, + hwapi_hwstat, + hwapi_ftstat. diff --git a/reference/hwapi/functions/hwapi-dcstat.xml b/reference/hwapi/functions/hwapi-dcstat.xml index 8eca90b41f..17a6d7598f 100644 --- a/reference/hwapi/functions/hwapi-dcstat.xml +++ b/reference/hwapi/functions/hwapi-dcstat.xml @@ -1,10 +1,10 @@ - + hw_api->dcstat - Retourne des statistiques sur le serveur de cache de document + Returns statistics about document cache server Description @@ -13,14 +13,11 @@ arrayparameter - hw_api->dcstat retourne des statistiques sur - le serveur de cache de document. - Voir aussi - hwapi_hwstat, - hwapi_dbstat et - hwapi_ftstat. + See also hwapi_hwstat, + hwapi_dbstat, + hwapi_ftstat. diff --git a/reference/hwapi/functions/hwapi-dstanchors.xml b/reference/hwapi/functions/hwapi-dstanchors.xml index 5bae5fd8b1..39a23ca18b 100644 --- a/reference/hwapi/functions/hwapi-dstanchors.xml +++ b/reference/hwapi/functions/hwapi-dstanchors.xml @@ -1,10 +1,10 @@ - + hw_api->dstanchors - Liste toutes les ancres de destination + Returns a list of all destination anchors Description @@ -13,14 +13,13 @@ arrayparameter - hw_api->dstanchors liste toutes les ancres de - destination. Le paramètre parameter contient - l'élément obligatoire 'objectIdentifier' et les éléments optionnels - 'attributeSelector' et 'objectQuery'. + Retrieves all destination anchors of an object. The parameter array + contains + the required element 'objectIdentifier' and the optional elements + 'attributeSelector' and 'objectQuery'. - Voir aussi - hwapi_srcanchors. + See also hwapi_srcanchors. diff --git a/reference/hwapi/functions/hwapi-dstofsrcanchors.xml b/reference/hwapi/functions/hwapi-dstofsrcanchors.xml index b5319aeea9..fd993bc098 100644 --- a/reference/hwapi/functions/hwapi-dstofsrcanchors.xml +++ b/reference/hwapi/functions/hwapi-dstofsrcanchors.xml @@ -1,10 +1,10 @@ - + hw_api->dstofsrcanchors - Retourne la destination d'une ancre source + Returns destination of a source anchor Description @@ -13,18 +13,15 @@ arrayparameter - hw_api->dstofsrcanchors retourne l'objet de destination - sur lequel pointe l'ancre source spécifiée. L'objet de destination - peut être une ancre de destination ou un document entier. - Le paramètre parameter contient - l'élément obligatoire 'objectIdentifier' et le paramètre optionnel - 'attributeSelector'. + Retrieves the destination object pointed by the specified source anchors. + The destination object can either be a destination anchor or a whole + document. The parameters array contains the required element + 'objectIdentifier' and the optional element 'attributeSelector'. - Voir aussi - hwapi_srcanchors, - hwapi_dstanchors et - hwapi_objectbyanchor. + See also hwapi_srcanchors, + hwapi_dstanchors, + hwapi_objectbyanchor. diff --git a/reference/hwapi/functions/hwapi-error-count.xml b/reference/hwapi/functions/hwapi-error-count.xml index 74ee52f2ed..ad794872d2 100644 --- a/reference/hwapi/functions/hwapi-error-count.xml +++ b/reference/hwapi/functions/hwapi-error-count.xml @@ -1,10 +1,10 @@ - + hw_api_error->count - Retourne le nombre de raisons d'erreurs + Returns number of reasons Description @@ -13,12 +13,10 @@ void - hw_api_error->count retourne le nombre - de raisons d'erreurs. + Returns the number of error reasons. - Voir aussi - hwapi_error_reason. + See also hwapi_error_reason. diff --git a/reference/hwapi/functions/hwapi-error-reason.xml b/reference/hwapi/functions/hwapi-error-reason.xml index f6281a54ed..4b67a32b06 100644 --- a/reference/hwapi/functions/hwapi-error-reason.xml +++ b/reference/hwapi/functions/hwapi-error-reason.xml @@ -1,23 +1,22 @@ - + hw_api_error->reason - Retourne la première raison d'erreur + Returns reason of error Description - objecthw_api_error->reason + objectreason void - hw_api_error->reason retourne la première raison d'erreur. + Returns the first error reason. - Voir aussi - hwapi_error_count. + See also hwapi_error_count. diff --git a/reference/hwapi/functions/hwapi-find.xml b/reference/hwapi/functions/hwapi-find.xml index ed4524a422..8ef198391e 100644 --- a/reference/hwapi/functions/hwapi-find.xml +++ b/reference/hwapi/functions/hwapi-find.xml @@ -1,10 +1,10 @@ - + hw_api->find - Recherche des objets + Search for objects Description @@ -13,19 +13,17 @@ arrayparameter - hw_api->find recherche des objets grâce à - leur clé d'exécution et/ou grâce à une requête en texte plein. Les - objets trouvés peuvent alors être filtrés à nouveau par une requête - optionnelle. Les objets sont triés par importance. La seconde - opération de recherche est relativement lente, et ses résultats peuvent - être limités à certaines valeurs. Cela permet de réaliser des recherches - incrémentales, chacune retournant un sous ensemble de tous les - documents trouvés, en partant d'un index donné. Le paramètre - parameter est un tableau qui contient les - éléments obligatoires 'objectquery', 'scope', 'lanugages' et - 'attributeselector'. En cas de recherche incrémentale, les éléments - optionnels 'startIndex', 'numberOfObjectsToGet' et 'exactMatchUnit' - peuvent aussi être passés. + This functions searches for objects either by executing a key or/and full + text query. The found objects can further be filtered by an optional + object query. They are sorted by their importance. The second search + operation is relatively slow and its result can be limited to a certain + number of hits. This allows to perform an incremental search, each + returning just a subset of all found documents, starting at a given + index. The parameter array contains the 'keyquery' or/and 'fulltextquery' + depending on who you would like to search. Optional parameters are + 'objectquery', 'scope', 'lanugages' and 'attributeselector'. In case of + an incremental search the optional parameters 'startIndex', + numberOfObjectsToGet' and 'exactMatchUnit' can be passed. diff --git a/reference/hwapi/functions/hwapi-ftstat.xml b/reference/hwapi/functions/hwapi-ftstat.xml index 1f8ca11898..f3f4585199 100644 --- a/reference/hwapi/functions/hwapi-ftstat.xml +++ b/reference/hwapi/functions/hwapi-ftstat.xml @@ -1,10 +1,10 @@ - + hw_api->ftstat - Retourne des statistiques sur le serveur de textes + Returns statistics about fulltext server Description @@ -13,13 +13,11 @@ arrayparameter - ftstat retourne des statistiques sur le serveur de textes. - Voir aussi - hwapi_dcstat, - hwapi_dbstat et - hwapi_hwstat. + See also hwapi_dcstat, + hwapi_dbstat, + hwapi_hwstat. diff --git a/reference/hwapi/functions/hwapi-hgcsp.xml b/reference/hwapi/functions/hwapi-hgcsp.xml index f23fd45796..c7f85497a5 100644 --- a/reference/hwapi/functions/hwapi-hgcsp.xml +++ b/reference/hwapi/functions/hwapi-hgcsp.xml @@ -1,10 +1,10 @@ - + hwapi_hgcsp - Retourne un objet de classe hw_api + Returns object of class hw_api Description @@ -14,14 +14,12 @@ intport - hwapi_hgcsp ouvre une connexion - au serveur Hyperwave sur l'hôte - hostname. Le protocole utilisé est - HGCSP. Si vous l'omettez, le port 418 sera utilisé. + Opens a connection to the Hyperwave server on host + hostname. The protocol used is HGCSP. + If you do not pass a port number, 418 is used. - Voir aussi - hwapi_hwtp. + See also hwapi_hwtp. diff --git a/reference/hwapi/functions/hwapi-hwstat.xml b/reference/hwapi/functions/hwapi-hwstat.xml index 09a4ddf6b1..3fdc8cbb41 100644 --- a/reference/hwapi/functions/hwapi-hwstat.xml +++ b/reference/hwapi/functions/hwapi-hwstat.xml @@ -1,10 +1,10 @@ - + hw_api->hwstat - Retourne les statistiques sur le serveur Hyperwave + Returns statistics about Hyperwave server Description @@ -13,14 +13,11 @@ arrayparameter - hwstat - hwstat retourne les statistiques sur le serveur Hyperwave. - Voir aussi - hwapi_dcstat, - hwapi_dbstat et - hwapi_ftstat. + See also hwapi_dcstat, + hwapi_dbstat, + hwapi_ftstat. diff --git a/reference/hwapi/functions/hwapi-identify.xml b/reference/hwapi/functions/hwapi-identify.xml index d636f0e8e8..e33e3a5d04 100644 --- a/reference/hwapi/functions/hwapi-identify.xml +++ b/reference/hwapi/functions/hwapi-identify.xml @@ -1,10 +1,10 @@ - + hw_api->identify - S'identifie auprès du serveur Hyperwave + Log into Hyperwave Server Description @@ -13,14 +13,13 @@ arrayparameter - hw_api->identify s'identifie auprès du serveur - Hyperwave. Le paramètre parameter est un tableau - qui contient les éléments obligatoires 'username' et 'password'. + Logs into the Hyperwave Server. The parameter array must contain the + elements 'username' und 'password'. - La valeur retournée sera un objet du type - HW_API_Error si l'identification a échoué, - ou bien &true; si cela a fonctionné. + The return value will be an object of type + HW_API_Error if identification failed or TRUE + if it was successful. diff --git a/reference/hwapi/functions/hwapi-info.xml b/reference/hwapi/functions/hwapi-info.xml index 1a24cfc815..f0cbe38a42 100644 --- a/reference/hwapi/functions/hwapi-info.xml +++ b/reference/hwapi/functions/hwapi-info.xml @@ -1,10 +1,10 @@ - + hw_api->info - Retourne des information sur la configuration du serveur + Returns information about server configuration Description @@ -13,15 +13,12 @@ arrayparameter - hw_api->info retourne des information sur la configuration - du serveur. - Voir aussi - hwapi_dcstat, - hwapi_dbstat, - hwapi_ftstat et - hwapi_hwstat. + See also hwapi_dcstat, + hwapi_dbstat, + hwapi_ftstat, + hwapi_hwstat. diff --git a/reference/hwapi/functions/hwapi-insert.xml b/reference/hwapi/functions/hwapi-insert.xml index ef59665d72..05eb807ec7 100644 --- a/reference/hwapi/functions/hwapi-insert.xml +++ b/reference/hwapi/functions/hwapi-insert.xml @@ -1,10 +1,10 @@ - + hw_api->insert - Insère un nouvel objet + Inserts a new object Description @@ -13,34 +13,33 @@ arrayparameter - hw_api->insert insère un nouvel objet. Le type - d'objet peut être user, group, document ou anchor. Suivant le type - de l'autre objet, des attributs supplémentaires doivent être assignés. - Le paramètre parameter est un tableau qui contient - les élément obligatoires 'object' et 'content' (si l'objet est un - document) et les éléments optionnels 'parameters', 'mode' et 'attributeSelector'. - 'object' doit contenir tous les attributs de l'objet. - 'parameters' est un objet, qu contient les attributs supplémentaires, - comme ceux de destination (attribut 'Parent'). 'content' est une - combinaison des constantes suivantes : + Insert a new object. The object type can be user, group, document or + anchor. Depending on the type other object attributes has to be set. + The parameter array contains the required elements 'object' and 'content' + (if the object is a document) and the optional parameters 'parameters', + 'mode' and 'attributeSelector'. The 'object' must contain all attributes + of the object. 'parameters' is an object as well holding futher + attributes like the destination (attribute key is 'Parent'). 'content' is + the content of the document. 'mode' can be a + combination of the following flags: HW_API_INSERT_NORMAL - L'object est inseré sur le serveur. + The object in inserted into the server. - HW_API_INSERT_FORCE-VERSION-CONTROL + HW_API_INSERT_FORCE_VERSION_CONTROL - HW_API_INSERT_AUTOMATIC-CHECKOUT + HW_API_INSERT_AUTOMATIC_CHECKOUT @@ -70,8 +69,7 @@ - Voir aussi - hwapi_replace. + See also hwapi_replace. diff --git a/reference/hwapi/functions/hwapi-insertanchor.xml b/reference/hwapi/functions/hwapi-insertanchor.xml index 24acd78fde..a043f08ff7 100644 --- a/reference/hwapi/functions/hwapi-insertanchor.xml +++ b/reference/hwapi/functions/hwapi-insertanchor.xml @@ -1,10 +1,10 @@ - + hw_api->insertanchor - Insère un nouvel objet de type ancre + Inserts a new object of type anchor Description @@ -13,23 +13,23 @@ arrayparameter - hw_api->insertanchor est un raccourci pour - hwapi_insert. Elle insère un objet de type - ancre ('anchor') et assigne les attribus nécessaires. - Le paramètre parameter contient les éléments obligatoires - 'object' et 'documentIdentifier' et les éléments optionnels - 'destinationIdentifier', 'parameter', 'hint' et 'attributeSelector'. - L'élément 'documentIdentifier' spécifie le document d'insertion de l'ancre. - La cible de l'ancre est spécifiée par 'destinationIdentifier' si il - existe. Si la cible n'existe pas, l'élément 'hint' doit être configuré - avec le nom de l'objet qui est prévu pour être inséré ultérieurement. - Une fois que l'insertion a été faite, la cible sera résolue automatiquement. + This function is a shortcut for hwapi_insert. It + inserts an object of type anchor and sets some of the attributes + required + for an anchor. The parameter array contains the required elements + 'object' and 'documentIdentifier' and the optional elements + 'destinationIdentifier', 'parameter', 'hint' and 'attributeSelector'. + The 'documentIdentifier' + specifies the document where the anchor shall be inserted. The target of + the anchor is set in 'destinationIdentifier' if it already exists. If the + target does not exists the element 'hint' has to be set to the name of + object which is supposed to be inserted later. Once it is inserted the + anchor target is resolved automatically. - Voir aussi - hwapi_insertdocument, - hwapi_insertcollection et - hwapi_insert. + See also hwapi_insertdocument, + hwapi_insertcollection, + hwapi_insert. diff --git a/reference/hwapi/functions/hwapi-insertcollection.xml b/reference/hwapi/functions/hwapi-insertcollection.xml index 454a2b4304..d97fd7a478 100644 --- a/reference/hwapi/functions/hwapi-insertcollection.xml +++ b/reference/hwapi/functions/hwapi-insertcollection.xml @@ -1,10 +1,10 @@ - + hw_api->insertcollection - Insère un nouvel objet de type collection + Inserts a new object of type collection Description @@ -13,20 +13,18 @@ arrayparameter - hw_api->insertcollection est un raccourci pour la fonction - hwapi_insert. Elle insère un objet de type - collection et lui assigne certains attributs obligatoires. - parameter est un tableau qui contient - les éléments obligatoires 'object' et 'parentIdentifier', et les - éléments optionnels 'parameter' et 'attributeSelector'. Voyez - hwapi_insert pour connaitre le détails de chaque - élément. + This function is a shortcut for hwapi_insert. It + inserts an object of type collection and sets some of the attributes + required + for a collection. The parameter array contains the required elements + 'object' and 'parentIdentifier' and the optional elements + 'parameter' and 'attributeSelector'. See + hwapi_insert for the meaning of each element. - Voir aussi - hwapi_insertdocument, - hwapi_insertanchor et - hwapi_insert. + See also hwapi_insertdocument, + hwapi_insertanchor, + hwapi_insert. diff --git a/reference/hwapi/functions/hwapi-insertdocument.xml b/reference/hwapi/functions/hwapi-insertdocument.xml index e5cf1b68bc..6a4c4a4740 100644 --- a/reference/hwapi/functions/hwapi-insertdocument.xml +++ b/reference/hwapi/functions/hwapi-insertdocument.xml @@ -1,10 +1,10 @@ - + hw_api->insertdocument - Insère un nouvel objet de type document + Inserts a new object of type document Description @@ -13,20 +13,17 @@ arrayparameter - hw_api->insertdocument est un raccourci pour - hwapi_insert. Il insère un objet avec un contenu - et assigne certains attributs obligatoires. Le paramètre - parameter est un tableau qui contient - les éléments obligatoires 'object', 'parentIdentifier' et 'content' et - les éléments optionnels 'mode', 'parameter' et 'attributeSelector'. - Voyez hwapi_insert pour la signification de chacun - des éléments. + This function is a shortcut for hwapi_insert. It + inserts an object with content and sets some of the attributes required + for a document. The parameter array contains the required elements + 'object', 'parentIdentifier' and 'content' and the optional elements + 'mode', 'parameter' and 'attributeSelector'. See + hwapi_insert for the meaning of each element. - Voir aussi - hwapi_insert - hwapi_insertanchor et - hwapi_insertcollection. + See also hwapi_insert + hwapi_insertanchor, + hwapi_insertcollection. diff --git a/reference/hwapi/functions/hwapi-link.xml b/reference/hwapi/functions/hwapi-link.xml index 2e00ef351f..6d2915d71d 100644 --- a/reference/hwapi/functions/hwapi-link.xml +++ b/reference/hwapi/functions/hwapi-link.xml @@ -1,31 +1,28 @@ - + hw_api->link - Crée un lien avec un objet + Creates a link to an object Description - objecthw_api->link + objectlink arrayparameter - hw_api->link crée un lien avec un objet. - Accéder à ce lien revient à accéder à l'objet vers lequel il pointe. - Le paramètre parameter contient les - éléments obligatoires de 'objectIdentifier' et 'destinationParentIdentifier'. - 'destinationParentIdentifier' est la collection de destination. + Creates a link to an object. Accessing this link is like accessing the + object to links points to. The parameter array contains the required + elements 'objectIdentifier' and 'destinationParentIdentifier'. + 'destinationParentIdentifier' is the target collection. - hw_api->link retourne &true; en cas de succès, - et sinon, un objet d'erreur. + The function returns &true; on success or an error object. - Voir aussi - hwapi_copy. + See also hwapi_copy. diff --git a/reference/hwapi/functions/hwapi-lock.xml b/reference/hwapi/functions/hwapi-lock.xml index a31c16cd7d..ed97e12235 100644 --- a/reference/hwapi/functions/hwapi-lock.xml +++ b/reference/hwapi/functions/hwapi-lock.xml @@ -1,10 +1,10 @@ - + hw_api->lock - Verrouille un objet + Locks an object Description @@ -13,22 +13,21 @@ arrayparameter - hw_api->lock verrouille un objet pour le faire - éditer exclusivement par l'utilisateur qui appelle cette fonction. - L'objet ne peut être déverrouillé que par cet utilisateur ou par le - système. Le paramètre parameter est un tableau - qui contient l'élément obligatoire 'objectIdentifier' et les paramètres - optionnels 'mode' et 'objectquery'. 'mode' détermine comment l'objet - est verrouillé. HW_API_LOCK_NORMAL signifie que le - 'objet est verrouillé jusqu'à son déverrouillage. - HW_API_LOCK_RECURSIVE est uniquement valide pour une collection - et verrouille tous les objets de la collexion et des sous-collections. - HW_API_LOCK_SESSION signifie que l'objet est verrouillé - aussi longtemps que tient la session en cours. + Locks an object for exclusive editing by the user calling this function. + The object can be only unlocked by this user or the sytem user. The + parameter array contains the required element 'objectIdentifier' and the + optional parameters 'mode' and 'objectquery'. + 'mode' determines how an object is locked. + HW_API_LOCK_NORMAL means, + an object is locked until it is unlocked. + HW_API_LOCK_RECURSIVE + is only valid for collection and locks all objects + within th collection und possible subcollections. + HW_API_LOCK_SESSION means, an + object is locked only as long as the session is valid. - Voir aussi - hwapi_unlock. + See also hwapi_unlock. diff --git a/reference/hwapi/functions/hwapi-move.xml b/reference/hwapi/functions/hwapi-move.xml index face84cc93..d274bed104 100644 --- a/reference/hwapi/functions/hwapi-move.xml +++ b/reference/hwapi/functions/hwapi-move.xml @@ -1,10 +1,10 @@ - + hw_api->move - Déplace un objet d'une collection à l'autre + Moves object between collections Description @@ -13,12 +13,9 @@ arrayparameter - hw_api->move déplace un objet d'une collection - à l'autre. - Voir aussi - hw_objrec2array. + See also hw_objrec2array. diff --git a/reference/hwapi/functions/hwapi-new-content.xml b/reference/hwapi/functions/hwapi-new-content.xml index ec8e109ad8..0c37ee723f 100644 --- a/reference/hwapi/functions/hwapi-new-content.xml +++ b/reference/hwapi/functions/hwapi-new-content.xml @@ -1,10 +1,10 @@ - + - hw_api->content - Crée une nouvelle instance de la classe hw_api_content + hw_api_content + Create new instance of class hw_api_content Description @@ -14,8 +14,8 @@ stringmimetype - hw_api-> crée un nouvel objet de contenu à partir de la chaîne - content. Le type MIME utilisé est + Creates a new content object from the string + content. The mimetype is set to mimetype. diff --git a/reference/hwapi/functions/hwapi-object-assign.xml b/reference/hwapi/functions/hwapi-object-assign.xml index a5d96cde28..d0a4dd1ab8 100644 --- a/reference/hwapi/functions/hwapi-object-assign.xml +++ b/reference/hwapi/functions/hwapi-object-assign.xml @@ -1,10 +1,10 @@ - + hw_api_object->assign - Clone un objet + Clones object Description @@ -13,7 +13,7 @@ arrayparameter - hw_api_object->assign clone les attributs d'un objet. + Clones the attributes of an object. diff --git a/reference/hwapi/functions/hwapi-object-attreditable.xml b/reference/hwapi/functions/hwapi-object-attreditable.xml index c2929a2d92..c291a0a611 100644 --- a/reference/hwapi/functions/hwapi-object-attreditable.xml +++ b/reference/hwapi/functions/hwapi-object-attreditable.xml @@ -1,10 +1,10 @@ - + hw_api_object->attreditable - Vérifie si un attribut est éditable + Checks whether an attribute is editable Description @@ -13,8 +13,6 @@ arrayparameter - hw_api_object->attreditable vérifie si un - attribut est éditable. diff --git a/reference/hwapi/functions/hwapi-object-count.xml b/reference/hwapi/functions/hwapi-object-count.xml index 86064a2941..cd54e0a8c8 100644 --- a/reference/hwapi/functions/hwapi-object-count.xml +++ b/reference/hwapi/functions/hwapi-object-count.xml @@ -1,10 +1,10 @@ - + hw_api_object->count - Retourne le nombre d'attributs + Returns number of attributes Description @@ -13,7 +13,6 @@ arrayparameter - hw_api_object->count retourne le nombre d'attributs. diff --git a/reference/hwapi/functions/hwapi-object-insert.xml b/reference/hwapi/functions/hwapi-object-insert.xml index f94ac156bb..4577cccbbb 100644 --- a/reference/hwapi/functions/hwapi-object-insert.xml +++ b/reference/hwapi/functions/hwapi-object-insert.xml @@ -1,26 +1,23 @@ - + hw_api_object->insert - Insère un nouvel attribut HyperWave + Inserts new attribute Description - boolhw_api_object->insert + boolinsert objectattribute - hw_api_object->insert ajoute l'attribut - attribute à l'objet courant. - hw_api_object->insert - retourne &true; en cas de succès, et sinon, &false;. + Adds an attribute to the object. Returns &true; on success and otherwise + &false;. - Voir aussi - hwapi_object_remove. + See also hwapi_object_remove. diff --git a/reference/hwapi/functions/hwapi-object-new.xml b/reference/hwapi/functions/hwapi-object-new.xml index d8a8a11814..18f71de466 100644 --- a/reference/hwapi/functions/hwapi-object-new.xml +++ b/reference/hwapi/functions/hwapi-object-new.xml @@ -1,10 +1,10 @@ - + hw_api_object - Crée une nouvelle instance de la classe hw_api_object + Creates a new instance of class hw_api_object Description @@ -13,12 +13,9 @@ arrayparameter - hw_api_object crée une nouvelle instance - de la classe hw_api_object. - Voir aussi - hwapi_lock. + See also hwapi_lock. diff --git a/reference/hwapi/functions/hwapi-object-remove.xml b/reference/hwapi/functions/hwapi-object-remove.xml index b008eb3346..8d3cd5f484 100644 --- a/reference/hwapi/functions/hwapi-object-remove.xml +++ b/reference/hwapi/functions/hwapi-object-remove.xml @@ -1,26 +1,23 @@ - + hw_api_object->remove - Supprime un attribut HyperWave + Removes attribute Description - boolhw_api_object->remove + boolremove stringname - hw_api_object->remove supprime l'attribut - de nom name dans l'objet courant. - hw_api_object->remove retourne &true; en - cas de succès, et &false; sinon. + Removes the attribute with the given name. Returns &true; on success + and otherwise &false;. - Voir aussi - hwapi_object_insert. + See also hwapi_object_insert. diff --git a/reference/hwapi/functions/hwapi-object-title.xml b/reference/hwapi/functions/hwapi-object-title.xml index 4354293788..21380ecbae 100644 --- a/reference/hwapi/functions/hwapi-object-title.xml +++ b/reference/hwapi/functions/hwapi-object-title.xml @@ -1,10 +1,10 @@ - + hw_api_object->title - Retourne le titre de l'attribut + Returns the title attribute Description diff --git a/reference/hwapi/functions/hwapi-object-value.xml b/reference/hwapi/functions/hwapi-object-value.xml index d10f834a9b..f9ca104592 100644 --- a/reference/hwapi/functions/hwapi-object-value.xml +++ b/reference/hwapi/functions/hwapi-object-value.xml @@ -1,10 +1,10 @@ - + hw_api_object->value - Retourne la valeur de l'attribut + Returns value of attribute Description @@ -13,8 +13,8 @@ stringname - hw_api_object->value retourne la valeur de l'attribut - name, ou bien &false; si une erreur est survenue. + Returns the value of the attribute with the given name or &false; if an + error occured. diff --git a/reference/hwapi/functions/hwapi-object.xml b/reference/hwapi/functions/hwapi-object.xml index b894841bd0..c7bb5236e7 100644 --- a/reference/hwapi/functions/hwapi-object.xml +++ b/reference/hwapi/functions/hwapi-object.xml @@ -1,10 +1,10 @@ - + hw_api->object - Lit les informations d'attribut + Retrieve attribute information Description @@ -13,22 +13,20 @@ arrayparameter - hw_api->object lit les informations d'attributs - d'un objet de n'importe quelle version. Elle ne retournera pas le - contenu du document. Le paramètre parameter - est un tableau qui contient l'élément obligatoire - 'objectIdentifier' et les éléments optionnels - 'attributeSelector' et 'version'. + This function retrieves the attribute information of an object of any + version. It will not return the document content. The parameter array + contains the required elements 'objectIdentifier' and the optional + elements 'attributeSelector' and 'version'. - L'objet retourné est une instance de la classe - HW_API_Object en cas de succès ou - HW_API_Error en cas d'erreur. + The returned object is an instance of class + HW_API_Object on success or + HW_API_Error if an error occured. - Cet exemple simple lit un objet et vérifie les erreurs. + This simple example retrieves an object and checks for errors. - Lit un objet Hyperwave et le vérifie + Retrieve an object "; switch($reason->type()) { case 0: - echo "Erreur"; + echo "Error"; break; case 1: - echo "Alerte"; + echo "Warning"; break; case 2: echo "Message"; break; } echo "
\n"; - echo "Description : ".$reason->description("en")."
\n"; + echo "Description: ".$reason->description("en")."
\n"; } function list_attr($obj) { @@ -75,8 +73,7 @@ list_attr($root); - Voir aussi - hwapi_content. + See also hwapi_content. diff --git a/reference/hwapi/functions/hwapi-objectbyanchor.xml b/reference/hwapi/functions/hwapi-objectbyanchor.xml index 14190b045e..9d7e72e7d0 100644 --- a/reference/hwapi/functions/hwapi-objectbyanchor.xml +++ b/reference/hwapi/functions/hwapi-objectbyanchor.xml @@ -1,10 +1,10 @@ - + hw_api->objectbyanchor - Retourne l'objet propriétaire d'une ancre + Returns the object an anchor belongs to Description @@ -13,16 +13,14 @@ arrayparameter - hw_api->objectbyanchor retourne l'objet qui contient - une ancre donnée. Le paramètre parameter est un - tableau qui contient l'élément obligatoire 'objectIdentifier' et - l'élément optionnel 'attributeSelector'. + This function retrieves an object the specified anchor belongs to. + The parameter array contains the required element 'objectIdentifier' and + the optional element 'attributeSelector'. - Voir aussi - hwapi_dstofsrcanchor, - hwapi_srcanchors et - hwapi_dstanchors. + See also hwapi_dstofsrcanchor, + hwapi_srcanchors, + hwapi_dstanchors. diff --git a/reference/hwapi/functions/hwapi-parents.xml b/reference/hwapi/functions/hwapi-parents.xml index f502ca6f11..add6c34cd2 100644 --- a/reference/hwapi/functions/hwapi-parents.xml +++ b/reference/hwapi/functions/hwapi-parents.xml @@ -1,10 +1,10 @@ - + hw_api->parents - Retourne le parent d'un objet + Returns parents of an object Description @@ -13,20 +13,18 @@ arrayparameter - hw_api->parents lit le parent d'un objet. - Le parent peut être filtrés en spécifiant un objet de requête. - Le paramètre parameter est un tableau qui - contient l'élément obligatoire 'objectidentifier' et les - éléments optionnels 'attributeselector' et 'objectquery'. + Retrieves the parents of an object. The parents can be further filtered by + specifying an object query. The parameter array + contains the required elements 'objectidentifier' and the + optional elements 'attributeselector' and 'objectquery'. - La valeur retournée est un tableau d'objets de type - HW_API_Object ou + The return value is an array of objects of type + HW_API_Object or HW_API_Error. - Voir aussi - hwapi_children. + See also hwapi_children. diff --git a/reference/hwapi/functions/hwapi-reason-description.xml b/reference/hwapi/functions/hwapi-reason-description.xml index 97e4781cc3..5eebb08daf 100644 --- a/reference/hwapi/functions/hwapi-reason-description.xml +++ b/reference/hwapi/functions/hwapi-reason-description.xml @@ -1,10 +1,10 @@ - + hw_api_reason->description - Retourne la description d'une raison + Returns description of reason Description @@ -13,8 +13,7 @@ void - hw_api_reason->description retourne la description - d'une raison. + Returns the description of a reason diff --git a/reference/hwapi/functions/hwapi-reason-type.xml b/reference/hwapi/functions/hwapi-reason-type.xml index 1dec6853fa..1e2ee97ee2 100644 --- a/reference/hwapi/functions/hwapi-reason-type.xml +++ b/reference/hwapi/functions/hwapi-reason-type.xml @@ -1,10 +1,10 @@ - + hw_api_reason->type - Retourne le type de raison + Returns type of reason Description @@ -13,7 +13,7 @@ void - hw_api_reason->type retourne le type de raison. + Returns the type of a reason. diff --git a/reference/hwapi/functions/hwapi-remove.xml b/reference/hwapi/functions/hwapi-remove.xml index d93b3a89eb..64c8dc1fc7 100644 --- a/reference/hwapi/functions/hwapi-remove.xml +++ b/reference/hwapi/functions/hwapi-remove.xml @@ -1,10 +1,10 @@ - + hw_api->remove - Efface un objet + Delete an object Description @@ -13,24 +13,22 @@ arrayparameter - hw_api->remove efface un objet avec un parent - spécifique. Les collections seront effacées récursivement. Vous pouvez - passez un objet optionnel de requête pour filtrer les objets qui - seront filtrés. Un objet sera effacé physiquement si c'est sa dernière - instance. Le paramètre parameter est un tableau - qui contient les éléments obligatoires 'objectidentifier' et 'parentidentifier'. - Si vous souhaitez effacer un utilisateur ou un gropue, 'parentidentifier' - peut être omis. L'élément optionnel 'mode' détermine comme l'effacement - est réalisé. En mode normal, l'objet sera effacé phyisiquement lorsque - toutes ses instances seront supprimées. En mode physique, toutes les - instances d'un objet seront supprimées immédiatement. En mode - removelinks toutes les références vers et depuis l'objet seront aussi - effacées. En mode nonrecursive, l'effacement n'est pas récusrsif. - Effacer une collection qui n'est pas vide causera une erreur. + Removes an object from the specified parent. Collections + will be removed recursively. You can pass an optional object query to + remove only those objects which match the query. An object will be + deleted physically if it is the last instance. The parameter array + contains the required elements 'objectidentifier' and 'parentidentifier'. + If you want to remove a user or group 'parentidentifier' can be skiped. + The optional parameter 'mode' determines how the deletion is performed. + In normal mode the object will not be removed physically until all + instances are removed. In physical mode all instances of the object will + be deleted imediately. In removelinks mode all references + to and from the objects will be deleted as well. In nonrecursive the + deletion is not performed recursive. Removing a collection which is not + empty will cause an error. - Voir aussi - hwapi_move. + See also hwapi_move. diff --git a/reference/hwapi/functions/hwapi-replace.xml b/reference/hwapi/functions/hwapi-replace.xml index 534875655f..a981e26619 100644 --- a/reference/hwapi/functions/hwapi-replace.xml +++ b/reference/hwapi/functions/hwapi-replace.xml @@ -1,10 +1,10 @@ - + hw_api->replace - Remplace un objet + Replaces an object Description @@ -13,24 +13,21 @@ arrayparameter - hw_api->replace remplace les attributs et le - contenu d'un bjet. Le paramètre parameter - est un tableau qui contient les éléments obligatoires - 'objectIdentifier' et 'object' et les paramètres optionnels - 'content', 'parameters', 'mode' et 'attributeSelector'. 'objectIdentifier' - contient l'objet qui doit être remplacé. 'object' contient le nouvel - objet. 'content' contient le nouveau contenu. 'parameters' contient des - informations supplémentaires pour les documents HTML. - HTML_Language est l'abbrévation de la langue pour le titre. - HTML_Base est l'attribut de base pour le contenu du document HTML. 'mode' - peut être la combinaison de l'une des constantes suivantes : + Replaces the attributes and the content of an object The parameter array + contains the required elements 'objectIdentifier' and 'object' and + the optional parameters 'content', 'parameters', 'mode' and + 'attributeSelector'. 'objectIdentifier' contains the object to be + replaced. 'object' contains the new object. 'content' contains the new + content. 'parameters' contain extra information for HTML documents. + HTML_Language is the letter abbreviation of the language of the title. + HTML_Base sets the base attribute of the HTML document. 'mode' can be a + combination of the following flags: HW_API_REPLACE_NORMAL - L'objet sur le serveur est remplacé par l'objet - passé. + The object on the server is replace with the object passed. @@ -79,8 +76,7 @@ - Voir aussi - hwapi_insert. + See also hwapi_insert. diff --git a/reference/hwapi/functions/hwapi-setcommitedversion.xml b/reference/hwapi/functions/hwapi-setcommitedversion.xml index fb0d66422c..52914326fb 100644 --- a/reference/hwapi/functions/hwapi-setcommitedversion.xml +++ b/reference/hwapi/functions/hwapi-setcommitedversion.xml @@ -1,10 +1,10 @@ - + hw_api->setcommitedversion - Valide une version autre que la dernière + Commits version other than last version Description @@ -13,15 +13,14 @@ arrayparameter - hw_api->setcommitedversion valide une version du document. - La version validée est celle qui est visible aux utilisateurs ayant un - accès en lecture. Par défaut, la dernière version est celle qui est validée. + Commits a version of a docuemnt. The commited version is the one which is + visible to users with read access. By default the last version is the + commited version. - Voir aussi - hwapi_checkin, - hwapi_checkout et - hwapi_revert. + See also hwapi_checkin, + hwapi_checkout, + hwapi_revert. diff --git a/reference/hwapi/functions/hwapi-srcanchors.xml b/reference/hwapi/functions/hwapi-srcanchors.xml index e2d1b79b14..4b1904e093 100644 --- a/reference/hwapi/functions/hwapi-srcanchors.xml +++ b/reference/hwapi/functions/hwapi-srcanchors.xml @@ -1,10 +1,10 @@ - + hw_api->srcanchors - Retourne la liste de toutes les ancres + Returns a list of all source anchors Description @@ -13,14 +13,12 @@ arrayparameter - hw_api->srcanchors lit toutes les ancres sources d'un objet. - Le paramètre parameter est un tableau qui contient l'élément - obligatoire 'objectIdentifier' et les éléments optionels - 'attributeSelector' wr 'objectQuery'. + Retrieves all source anchors of an object. The parameter array contains + the required element 'objectIdentifier' and the optional elements + 'attributeSelector' and 'objectQuery'. - Voir aussi - hwapi_dstanchors. + See also hwapi_dstanchors. diff --git a/reference/hwapi/functions/hwapi-srcsofdst.xml b/reference/hwapi/functions/hwapi-srcsofdst.xml index b51ed8fea9..fe53c6675e 100644 --- a/reference/hwapi/functions/hwapi-srcsofdst.xml +++ b/reference/hwapi/functions/hwapi-srcsofdst.xml @@ -1,10 +1,10 @@ - + hw_api->srcsofdst - Retourne les sources d'un objet de destination + Returns source of a destination object Description @@ -13,16 +13,14 @@ arrayparameter - hw_api->srcsofdst retourne les sources d'un objet - de destination. L'objet de destination peut être une ancre ou un document - complet. Le paramètre parameter est un tableau - qui contient l'élément obligatoire 'objectIdentifier' et les éléments optionnels - 'attributeSelector' et 'objectQuery'. La fonction retourne un tableau - d'objet ou une erreur. + Retrieves all the source anchors pointing to the specified destination. + The destination object can either be a destination anchor or a whole + document. The parameters array contains the required element + 'objectIdentifier' and the optional element 'attributeSelector' and + 'objectQuery'. The function returns an array of objects or an error. - Voir aussi - hwapi_dstofsrcanchor. + See also hwapi_dstofsrcanchor. diff --git a/reference/hwapi/functions/hwapi-unlock.xml b/reference/hwapi/functions/hwapi-unlock.xml index 4c99b26165..4a0c13ae17 100644 --- a/reference/hwapi/functions/hwapi-unlock.xml +++ b/reference/hwapi/functions/hwapi-unlock.xml @@ -1,34 +1,29 @@ - + hw_api->unlock - Déverrouille un objet HyperWave verrouillé + Unlocks a locked object Description - objecthw_api->unlock + objectunlock arrayparameter - hw_api->unlock déverrouille un objet verrouillé. - Seul, l'utilisateur qui a verrouillé un objet et l'administrateur - système, peuvent le déverrouiller. Le paramètre parameter - est un tableau qui contient les éléments obligatoires de - objectIdentifier et les paramètres optionnels - de mode et objectquery. La - signification de mode est la même que dans la - fonction hwapi_lock. + Unlocks a locked object. Only the user who has locked the object and the + system user may unlock an object. The parameter array contains the + required element 'objectIdentifier' and the optional parameters + 'mode' and 'objectquery'. The meaning of 'mode' is the same as in + function hwapi_lock. - hw_api->unlock retourne &true; en cas de - succès, et sinon, un objet d'erreur HW_API_Error. + Returns &true; on success or an object of class HW_API_Error. - Voir aussi - hwapi_lock. + See also hwapi_lock. diff --git a/reference/hwapi/functions/hwapi-user.xml b/reference/hwapi/functions/hwapi-user.xml index 4bff1fda4a..eca2438d7d 100644 --- a/reference/hwapi/functions/hwapi-user.xml +++ b/reference/hwapi/functions/hwapi-user.xml @@ -1,10 +1,10 @@ - + hw_api->user - Retourne le propriétaire d'un objet + Returns the own user object Description @@ -13,11 +13,9 @@ arrayparameter - hw_api->user retourne le propriétaire d'un objet. - Voir aussi - hwapi_userlist. + See also hwapi_userlist. diff --git a/reference/hwapi/functions/hwapi-userlist.xml b/reference/hwapi/functions/hwapi-userlist.xml index fdf4288fd3..b6d516bcc7 100644 --- a/reference/hwapi/functions/hwapi-userlist.xml +++ b/reference/hwapi/functions/hwapi-userlist.xml @@ -1,10 +1,10 @@ - + hw_api->userlist - Retourne la liste des utilisateurs connectés + Returns a list of all logged in users Description @@ -13,12 +13,9 @@ arrayparameter - hw_api->userlist retourne la liste des - utilisateurs connectés. - Voir aussi - hwapi_user. + See also hwapi_user. diff --git a/reference/hwapi/ini.xml b/reference/hwapi/ini.xml index a7bdf0c0d5..1d2febef83 100644 --- a/reference/hwapi/ini.xml +++ b/reference/hwapi/ini.xml @@ -1,17 +1,20 @@ - +
&reftitle.runtime; &extension.runtime; - - &ini.table.title; + Hyperwave API configuration options - &ini.table.top; + + Name + Default + Changeable + - + hwapi.allow_persistent "0" @@ -20,7 +23,8 @@
- &ini.table.bottom + For further details and definition of the PHP_INI_* constants see + ini_set.
diff --git a/reference/hwapi/reference.xml b/reference/hwapi/reference.xml index 8be8bf2c31..98af47a811 100644 --- a/reference/hwapi/reference.xml +++ b/reference/hwapi/reference.xml @@ -1,7 +1,7 @@ - + - Hyperwave API + Hyperwave API functions Hyperwave API @@ -9,50 +9,50 @@
&reftitle.intro; - Hyperwave a été développé à - l'IICM à Graz. Le projet a commencé - avec le nom de Hyper-G, puis il est devenu - Hyperwave, lors de sa commercialisation en 1996. + Hyperwave has been developed at + IICM in Graz. It started with + the name Hyper-G and changed to Hyperwave when + it was commercialised (in 1996). - Hyperwave n'est pas un logiciel libre. Sa version courante, la 5.5, - est disponible à &url.hyperwave;. - Une version limitée dans le temps est commandable gratuitement (30 jours). + Hyperwave is not free software. The current version, 5.5, is + available at &url.hyperwave;. + A time limited version can be ordered for free (30 days). - Voir aussi le module Hyperwave. + See also the Hyperwave module. - Hyperwave est un système d'information comparable à une base de données - (HIS, Hyperwave Information Server). Il se - concentre sur le stockage et la gestion de documents. Un document - peut être n'importe quelle pièce de données qui soit stockable dans - un fichier. Chaque document est accompagné de son propre enregistrement. - L'enregistrement contient les méta-données du document. Les métas données - sont des listes d'attributs qui peuvent être manipulés par l'utilisateur. - Certains attributs sont gérés par le serveur Hyperwave, les autres - peuvent être modifiés par l'utilisateur. + Hyperwave is an information system similar to a database + (HIS, Hyperwave Information Server). Its focus + is the storage and management of documents. A document can be any + possible piece of data that may as well be stored in file. Each + document is accompanied by its object record. The object record + contains meta data for the document. The meta data is a list of + attributes which can be extended by the user. Certain attributes + are always set by the Hyperwave server, other may be modified by + the user.
&reftitle.required; - Depuis 2001, il y a un SDK Hyperwave disponible. Il supporte Java, - JavaScript et C++. Cette extension PHP est basée sur l'interface C++. - Pour activer le support hwapi de PHP, vous devez installer le - SDK d'abord. + Since 2001 there is a Hyperwave SDK available. It supports Java, + JavaScript and C++. This PHP Extension is based on the C++ interface. + In order to activate the hwapi support in PHP you will have to install + the Hyperwave SDK first.
-&reference.hwapi.configure; + &reference.hwapi.configure;
- intégration dans Apache + Integration with Apache - L'intégration dans Apache et éventuellement d'autres serveurs est - déjà décrite dans le module Hyperwave, - qui a été la première extension à se connecter au serveur Hyperwave. + The integration with Apache and possible other servers is already + described in the Hyperwave module + which has been the first extension to connect a Hyperwave Server.
@@ -71,9 +71,9 @@
Classes - L'API fournie avec l'extension HW_API est complétement orientée objet. - Elle est très similaire à l'interface C++ du SDK Hyperwave. - Elle est constituée des classes suivantes : + 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. @@ -106,66 +106,67 @@ - Certains classes basiques comme HW_API_String, - HW_API_String_Array, etc., qui existent dans le SDK - Hyperwave SDK n'ont pas été implémentées, car PHP a de puissants ersatz pour elles. + Some basic classes like HW_API_String, + HW_API_String_Array, etc., which exist in the + Hyperwave SDK have not been implemented since PHP has powerful + replacements for them. - Chaque classe dispose de certaines méthodes, dont les noms sont identiques à - leur alter ego du SDK Hyperwave SDK. Le passage des arguments à ces fonctions - diffère de toutes les autres extensions PHP, mais est proche de l'API C++ - du SDK Hyperwave. Au lieu de passer plusieurs paramètres, ils sont tous - placés dans un tableau associatif, et transmis sous la forme d'un seul - paramètre. Les paramètres les plus communs sont listés ci-dessous. Si d'autres - paramètres sont nécessaires, ils seront documentés à chaque cas. + 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 serval parameters they are all put into + an associated array and passed as one paramter. 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 Le nom ou l'identifiant de l'objet, + objectIdentifier The name or id of an object, e.g. "rootcollection", "0x873A8768 0x00000002". - parentIdentifier Le nom ou l'identifiant de l'objet - qui est considéré comme parent. + parentIdentifier The name or id of an object + which is considered to be a parent. - object Une instance de la classe HW_API_Object. + object An instance of class HW_API_Object. - parameters Une instance de la classe HW_API_Object. + parameters An instance of class HW_API_Object. - version La version de l'objet. + version The version of an object. - mode Un entier qui détermine la méthode - d'exécution de l'opération. + mode An integer value determine the way an + operation is executed. - attributeSelector Un tableau de chaînes de - caractères, chacun contenant le nom d'un attribut. C'est le cas si - vous lisez des enregistrements d'objets, et que vous voulez inclure - certains attributs. + 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 Une requête pour sélectionner - certains objets dans une liste. Elle est utilisée pour réduire - le nombre d'objets qui a été livré par une fonction comme - hw_api->children ou hw_api->find. + 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.