hw_api::checkout

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

hw_api::checkout — Checks out an object

说明

hw_api::checkout ( array $parameter ) : bool

This function checks out an object or a whole hierarchy of objects.

参数

parameter

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.

返回值

成功时返回 TRUE， 或者在失败时返回 FALSE。

相关文章
php hyperwave api 函数 returns object of class hw apiphp hyperwave api 函数 creates a new instance of class hwapi object newphp hyperwave api 函数 checks in an objectphp hyperwave api 函数 checks out an objectphp hyperwave api 函数 returns children of an objectphp hyperwave api 函数 inserts a new objectphp hyperwave api 函数 inserts a new object of type anchorphp hyperwave api 函数 inserts a new object of type collectionphp hyperwave api 函数 creates a link to an objectphp hyperwave api 函数 locks an objectphp hyperwave api 函数 moves object between collectionsphp hyperwave api 函数 clones objectphp hyperwave api 函数 checks whether an attribute is editablephp hyperwave api 函数 returns the object an anchor belongs tophp hyperwave api 函数 returns parents of an objectphp hyperwave api 函数 delete an objectphp hyperwave api 函数 replaces an objectphp hyperwave api 函数 returns source of a destination objectphp hyperwave api 函数 unlocks a locked objectphp hyperwave api 函数 returns the own user object
关注编程学问公众号