PHP 5.6.0beta1 released

hw_api::checkin

(PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN)

hw_api::checkinArchive un objet

Description

bool hw_api::checkin ( array $parameter )

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.

Liste de paramètres

parameter

Valeurs de retour

Cette fonction retourne TRUE en cas de succès ou FALSE si une erreur survient.

Voir aussi

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top