hw_api->checkin
(No version information available, might be only in CVS)
hw_api->checkin — Archive un objet
Description
bool hw_api->checkin
( array $parameter
)
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 versions majeure et mineure, séparées par des virgules. Si une version n'existe pas, la version mineure est incrémentée. 'mode' peut être l'une des constantes suivantes :
- HW_API_CHECKIN_NORMAL
- Archive et valide l'objet. L'objet doit être un document.
- HW_API_CHECKIN_RECURSIVE
- Si l'objet à archiver est une collection, tous les fils seront vérifiés récursivement, s'ils sont des documents. Tenter d'archiver une collection générera une erreur.
- HW_API_CHECKIN_FORCE_VERSION_CONTROL
- Archive un objet même s'il ne passe pas sous le contrôle de versions.
- HW_API_CHECKIN_REVERT_IF_NOT_CHANGED
- Vérifie s'il existe une version différente de la dernière version. À moins que cela ne soit le cas, l'objet sera alors archivé.
- HW_API_CHECKIN_KEEP_TIME_MODIFIED
- Conserve la date de modification de l'objet le plus récent.
- HW_API_CHECKIN_NO_AUTO_COMMIT
- L'objet n'est pas automatiquement validé lors de l'archivage.
Voir aussi hwapi_checkout().