hw_api->checkin
(PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN)
hw_api->checkin — Registra un objeto
Descripción
bool hw_api::checkin
( array $parameter
)
Esta función registra un objeto o una jerarquía completa de objetos.
EL array de parámetros contiene el elemento 'objectIdentifier'
requerido y el elemento opcional 'version', 'comment', 'mode'
y
'objectQuery'. 'version' establece la versión del objeto. Consiste en la
versión mayor y menor separadas por un punto. Si la versión no está
establecida, la versión menor es incrementada. 'mode' puede ser uno de los siguientes
valores:
-
HW_API_CHECKIN_NORMAL
-
Registra y asigna el objeto. El objeto debe ser un documento.
-
HW_API_CHECKIN_RECURSIVE
-
Si el objeto a registrar es un colección, todos los hijos serán
registrados recursivamente si hay documentos. Intentar registrar
una colección resultaría en un error.
-
HW_API_CHECKIN_FORCE_VERSION_CONTROL
-
Regsitra un objeto incluso si no está bajo el control de versiones.
-
HW_API_CHECKIN_REVERT_IF_NOT_CHANGED
-
Verifica si la nueva versión es diferente de la última versión. A menos
que este sea el caso, el objeto será registrado.
-
HW_API_CHECKIN_KEEP_TIME_MODIFIED
-
Mantiene el momento modificado desde el objeto más reciente.
-
HW_API_CHECKIN_NO_AUTO_COMMIT
-
El objeto no es asignado automáticamente durante el registro.
Valores devueltos
Devuelve TRUE en caso de éxito o FALSE en caso de error.