From 12dfe282afb9772787764cc28f442e546eef1bce Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Sat, 16 Jun 2007 23:29:46 +0000 Subject: [PATCH] ref.hwapi: new doc style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@237857 c90b9560-bf6c-de11-be94-00142212c4b1 --- .../hwapi/functions/hwapi-attribute-key.xml | 35 +++- .../hwapi-attribute-langdepvalue.xml | 50 +++++- .../hwapi/functions/hwapi-attribute-value.xml | 43 +++-- .../functions/hwapi-attribute-values.xml | 41 +++-- reference/hwapi/functions/hwapi-attribute.xml | 40 ++++- reference/hwapi/functions/hwapi-checkin.xml | 50 +++++- reference/hwapi/functions/hwapi-checkout.xml | 84 ++++++--- reference/hwapi/functions/hwapi-children.xml | 52 ++++-- .../functions/hwapi-content-mimetype.xml | 27 ++- .../hwapi/functions/hwapi-content-read.xml | 52 +++++- reference/hwapi/functions/hwapi-content.xml | 70 +++++--- reference/hwapi/functions/hwapi-copy.xml | 62 +++++-- reference/hwapi/functions/hwapi-dbstat.xml | 59 +++++-- reference/hwapi/functions/hwapi-dcstat.xml | 59 +++++-- .../hwapi/functions/hwapi-dstanchors.xml | 61 +++++-- .../hwapi/functions/hwapi-dstofsrcanchor.xml | 63 +++++-- .../hwapi/functions/hwapi-error-count.xml | 35 +++- .../hwapi/functions/hwapi-error-reason.xml | 35 +++- reference/hwapi/functions/hwapi-find.xml | 53 ++++-- reference/hwapi/functions/hwapi-ftstat.xml | 59 +++++-- reference/hwapi/functions/hwapi-hgcsp.xml | 44 ++++- reference/hwapi/functions/hwapi-hwstat.xml | 59 +++++-- reference/hwapi/functions/hwapi-identify.xml | 53 ++++-- reference/hwapi/functions/hwapi-info.xml | 61 +++++-- reference/hwapi/functions/hwapi-insert.xml | 142 +++++++++------ .../hwapi/functions/hwapi-insertanchor.xml | 77 ++++++--- .../functions/hwapi-insertcollection.xml | 68 ++++++-- .../hwapi/functions/hwapi-insertdocument.xml | 69 ++++++-- reference/hwapi/functions/hwapi-link.xml | 54 ++++-- reference/hwapi/functions/hwapi-lock.xml | 77 ++++++--- reference/hwapi/functions/hwapi-move.xml | 55 ++++-- .../hwapi/functions/hwapi-new-content.xml | 42 ++++- .../hwapi/functions/hwapi-object-assign.xml | 42 ++++- .../functions/hwapi-object-attreditable.xml | 43 ++++- .../hwapi/functions/hwapi-object-count.xml | 43 ++++- .../hwapi/functions/hwapi-object-insert.xml | 57 ++++-- .../hwapi/functions/hwapi-object-new.xml | 42 ++++- .../hwapi/functions/hwapi-object-remove.xml | 58 +++++-- .../hwapi/functions/hwapi-object-title.xml | 43 ++++- .../hwapi/functions/hwapi-object-value.xml | 43 ++++- reference/hwapi/functions/hwapi-object.xml | 57 ++++-- .../hwapi/functions/hwapi-objectbyanchor.xml | 61 +++++-- reference/hwapi/functions/hwapi-parents.xml | 53 ++++-- .../functions/hwapi-reason-description.xml | 27 ++- .../hwapi/functions/hwapi-reason-type.xml | 27 ++- reference/hwapi/functions/hwapi-remove.xml | 84 ++++++--- reference/hwapi/functions/hwapi-replace.xml | 162 +++++++++++------- .../functions/hwapi-setcommittedversion.xml | 53 ++++-- .../hwapi/functions/hwapi-srcanchors.xml | 60 +++++-- reference/hwapi/functions/hwapi-srcsofdst.xml | 61 +++++-- reference/hwapi/functions/hwapi-unlock.xml | 55 ++++-- reference/hwapi/functions/hwapi-user.xml | 53 +++++- reference/hwapi/functions/hwapi-userlist.xml | 53 +++++- 53 files changed, 2267 insertions(+), 741 deletions(-) diff --git a/reference/hwapi/functions/hwapi-attribute-key.xml b/reference/hwapi/functions/hwapi-attribute-key.xml index 6b93a84f93..886f90132e 100644 --- a/reference/hwapi/functions/hwapi-attribute-key.xml +++ b/reference/hwapi/functions/hwapi-attribute-key.xml @@ -1,24 +1,41 @@ - - + hw_api_attribute->key Returns key of the attribute - - Description - - stringhw_api_attribute->key - - + + + &reftitle.description; + + hw_api_attribute + + stringkey + + + Returns the name of the attribute. + + + + &reftitle.returnvalues; - See also hwapi_attribute_value. + Returns the name of the attribute as a string. + + + &reftitle.seealso; + + + + + + + - + hw_api_attribute->langdepvalue Returns value for a given language - - Description - - stringhw_api_attribute->langdepvalue - stringlanguage - + + + &reftitle.description; + + hw_api_attribute + + stringlangdepvalue + stringlanguage + + Returns the value in the given language of the attribute. + + + + &reftitle.parameters; - See also hwapi_attribute_value. + + + language + + + + + + + + + &reftitle.returnvalues; + + Returns the value of the attribute as a string. + + + + + &reftitle.seealso; + + + + + + + - + hw_api_attribute->value Returns value of the attribute - - Description - - stringhw_api_attribute->value - - + + + &reftitle.description; + + hw_api_attribute + + stringvalue + + + - Returns the value of the attribute. - - - See also hwapi_attribute_key, - hwapi_attribute_values. + Gets the value of the attribute. + + + &reftitle.returnvalues; + + Returns the value, as a string. + + + + + &reftitle.seealso; + + + + + + + + - + hw_api_attribute->values Returns all values of the attribute - - Description - - arrayhw_api_attribute->values - - + + + &reftitle.description; + + hw_api_attribute + + arrayvalues + + + - Returns all values of the attribute as an array of strings. - - - See also hwapi_attribute_value. + Gets all values of the attribute. + + + &reftitle.returnvalues; + + Returns an array of attribute values. + + + + + &reftitle.seealso; + + + + + + + - + hw_api_attribute Creates instance of class hw_api_attribute - - Description + + + &reftitle.description; HW_API_Attributehw_api_attribute stringname @@ -17,6 +17,38 @@ Creates a new instance of hw_api_attribute with the given name and value. + + + &reftitle.parameters; + + + + name + + + The attribute name. + + + + + value + + + The attribute value. + + + + + + + + + &reftitle.returnvalues; + + Returns an instance of hw_api_attribute. + + + - + hw_api->checkin Checks in an object - - Description - - boolhw_api->checkin - arrayparameter - + + + &reftitle.description; + + hw_api + + boolcheckin + arrayparameter + + This function checks in an object or a whole hierarchy of objects. The parameters array contains the required element @@ -75,10 +78,39 @@ + + + + &reftitle.parameters; - See also hwapi_checkout. + + + parameter + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.seealso; + + + + + + + - + hw_api->checkout Checks out an object - - Description - - boolhw_api->checkout - arrayparameter - + + + &reftitle.description; + + hw_api + + boolcheckout + arrayparameter + + This function checks out an object or a whole hierarchy 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: + + + + + &reftitle.parameters; + - HW_API_CHECKIN_NORMAL + parameter - - Checks out an object. The object must be a document. - - - - - HW_API_CHECKIN_RECURSIVE - - - 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. - + + 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 + + + Checks out an object. The object must be a document. + + + + + HW_API_CHECKIN_RECURSIVE + + + 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. + + + + + + + + + &reftitle.returnvalues; - See also hwapi_checkin. + &return.success; + + + &reftitle.seealso; + + + + + + + - + hw_api->children Returns children of an object - - Description - - arrayhw_api->children - arrayparameter - + + + &reftitle.description; + + hw_api + + arraychildren + arrayparameter + + 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'. + + + + &reftitle.parameters; + + + + parameter + + + The parameter array contains the required elements 'objectIdentifier' + and the optional elements 'attributeSelector' and 'objectQuery'. + + + + + + + + + &reftitle.returnvalues; The return value is an array of objects of type HW_API_Object or HW_API_Error. + + + + &reftitle.seealso; - See also hwapi_parents. + + + + - + hw_api_content->mimetype Returns mimetype - - Description - - stringhw_api_content->mimetype - - + + + &reftitle.description; + + hw_api_content + + stringmimetype + + + Returns the mimetype of the content. + + + &reftitle.returnvalues; + + Returns the mimetype as a string. + + + - + hw_api_content->read Read content - - Description - - stringhw_api_content->read - stringbuffer - intlen - + + + &reftitle.description; + + hw_api_content + + stringread + stringbuffer + intlen + + Reads len bytes from the content into the given buffer. + + + &reftitle.parameters; + + + + buffer + + + + + + + len + + + Number of bytes to read. + + + + + + + + + &reftitle.returnvalues; + + + + + - + hw_api->content Returns content of an object - - Description - - HW_API_Contenthw_api->content - arrayparameter - + + + &reftitle.description; + + hw_api + + HW_API_Contentcontent + arrayparameter + + 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 or - HW_API_CONTENT_PLAIN. - 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. + hw_api_content. + + + &reftitle.parameters; + + + + parameter + + + 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 or + HW_API_CONTENT_PLAIN. + + + HW_API_CONTENT_ALLLINKS means to insert all + anchors even if the destination is not reachable. + + + HW_API_CONTENT_REACHABLELINKS tells this method + to insert only reachable links and + HW_API_CONTENT_PLAIN will lead to document + without any links. + + + + + + + + + &reftitle.returnvalues; + + Returns an instance of hw_api_content. + + + - + hw_api->copy Copies physically - - Description - - hw_api_objecthw_api->copy - arrayparameter - + + + &reftitle.description; + + hw_api + + hw_api_contentcopy + arrayparameter + + 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'` - - - See also hwapi_move, - hwapi_link. + + + &reftitle.parameters; + + + + parameter + + + The parameter array contains the required elements 'objectIdentifier' + and 'destinationParentIdentifier'. The optional parameter is + 'attributeSelector'` + + + + + + + + + &reftitle.returnvalues; + + Returns the copied object. + + + + + &reftitle.seealso; + + + + + + + + - + hw_api->dbstat Returns statistics about database server - - Description - - hw_api_objecthw_api->dbstat - arrayparameter - + + + &reftitle.description; + + hw_api + + hw_api_objectdbstat + arrayparameter + + - - - See also hwapi_dcstat, - hwapi_hwstat, - hwapi_ftstat. + Returns statistics about database server. + + + &reftitle.parameters; + + + + parameter + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.seealso; + + + + + + + + + - + hw_api->dcstat Returns statistics about document cache server - - Description - - hw_api_objecthw_api->dcstat - arrayparameter - + + + &reftitle.description; + + hw_api + + hw_api_objectdcstat + arrayparameter + + - - - See also hwapi_hwstat, - hwapi_dbstat, - hwapi_ftstat. + Returns statistics about document cache server. + + + &reftitle.parameters; + + + + parameter + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.seealso; + + + + + + + + + - + hw_api->dstanchors Returns a list of all destination anchors - - Description - - arrayhw_api->dstanchors - arrayparameter - + + + &reftitle.description; + + hw_api + + arraydstanchors + arrayparameter + + - Retrieves all destination anchors of an object. The parameter array - contains - the required element 'objectIdentifier' and the optional elements - 'attributeSelector' and 'objectQuery'. - - - See also hwapi_srcanchors. + Retrieves all destination anchors of an object. + + + &reftitle.parameters; + + + + parameter + + + The parameter array contains the required element 'objectIdentifier' + and the optional elements 'attributeSelector' and 'objectQuery'. + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.seealso; + + + + + + + - + hw_api->dstofsrcanchor Returns destination of a source anchor - - Description - - hw_api_objecthw_api->dstofsrcanchor - arrayparameter - + + + &reftitle.description; + + hw_api + + hw_api_objectdstofsrcanchor + arrayparameter + + 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'. - - - See also hwapi_srcanchors, - hwapi_dstanchors, - hwapi_objectbyanchor. + document. + + + &reftitle.parameters; + + + + parameter + + + The parameters array contains the required element 'objectIdentifier' + and the optional element 'attributeSelector'. + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.seealso; + + + + + + + + + - + hw_api_error->count Returns number of reasons - - Description - - inthw_api_error->count - - + + + &reftitle.description; + + hw_api_error + + intcount + + + Returns the number of error reasons. + + + + &reftitle.returnvalues; - See also hwapi_error_reason. + Returns the number of errors, as an integer. + + + &reftitle.seealso; + + + + + + + - + hw_api_error->reason Returns reason of error - - Description - - HW_API_Reasonhw_api_error->reason - - + + + &reftitle.description; + + hw_api_error + + HW_API_Reasonreason + + + Returns the first error reason. + + + + &reftitle.returnvalues; - See also hwapi_error_count. + + + + &reftitle.seealso; + + + + + + + - + hw_api->find Search for objects - - Description - - arrayhw_api->find - arrayparameter - + + + &reftitle.description; + + hw_api + + arrayfind + arrayparameter + + 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 @@ -19,13 +22,37 @@ 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', 'languages' and 'attributeselector'. In case of - an incremental search the optional parameters 'startIndex', - numberOfObjectsToGet' and 'exactMatchUnit' can be passed. + index. + + + &reftitle.parameters; + + + + parameter + + + The parameter array contains the 'keyquery' or/and 'fulltextquery' + depending on who you would like to search. Optional parameters are + 'objectquery', 'scope', 'languages' and 'attributeselector'. In case + of an incremental search the optional parameters 'startIndex', + 'numberOfObjectsToGet' and 'exactMatchUnit' can be passed. + + + + + + + + + &reftitle.returnvalues; + + + + + - + hw_api->ftstat Returns statistics about fulltext server - - Description - - hw_api_objecthw_api->ftstat - arrayparameter - + + + &reftitle.description; + + hw_api + + hw_api_objectftstat + arrayparameter + + - - - See also hwapi_dcstat, - hwapi_dbstat, - hwapi_hwstat. + Returns statistics about fulltext server. + + + &reftitle.parameters; + + + + parameter + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.seealso; + + + + + + + + + - + hwapi_hgcsp Returns object of class hw_api - - Description + + + &reftitle.description; HW_APIhwapi_hgcsp stringhostname @@ -16,12 +16,40 @@ 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. - - - See also hwapi_hwtp. + + + &reftitle.parameters; + + + + hostname + + + The host name. + + + + + port + + + If you do not pass a port number, 418 is used. + + + + + + + + + &reftitle.returnvalues; + + Returns an instance of HW_API. + + + - + hw_api->hwstat Returns statistics about Hyperwave server - - Description - - hw_api_objecthw_api->hwstat - arrayparameter - + + + &reftitle.description; + + hw_api + + hw_api_objecthwstat + arrayparameter + + - - - See also hwapi_dcstat, - hwapi_dbstat, - hwapi_ftstat. + Returns statistics about Hyperwave server. + + + &reftitle.parameters; + + + + parameter + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.seealso; + + + + + + + + + - + hw_api->identify Log into Hyperwave Server - - Description - - boolhw_api->identify - arrayparameter - + + + &reftitle.description; + + hw_api + + boolidentify + arrayparameter + + - Logs into the Hyperwave Server. The parameter array must contain the - elements 'username' and 'password'. - - - The return value will be an object of type - HW_API_Error if identification failed or TRUE - if it was successful. + Logs into the Hyperwave Server. + + + &reftitle.parameters; + + + + parameter + + + The parameter array must contain the elements 'username' and + 'password'. + + + + + + + + + &reftitle.returnvalues; + + Returns an object of typeHW_API_Error if + identification failed or &true; if it was successful. + + + - + hw_api->info Returns information about server configuration - - Description - - arrayhw_api->info - arrayparameter - + + + &reftitle.description; + + hw_api + + arrayinfo + arrayparameter + + - - - See also hwapi_dcstat, - hwapi_dbstat, - hwapi_ftstat, - hwapi_hwstat. + Returns information about server configuration. + + + &reftitle.parameters; + + + + parameter + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.seealso; + + + + + + + + + + - + hw_api->insert Inserts a new object - - Description - - hw_api_objecthw_api->insert - arrayparameter - + + + &reftitle.description; + + hw_api + + hw_api_objectinsert + arrayparameter + + 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 further - attributes like the destination (attribute key is 'Parent'). 'content' is - the content of the document. 'mode' can be a - combination of the following flags: + + + + + &reftitle.parameters; + - HW_API_INSERT_NORMAL + parameter - - The object in inserted into the server. - - - - - HW_API_INSERT_FORCE_VERSION_CONTROL - - - - - - - HW_API_INSERT_AUTOMATIC_CHECKOUT - - - - - - - HW_API_INSERT_PLAIN - - - - - - - HW_API_INSERT_KEEP_TIME_MODIFIED - - - - - - - HW_API_INSERT_DELAY_INDEXING - - - + + 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 further + 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 + + + The object in inserted into the server. + + + + + HW_API_INSERT_FORCE_VERSION_CONTROL + + + + + + + HW_API_INSERT_AUTOMATIC_CHECKOUT + + + + + + + HW_API_INSERT_PLAIN + + + + + + + HW_API_INSERT_KEEP_TIME_MODIFIED + + + + + + + HW_API_INSERT_DELAY_INDEXING + + + + + + + + + + + &reftitle.returnvalues; - See also hwapi_replace. + + + + &reftitle.seealso; + + + + + + + - + hw_api->insertanchor Inserts a new object of type anchor - - Description - - hw_api_objecthw_api->insertanchor - arrayparameter - + + + &reftitle.description; + + hw_api + + hw_api_objectinsertanchor + arrayparameter + + 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. - - - See also hwapi_insertdocument, - hwapi_insertcollection, - hwapi_insert. + required for an anchor. + + + &reftitle.parameters; + + + + parameter + + + 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. + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.seealso; + + + + + + + + + - + hw_api->insertcollection Inserts a new object of type collection - - Description - - hw_api_objecthw_api->insertcollection - arrayparameter - + + + &reftitle.description; + + hw_api + + hw_api_objectinsertcollection + arrayparameter + + 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. - - - See also hwapi_insertdocument, - hwapi_insertanchor and - hwapi_insert. + required for a collection. + + + &reftitle.parameters; + + + + parameter + + + 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. + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.seealso; + + + + + + + + + - + hw_api->insertdocument Inserts a new object of type document - - Description - - hw_api_objecthw_api->insertdocument - arrayparameter - + + + &reftitle.description; + + hw_api + + hw_api_objectinsertdocument + arrayparameter + + 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. - - - See also hwapi_insert, - hwapi_insertanchor and - hwapi_insertcollection. + for a document. + + + &reftitle.parameters; + + + + parameter + + + 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. + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.seealso; + + + + + + + + + - + hw_api->link Creates a link to an object - - Description - - boolhw_api->link - arrayparameter - + + + &reftitle.description; + + hw_api + + boollink + arrayparameter + + 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. + object to links points to. + + + + &reftitle.parameters; + + + + parameter + + + The parameter array contains the required elements 'objectIdentifier' + and 'destinationParentIdentifier'. 'destinationParentIdentifier' is + the target collection. + + + + + + + + + &reftitle.returnvalues; The function returns &true; on success or an error object. + + + + &reftitle.seealso; - See also hwapi_copy. + + + + - + hw_api->lock Locks an object - - Description - - boolhw_api->lock - arrayparameter - + + + &reftitle.description; + + hw_api + + boollock + arrayparameter + + Locks an object for exclusive editing by the user calling this function. - The object can be only unlocked by this user or the system 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 the collection and possible subcollections. - HW_API_LOCK_SESSION means, an - object is locked only as long as the session is valid. - - - See also hwapi_unlock. + The object can be only unlocked by this user or the system user. + + + &reftitle.parameters; + + + + parameter + + + 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 the collection + and possible subcollections. HW_API_LOCK_SESSION + means, an object is locked only as long as the session is valid. + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.seealso; + + + + + + + + - + hw_api->move Moves object between collections - - Description - - boolhw_api->move - arrayparameter - + + + &reftitle.description; + + hw_api + + boolmove + arrayparameter + + - - - See also hw_objrec2array. + Moves object between collections. + + + &reftitle.parameters; + + + + parameter + + + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.seealso; + + + hw_objrec2array + + + + - + hw_api_content Create new instance of class hw_api_content - - Description + + + &reftitle.description; HW_API_Contenthw_api_content stringcontent @@ -15,10 +15,40 @@ Creates a new content object from the string - content. The mimetype is set to - mimetype. + content. + + + &reftitle.parameters; + + + + content + + + + + + + mimetype + + + The mimetype for the contents. + + + + + + + + + &reftitle.returnvalues; + + + + + - + hw_api_object->assign Clones object - - Description - - boolhw_api_object->assign - arrayparameter - + + + &reftitle.description; + + hw_api_object + + boolassign + arrayparameter + + Clones the attributes of an object. + + + &reftitle.parameters; + + + + parameter + + + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + - + hw_api_object->attreditable Checks whether an attribute is editable - - Description - - boolhw_api_object->attreditable - arrayparameter - + + + &reftitle.description; + + hw_api_object + + boolattreditable + arrayparameter + + + Checks whether an attribute is editable. + + + &reftitle.parameters; + + + + parameter + + + + + + + + + + + &reftitle.returnvalues; + + Returns &true; if the attribute is editable, &false; otherwise. + + + - + hw_api_object->count Returns number of attributes - - Description - - inthw_api_object->count - arrayparameter - + + + &reftitle.description; + + hw_api_object + + intcount + arrayparameter + + + Returns the number of attributes. + + + &reftitle.parameters; + + + + parameter + + + + + + + + + + + &reftitle.returnvalues; + + Returns the number as an integer. + + + - + hw_api_object->insert Inserts new attribute - - Description - - boolhw_api_object->insert - HW_API_Attributeattribute - + + + &reftitle.description; + + hw_api_object + + boolinsert + HW_API_Attributeattribute + + - Adds an attribute to the object. Returns &true; on success and otherwise - &false;. - - - See also hwapi_object_remove. + Adds an attribute to the object. + + + &reftitle.parameters; + + + + attribute + + + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.seealso; + + + + + + + - + hw_api_object Creates a new instance of class hw_api_object - - Description + + + &reftitle.description; hw_api_objecthw_api_object arrayparameter - See also hwapi_lock. + Creates a new instance of the class hw_api_object. + + + &reftitle.parameters; + + + + parameter + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.seealso; + + + + + + + - + hw_api_object->remove Removes attribute - - Description - - boolhw_api_object->remove - stringname - + + + &reftitle.description; + + hw_api_object + + boolremove + stringname + + - Removes the attribute with the given name. Returns &true; on success - and otherwise &false;. - - - See also hwapi_object_insert. + Removes the attribute with the given name. + + + &reftitle.parameters; + + + + name + + + The attribute name. + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.seealso; + + + + + + + - + hw_api_object->title Returns the title attribute - - Description - - stringhw_api_object->title - arrayparameter - + + + &reftitle.description; + + hw_api_object + + stringtitle + arrayparameter + + + Returns the title attribute. + + + &reftitle.parameters; + + + + parameter + + + + + + + + + + + &reftitle.returnvalues; + + Returns the title as a string. + + + - + hw_api_object->value Returns value of attribute - - Description - - stringhw_api_object->value - stringname - + + + &reftitle.description; + + hw_api_object + + stringvalue + stringname + + + + Returns value of an attribute. + + + + + &reftitle.parameters; + + + + name + + + The attribute name. + + + + + + + + + &reftitle.returnvalues; Returns the value of the attribute with the given name or &false; if an error occurred. + - + hw_api->object Retrieve attribute information - - Description - - hw_api_objecthw_api->object - arrayparameter - + + + &reftitle.description; + + hw_api + + hw_api_objectobject + arrayparameter + + 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'. + version. It will not return the document content. + + + + &reftitle.parameters; + + + + parameter + + + The parameter array contains the required elements 'objectIdentifier' + and the optional elements 'attributeSelector' and 'version'. + + + + + + + + + &reftitle.returnvalues; The returned object is an instance of class HW_API_Object on success or HW_API_Error if an error occurred. + + + + &reftitle.examples; This simple example retrieves an object and checks for errors. @@ -74,10 +100,17 @@ list_attr($root); + + + + &reftitle.seealso; - See also hwapi_content. + + + + - + hw_api->objectbyanchor Returns the object an anchor belongs to - - Description - - hw_api_objecthw_api->objectbyanchor - arrayparameter - + + + &reftitle.description; + + hw_api + + hw_api_objectobjectbyanchor + arrayparameter + + This function retrieves an object the specified anchor belongs to. - The parameter array contains the required element 'objectIdentifier' and - the optional element 'attributeSelector'. - - - See also hwapi_dstofsrcanchor, - hwapi_srcanchors and hwapi_dstanchors. + + + &reftitle.parameters; + + + + parameter + + + The parameter array contains the required element 'objectIdentifier' + and the optional element 'attributeSelector'. + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.seealso; + + + + + + + + + - + hw_api->parents Returns parents of an object - - Description - - arrayhw_api->parents - arrayparameter - + + + &reftitle.description; + + hw_api + + arrayparents + arrayparameter + + 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'. + specifying an object query. + + + + &reftitle.parameters; + + + + parameter + + + The parameter array contains the required elements 'objectidentifier' + and the optional elements 'attributeselector' and 'objectquery'. + + + + + + + + + &reftitle.returnvalues; The return value is an array of objects of type HW_API_Object or HW_API_Error. + + + + &reftitle.seealso; - See also hwapi_children. + + + + - + hw_api_reason->description Returns description of reason - - Description - - stringhw_api_reason->description - - + + + &reftitle.description; + + hw_api_reason + + stringdescription + + + Returns the description of a reason + + + &reftitle.returnvalues; + + Returns the description, as a string. + + + - + hw_api_reason->type Returns type of reason - - Description - - HW_API_Reasonhw_api_reason->type - - + + + &reftitle.description; + + hw_api_reason + + HW_API_Reasontype + + + Returns the type of a reason. + + + &reftitle.returnvalues; + + Returns an instance of HW_API_Reason. + + + - + hw_api->remove Delete an object - - Description - - boolhw_api->remove - arrayparameter - + + + &reftitle.description; + + hw_api + + boolremove + arrayparameter + + 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 skipped. - 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 immediately. 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. - - - See also hwapi_move. + will be removed recursively. + + + &reftitle.parameters; + + + + parameter + + + 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 skipped. + + + 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 immediately. 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. + + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.seealso; + + + + + + + - + hw_api->replace Replaces an object - - Description - - hw_api_objecthw_api->replace - arrayparameter - + + + &reftitle.description; + + hw_api + + hw_api_objectreplace + arrayparameter + + + + Replaces the attributes and the content of an object. + + + + + &reftitle.parameters; - 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 + parameter - - The object on the server is replace with the object passed. - - - - - HW_API_REPLACE_FORCE_VERSION_CONTROL - - - - - - - HW_API_REPLACE_AUTOMATIC_CHECKOUT - - - - - - - HW_API_REPLACE_AUTOMATIC_CHECKIN - - - - - - - HW_API_REPLACE_PLAIN - - - - - - - HW_API_REPLACE_REVERT_IF_NOT_CHANGED - - - - - - - HW_API_REPLACE_KEEP_TIME_MODIFIED - - - + + 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 + + + The object on the server is replace with the object passed. + + + + + HW_API_REPLACE_FORCE_VERSION_CONTROL + + + + + + + HW_API_REPLACE_AUTOMATIC_CHECKOUT + + + + + + + HW_API_REPLACE_AUTOMATIC_CHECKIN + + + + + + + HW_API_REPLACE_PLAIN + + + + + + + HW_API_REPLACE_REVERT_IF_NOT_CHANGED + + + + + + + HW_API_REPLACE_KEEP_TIME_MODIFIED + + + + + + + + + + + &reftitle.returnvalues; - See also hwapi_insert. + + + + &reftitle.seealso; + + + + + + + - + hw_api->setcommittedversion Commits version other than last version - - Description - - hw_api_objecthw_api->setcommittedversion - arrayparameter - + + + &reftitle.description; + + hw_api + + hw_api_objectsetcommittedversion + arrayparameter + + Commits a version of a document. The committed version is the one which is visible to users with read access. By default the last version is the committed version. + + + + &reftitle.parameters; - See also hwapi_checkin, - hwapi_checkout and hwapi_revert. + + + parameter + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.seealso; + + + + + + + + + - + hw_api->srcanchors Returns a list of all source anchors - - Description - - arrayhw_api->srcanchors - arrayparameter - + + + &reftitle.description; + + hw_api + + arraysrcanchors + arrayparameter + + - Retrieves all source anchors of an object. The parameter array contains - the required element 'objectIdentifier' and the optional elements - 'attributeSelector' and 'objectQuery'. - - - See also hwapi_dstanchors. + Retrieves all source anchors of an object. + + + &reftitle.parameters; + + + + parameter + + + The parameter array contains the required element 'objectIdentifier' + and the optional elements 'attributeSelector' and 'objectQuery'. + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.seealso; + + + + + + + - + hw_api->srcsofdst Returns source of a destination object - - Description - - arrayhw_api->srcsofdst - arrayparameter - + + + &reftitle.description; + + hw_api + + arraysrcsofdst + arrayparameter + + 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. - - - See also hwapi_dstofsrcanchor. + document. + + + &reftitle.parameters; + + + + parameter + + + 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. + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.seealso; + + + + + + + - + hw_api->unlock Unlocks a locked object - - Description - - boolhw_api->unlock - arrayparameter - + + + &reftitle.description; + + hw_api + + boolunlock + arrayparameter + + 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. + system user may unlock an object. + + + + &reftitle.parameters; + + + + parameter + + + 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. + + + + + + + + + &reftitle.returnvalues; Returns &true; on success or an object of class HW_API_Error. + + + + &reftitle.seealso; - See also hwapi_lock. + + + + - + hw_api->user Returns the own user object - - Description - - hw_api_objecthw_api->user - arrayparameter - + + + &reftitle.description; + + hw_api + + hw_api_objectuser + arrayparameter + + - See also hwapi_userlist. + Returns the own user object. + + + &reftitle.parameters; + + + + parameter + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.seealso; + + + + + + + - + hw_api->userlist Returns a list of all logged in users - - Description - - arrayhw_api->userlist - arrayparameter - + + + &reftitle.description; + + hw_api + + arrayuserlist + arrayparameter + + - See also hwapi_user. + Returns a list of all logged in users. + + + &reftitle.parameters; + + + + parameter + + + + + + + + + + + &reftitle.returnvalues; + + + + + + + &reftitle.seealso; + + + + + + +