hw_api::lock

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

hw_api::lock — Locks an object

说明

hw_api::lock ( array $parameter ) : bool

Locks an object for exclusive editing by the user calling this function. The object can be only unlocked by this user or the system user.

参数

parameter

The parameter array contains the required element 'objectIdentifier' and the optional parameters 'mode' and 'objectquery'.

'mode' determines how an object is locked. HW_API_LOCK_NORMAL means, an object is locked until it is unlocked. HW_API_LOCK_RECURSIVE is only valid for collection and locks all objects within the collection and possible subcollections. HW_API_LOCK_SESSION means, an object is locked only as long as the session is valid.

返回值

成功时返回 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 函数 returns content 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 函数 inserts a new object of type documentphp 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 函数 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 函数 unlocks a locked objectphp hyperwave api 函数 returns the own user object
关注编程学问公众号