hw_api::checkin
(PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN)
hw_api::checkin — Checks in an object
Описание
bool hw_api::checkin
( array
$parameter
)This function checks in an object or a whole hierarchy of objects. The parameters array contains the required element 'objectIdentifier' and the optional element 'version', 'comment', 'mode' and 'objectQuery'. 'version' sets the version of the object. It consists of the major and minor version separated by a period. If the version is not set, the minor version is incremented. 'mode' can be one of the following values:
- HW_API_CHECKIN_NORMAL
- Checks in and commits the object. The object must be a document.
- HW_API_CHECKIN_RECURSIVE
- If the object to check in is a collection, all children will be checked in recursively if they are documents. Trying to check in a collection would result in an error.
- HW_API_CHECKIN_FORCE_VERSION_CONTROL
- Checks in an object even if it is not under version control.
- HW_API_CHECKIN_REVERT_IF_NOT_CHANGED
- Check if the new version is different from the last version. Unless this is the case the object will be checked in.
- HW_API_CHECKIN_KEEP_TIME_MODIFIED
- Keeps the time modified from the most recent object.
- HW_API_CHECKIN_NO_AUTO_COMMIT
- The object is not automatically committed on check-in.
Список параметров
-
parameter -
Возвращаемые значения
Возвращает TRUE в случае успешного завершения или FALSE в случае возникновения ошибки.
- Функция hw_api::checkin() - Checks in an object
- Функция hw_api::checkout() - Checks out an object
- Функция hw_api::children() - Returns children of an object
- Функция hw_api::content() - Returns content of an object
- Функция hw_api::copy() - Copies physically
- Функция hw_api::dbstat() - Returns statistics about database server
- Функция hw_api::dcstat() - Returns statistics about document cache server
- Функция hw_api::dstanchors() - Returns a list of all destination anchors
- Функция hw_api::dstofsrcanchor() - Returns destination of a source anchor
- Функция hw_api::find() - Search for objects
- Функция hw_api::ftstat() - Returns statistics about fulltext server
- Функция hw_api::hwstat() - Returns statistics about Hyperwave server
- Функция hw_api::identify() - Log into Hyperwave Server
- Функция hw_api::info() - Returns information about server configuration
- Функция hw_api::insert() - Inserts a new object
- Функция hw_api::insertanchor() - Inserts a new object of type anchor
- Функция hw_api::insertcollection() - Inserts a new object of type collection
- Функция hw_api::insertdocument() - Inserts a new object of type document
- Функция hw_api::link() - Creates a link to an object
- Функция hw_api::lock() - Locks an object
- Функция hw_api::move() - Moves object between collections
- Функция hw_api::object() - Retrieve attribute information
- Функция hw_api::objectbyanchor() - Returns the object an anchor belongs to
- Функция hw_api::parents() - Returns parents of an object
- Функция hw_api::remove() - Delete an object
- Функция hw_api::replace() - Replaces an object
- Функция hw_api::setcommittedversion() - Commits version other than last version
- Функция hw_api::srcanchors() - Returns a list of all source anchors
- Функция hw_api::srcsofdst() - Returns source of a destination object
- Функция hw_api::unlock() - Unlocks a locked object
- Функция hw_api::user() - Returns the own user object
- Функция hw_api::userlist() - Returns a list of all logged in users
- Функция hw_api_attribute::key() - Returns key of the attribute
- Функция hw_api_attribute::langdepvalue() - Returns value for a given language
- Функция hw_api_attribute::value() - Returns value of the attribute
- Функция hw_api_attribute::values() - Returns all values of the attribute
- Функция hw_api_content::mimetype() - Returns mimetype
- Функция hw_api_content::read() - Read content
- Функция hw_api_error::count() - Returns number of reasons
- Функция hw_api_error::reason() - Returns reason of error
- Функция hw_api_object::assign() - Clones object
- Функция hw_api_object::attreditable() - Checks whether an attribute is editable
- Функция hw_api_object::count() - Returns number of attributes
- Функция hw_api_object::insert() - Inserts new attribute
- Функция hw_api_object::remove() - Removes attribute
- Функция hw_api_object::title() - Returns the title attribute
- Функция hw_api_object::value() - Returns value of attribute
- Функция hw_api_reason::description() - Returns description of reason
- Функция hw_api_reason::type() - Returns type of reason
- hwapi_attribute_new
- hwapi_content_new
- hwapi_hgcsp
- hwapi_object_new
Коментарии
404 Not Found