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

hw_pipedocument
Prev	XXVIII. Hyperwave Functions	Next

hw_pipedocument

Name

hw_pipedocument — Retrieves a document with anchors inserted.

Synopsis

int hw_pipedocument(hw_link, object_id[, url_prefixes]); resource hw_link: Connection ID to Hyperwave server int object_id: Object ID of object to fetch array url_prefixes (optional): List of URL prefixes to prepend to inserted anchors

Returns

Document ID on success; FALSE on failure

Description

This function fetches a document from the Hyperwave server, inserts all anchors, and returns its document ID. This ID can then be used with functions such as hw_output_document() to print out the content.

If the url_prefixes parameter is given, it must be an associative array containing the following five elements, with the value of each element giving the string prefix to prepend to links of the appropriate type. The required element keys are HW_DEFAULT_LINK, HW_IMAGE_LINK, HW_INTAG_LINK, HW_APPLET_LINK, and HW_BACKGROUND_LINK.

The document is fetched using a separate data connection to the server, so the control connection is not blocked, and data of any kind (for instance, images) can be retrieved.

Version

PHP 3 since 3.0.3, PHP 4

Example

Example 521. Fetch a document

if (($doc_id = hw_pipedocument($hw_link, 369)) === FALSE) {
    echo "Could not retrieve document; reason: " . hw_errormsg($hw_link) . "\n";
} else {
    hw_output_document($doc_id);
}

/* Do the same thing, but make images link to a different directory. */
$urlprefixes = array('HW_IMAGE_LINK' => 'my_images',
                     'HW_DEFAULT_LINK' => '',                     
                     'HW_APPLET_LINK' => '',
                     'HW_INTAG_LINK' => '',
                     'HW_BACKGROUND_LINK' => '');
if (($doc_id = hw_pipedocument($hw_link, 369, $url_prefixes)) === FALSE) {
    echo "Could not retrieve document; reason: " . hw_errormsg($hw_link) . "\n";
} else {
    hw_output_document($doc_id);
}

Prev	Home	Next
hw_pipecgi	Up	hw_root

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.