Delicious Bookmark this on Delicious Share on Facebook SlashdotSlashdot It! Digg! Digg



PHP : Function Reference : Hyperwave API Functions : hw_api->remove

hw_api->remove

Delete an object ()

hw_api {
  bool remove(array parameter);
}

Removes an object from the specified parent. Collections will be removed recursively.

Parameters

parameter

You can pass an optional object query to remove only those objects which match the query. An object will be deleted physically if it is the last instance.

The parameter array contains the required elements 'objectidentifier' and 'parentidentifier'. If you want to remove a user or group 'parentidentifier' can be skipped.

The optional parameter 'mode' determines how the deletion is performed. In normal mode the object will not be removed physically until all instances are removed. In physical mode all instances of the object will be deleted immediately. In removelinks mode all references to and from the objects will be deleted as well. In nonrecursive the deletion is not performed recursive. Removing a collection which is not empty will cause an error.

Return Values

Returns TRUE on success or FALSE on failure.

See Also
hw_api->move

Change Language


Follow Navioo On Twitter
hw_api_attribute->key
hw_api_attribute->langdepvalue
hw_api_attribute->value
hw_api_attribute->values
hw_api_attribute
hw_api->checkin
hw_api->checkout
hw_api->children
hw_api_content->mimetype
hw_api_content->read
hw_api->content
hw_api->copy
hw_api->dbstat
hw_api->dcstat
hw_api->dstanchors
hw_api->dstofsrcanchor
hw_api_error->count
hw_api_error->reason
hw_api->find
hw_api->ftstat
hwapi_hgcsp
hw_api->hwstat
hw_api->identify
hw_api->info
hw_api->insert
hw_api->insertanchor
hw_api->insertcollection
hw_api->insertdocument
hw_api->link
hw_api->lock
hw_api->move
hw_api_content
hw_api_object->assign
hw_api_object->attreditable
hw_api_object->count
hw_api_object->insert
hw_api_object
hw_api_object->remove
hw_api_object->title
hw_api_object->value
hw_api->object
hw_api->objectbyanchor
hw_api->parents
hw_api_reason->description
hw_api_reason->type
hw_api->remove
hw_api->replace
hw_api->setcommittedversion
hw_api->srcanchors
hw_api->srcsofdst
hw_api->unlock
hw_api->user
hw_api->userlist
eXTReMe Tracker