What is PhpDig?
PhpDig is a PHP MySQL based
Web Spider & Search Engine.

hw_mv
Prev	XXVIII. Hyperwave Functions	Next

hw_mv

Name

hw_mv — Moves one or more objects from one collection to another.

Synopsis

int hw_mv(hw_link, object_ids, source_id, dest_id); resource hw_link: Connection ID to Hyperwave server array object_ids: Object IDs of objects to be moved int source_id: Object ID of the source collection int dest_id: Object ID of the destination collection

Returns

Number of objects moved; FALSE on error

Description

Moves a list of objects from the collection identified by source_id to that given by dest_id . The objects to be moved are specified by listing their object IDs in the indexed array object_ids .

You can use hw_mv() to unlink objects from their parent collections by providing a dest_id of 0. However, if the object to which this is done was the last instance of itself, it's deleted from the server entirely.

The return value is the number of objects that were successfully moved, or FALSE on error.

Version

PHP 3 since 3.0.3, PHP 4

Example

Example 514. Move a list of objects

if (($num_moved = hw_mv($hw_link, array(5, 8, 26), $source_id, $dest_id)) === FALSE) {
    echo "Could not move objects; reason: " . hw_errormsg($hw_link) . "\n";
} else {
    echo "Successfully moved $num_moved objects.\n";
}

Prev	Home	Next
hw_modifyobject	Up	hw_new_document

PHP Functions Essential Reference. Copyright © 2002 by New Riders Publishing (Authors: Zak Greant, Graeme Merrall, Torben Wilson, Brett Michlitsch). This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, v1.0 or later (the latest version is presently available at http://www.opencontent.org/openpub/). The authors of this book have elected not to choose any options under the OPL. This online book was obtained from http://www.fooassociates.com/phpfer/ and is designed to provide information about the PHP programming language, focusing on PHP version 4.0.4 for the most part. The information is provided on an as-is basis, and no warranty or fitness is implied. All persons and entities shall have neither liability nor responsibility to any person or entity with respect to any loss or damage arising from the information contained in this book.