hw_api::checkin
(PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN)
hw_api::checkin — Checks in an object
Description
$parameter
) : boolThis function checks in an object or a whole hierarchy 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
- Checks in and commits the object. The object must be a document.
- HW_API_CHECKIN_RECURSIVE
- 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
- Checks in an object even if it is not under version control.
- HW_API_CHECKIN_REVERT_IF_NOT_CHANGED
- 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
- Keeps the time modified from the most recent object.
- HW_API_CHECKIN_NO_AUTO_COMMIT
- The object is not automatically committed on check-in.
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-hwapi.checkin.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.