mhs-xapian 1.0.18a

data/php/docs/examples/simpleexpand.php4

@@ -0,0 +1,108 @@
+<?php
+/* Simple example PHP4 script demonstrating query expansion.
+ *
+ * Copyright (C) 2007 Olly Betts
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ */
+
+if (php_sapi_name() != "cli") {
+    print "This example script is written to run under the command line ('cli') version of\n";
+    print "the PHP interpreter, but you're using the '".php_sapi_name()."' version\n";
+    exit(1);
+}
+
+include "php4/xapian.php";
+
+// PHP < 4.3.0 only sets $argc and $argv if 'register_globals' is on.
+if (!isset($argc)) $argc = $_SERVER['argc'];
+if (!isset($argv)) $argv = $_SERVER['argv'];
+
+if ($argc < 3) {
+    print "Usage: {$argv[0]} PATH_TO_DATABASE QUERY [-- [DOCID...]]\n";
+    exit(1);
+}
+
+// Open the database for searching.
+$database = new XapianDatabase($argv[1]);
+if (!$database) {
+    print "Couldn't open database '{$argv[1]}'\n";
+    exit(1);
+}
+
+// Start an enquire session.
+$enquire = new XapianEnquire($database);
+
+// Combine command line arguments up to "--" with spaces between
+// them, so that simple queries don't have to be quoted at the shell
+// level.
+$args = array_slice($argv, 2);
+$separator = array_search("--", $args);
+
+// In PHP < 4.2.0, array_search returns Null on failure.
+if ($separator === Null || $separator === FALSE) {
+    $separator = count($args);
+}
+
+$query_string = join(" ", array_slice($args, 0, $separator);
+
+$rset = new XapianRSet();
+foreach (array_slice($args, $separator + 1) as $docid) {
+    $rset->add_document(intval($docid));
+}
+
+$qp = new XapianQueryParser();
+$stemmer = new XapianStem("english");
+$qp->set_stemmer($stemmer);
+$qp->set_database($database);
+$qp->set_stemming_strategy(XapianQueryParser_STEM_SOME);
+$query = $qp->parse_query($query_string);
+print "Parsed query is: {$query->get_description()}\n";
+
+// Find the top 10 results for the query.
+$enquire->set_query($query);
+$matches = $enquire->get_mset(0, 10, $rset);
+
+// Display the results.
+print "{$matches->get_matches_estimated()} results found:\n";
+
+$i = $matches->begin();
+while (!$i->equals($matches->end())) {
+    $n = $i->get_rank() + 1;
+    $data = $i->get_document()->get_data();
+    print "$n: {$i->get_percent()}% docid={$i->get_docid()} [$data]\n\n";
+    $i->next();
+}
+
+// If no relevant docids were given, invent an RSet containing the top 5
+// matches (or all the matches if there are less than 5).
+if ($rset->is_empty()) {
+    $c = 5;
+    $i = $matches->begin();
+    while ($c-- && !$i->equals($matches->end())) {
+	$rset->add_document($i->get_docid());
+	$i->next();
+    }
+}
+
+// Generate an ESet containing terms that the user might want to add to
+// the query.
+$eset = $enquire->get_eset(10, $rset);
+
+// List the terms.
+for ($t = $eset->begin(); !$t->equals($eset->end()); $t->next()) {
+    print "{$t->get_term()}: weight = {$t->get_weight()}\n";
+}
+?>

data/php/docs/examples/simpleexpand.php5

@@ -0,0 +1,104 @@
+<?php
+/* Simple example PHP5 script demonstrating query expansion.
+ *
+ * Copyright (C) 2007 Olly Betts
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ */
+
+if (php_sapi_name() != "cli") {
+    print "This example script is written to run under the command line ('cli') version of\n";
+    print "the PHP interpreter, but you're using the '".php_sapi_name()."' version\n";
+    exit(1);
+}
+
+include "php5/xapian.php";
+
+if ($argc < 3) {
+    print "Usage: {$argv[0]} PATH_TO_DATABASE QUERY [-- [DOCID...]]\n";
+    exit(1);
+}
+
+try {
+    // Open the database for searching.
+    $database = new XapianDatabase($argv[1]);
+
+    // Start an enquire session.
+    $enquire = new XapianEnquire($database);
+
+    // Combine command line arguments up to "--" with spaces between
+    // them, so that simple queries don't have to be quoted at the shell
+    // level.
+    $args = array_slice($argv, 2);
+    $separator = array_search("--", $args);
+
+    if ($separator === FALSE) {
+	$separator = count($args);
+    }
+
+    $query_string = join(" ", array_slice($args, 0, $separator));
+
+    $rset = new XapianRSet();
+    foreach (array_slice($args, $separator + 1) as $docid) {
+	$rset->add_document(intval($docid));
+    }
+
+    $qp = new XapianQueryParser();
+    $stemmer = new XapianStem("english");
+    $qp->set_stemmer($stemmer);
+    $qp->set_database($database);
+    $qp->set_stemming_strategy(XapianQueryParser::STEM_SOME);
+    $query = $qp->parse_query($query_string);
+    print "Parsed query is: {$query->get_description()}\n";
+
+    // Find the top 10 results for the query.
+    $enquire->set_query($query);
+    $matches = $enquire->get_mset(0, 10, $rset);
+
+    // Display the results.
+    print "{$matches->get_matches_estimated()} results found:\n";
+
+    $i = $matches->begin();
+    while (!$i->equals($matches->end())) {
+	$n = $i->get_rank() + 1;
+	$data = $i->get_document()->get_data();
+	print "$n: {$i->get_percent()}% docid={$i->get_docid()} [$data]\n\n";
+	$i->next();
+    }
+
+    // If no relevant docids were given, invent an RSet containing the top 5
+    // matches (or all the matches if there are less than 5).
+    if ($rset->is_empty()) {
+	$c = 5;
+	$i = $matches->begin();
+	while ($c-- && !$i->equals($matches->end())) {
+	    $rset->add_document($i->get_docid());
+	    $i->next();
+	}
+    }
+
+    // Generate an ESet containing terms that the user might want to add to
+    // the query.
+    $eset = $enquire->get_eset(10, $rset);
+
+    // List the terms.
+    for ($t = $eset->begin(); !$t->equals($eset->end()); $t->next()) {
+	print "{$t->get_term()}: weight = {$t->get_weight()}\n";
+    }
+} catch (Exception $e) {
+    print $e->getMessage() . "\n";
+    exit(1);
+}
+?>

data/php/docs/examples/simpleindex.php4

@@ -0,0 +1,76 @@
+<?php
+/* PHP4 script to index each paragraph of a text file as a Xapian document.
+ *
+ * Copyright (C) 2007 Olly Betts
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ */
+
+if (php_sapi_name() != "cli") {
+    print "This example script is written to run under the command line ('cli') version of\n";
+    print "the PHP interpreter, but you're using the '".php_sapi_name()."' version\n";
+    exit(1);
+}
+
+include "php4/xapian.php";
+
+// PHP < 4.3.0 only sets $argc and $argv if 'register_globals' is on.
+if (!isset($argc)) $argc = $_SERVER['argc'];
+if (!isset($argv)) $argv = $_SERVER['argv'];
+
+if ($argc != 2) {
+    print "Usage: {$argv[0]} PATH_TO_DATABASE\n";
+    exit(1);
+}
+
+// Open the database for update, creating a new database if necessary.
+$database = new XapianWritableDatabase($argv[1], Xapian_DB_CREATE_OR_OPEN);
+if (!$database) {
+    print "Couldn't create or open database '{$argv[1]}' for indexing\n";
+    exit(1);
+}
+
+$indexer = new XapianTermGenerator();
+$stemmer = new XapianStem("english");
+$indexer->set_stemmer($stemmer);
+
+$para = '';
+$lines = file("php://stdin");
+foreach ($lines as $line) {
+    $line = rtrim($line);
+    if ($line == "" && $para != "") {
+	// We've reached the end of a paragraph, so index it.
+	$doc = new XapianDocument();
+	$doc->set_data($para);
+
+	$indexer->set_document($doc);
+	$indexer->index_text($para);
+
+	// Add the document to the database.
+	$database->add_document($doc);
+
+	$para = "";
+    } else {
+	if ($para != "") {
+	    $para .= " ";
+	}
+	$para .= $line;
+    }
+}
+
+// Set the database handle to Null to ensure that it gets closed
+// down cleanly or unflushed changes may be lost.
+$database = Null;
+?>

data/php/docs/examples/simpleindex.php5

@@ -0,0 +1,73 @@
+<?php
+/* PHP5 script to index each paragraph of a text file as a Xapian document.
+ *
+ * Copyright (C) 2007 Olly Betts
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ */
+
+if (php_sapi_name() != "cli") {
+    print "This example script is written to run under the command line ('cli') version of\n";
+    print "the PHP interpreter, but you're using the '".php_sapi_name()."' version\n";
+    exit(1);
+}
+
+include "php5/xapian.php";
+
+if ($argc != 2) {
+    print "Usage: {$argv[0]} PATH_TO_DATABASE\n";
+    exit(1);
+}
+
+try {
+    // Open the database for update, creating a new database if necessary.
+    $database = new XapianWritableDatabase($argv[1], Xapian::DB_CREATE_OR_OPEN);
+
+    $indexer = new XapianTermGenerator();
+    $stemmer = new XapianStem("english");
+    $indexer->set_stemmer($stemmer);
+
+    $para = '';
+    $lines = file("php://stdin");
+    foreach ($lines as $line) {
+	$line = rtrim($line);
+	if ($line == "" && $para != "") {
+	    // We've reached the end of a paragraph, so index it.
+	    $doc = new XapianDocument();
+	    $doc->set_data($para);
+
+	    $indexer->set_document($doc);
+	    $indexer->index_text($para);
+
+	    // Add the document to the database.
+	    $database->add_document($doc);
+
+	    $para = "";
+	} else {
+	    if ($para != "") {
+		$para .= " ";
+	    }
+	    $para .= $line;
+	}
+    }
+
+    // Set the database handle to Null to ensure that it gets closed
+    // down cleanly or unflushed changes may be lost.
+    $database = Null;
+} catch (Exception $e) {
+    print $e->getMessage() . "\n";
+    exit(1);
+}
+?>

data/php/docs/examples/simplesearch.php4

@@ -0,0 +1,75 @@
+<?php
+/* Simple command-line search PHP4 script.
+ *
+ * Copyright (C) 2007 Olly Betts
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ */
+
+if (php_sapi_name() != "cli") {
+    print "This example script is written to run under the command line ('cli') version of\n";
+    print "the PHP interpreter, but you're using the '".php_sapi_name()."' version\n";
+    exit(1);
+}
+
+include "php4/xapian.php";
+
+// PHP < 4.3.0 only sets $argc and $argv if 'register_globals' is on.
+if (!isset($argc)) $argc = $_SERVER['argc'];
+if (!isset($argv)) $argv = $_SERVER['argv'];
+
+if ($argc < 3) {
+    print "Usage: {$argv[0]} PATH_TO_DATABASE QUERY\n";
+    exit(1);
+}
+
+// Open the database for searching.
+$database = new XapianDatabase($argv[1]);
+if (!$database) {
+    print "Couldn't open database '{$argv[1]}'\n";
+    exit(1);
+}
+
+// Start an enquire session.
+$enquire = new XapianEnquire($database);
+
+// Combine the rest of the command line arguments with spaces between
+// them, so that simple queries don't have to be quoted at the shell
+// level.
+$query_string = join(" ", array_slice($argv, 2));
+
+$qp = new XapianQueryParser();
+$stemmer = new XapianStem("english");
+$qp->set_stemmer($stemmer);
+$qp->set_database($database);
+$qp->set_stemming_strategy(XapianQueryParser_STEM_SOME);
+$query = $qp->parse_query($query_string);
+print "Parsed query is: {$query->get_description()}\n";
+
+// Find the top 10 results for the query.
+$enquire->set_query($query);
+$matches = $enquire->get_mset(0, 10);
+
+// Display the results.
+print "{$matches->get_matches_estimated()} results found:\n";
+
+$i = $matches->begin();
+while (!$i->equals($matches->end())) {
+    $n = $i->get_rank() + 1;
+    $data = $i->get_document()->get_data();
+    print "$n: {$i->get_percent()}% docid={$i->get_docid()} [$data]\n\n";
+    $i->next();
+}
+?>

data/php/docs/examples/simplesearch.php5

@@ -0,0 +1,72 @@
+<?php
+/* Simple command-line search PHP5 script.
+ *
+ * Copyright (C) 2007 Olly Betts
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ */
+
+if (php_sapi_name() != "cli") {
+    print "This example script is written to run under the command line ('cli') version of\n";
+    print "the PHP interpreter, but you're using the '".php_sapi_name()."' version\n";
+    exit(1);
+}
+
+include "php5/xapian.php";
+
+if ($argc < 3) {
+    print "Usage: {$argv[0]} PATH_TO_DATABASE QUERY\n";
+    exit(1);
+}
+
+// Open the database for searching.
+try {
+    $database = new XapianDatabase($argv[1]);
+
+    // Start an enquire session.
+    $enquire = new XapianEnquire($database);
+
+    // Combine the rest of the command line arguments with spaces between
+    // them, so that simple queries don't have to be quoted at the shell
+    // level.
+    $query_string = join(" ", array_slice($argv, 2));
+
+    $qp = new XapianQueryParser();
+    $stemmer = new XapianStem("english");
+    $qp->set_stemmer($stemmer);
+    $qp->set_database($database);
+    $qp->set_stemming_strategy(XapianQueryParser::STEM_SOME);
+    $query = $qp->parse_query($query_string);
+    print "Parsed query is: {$query->get_description()}\n";
+
+    // Find the top 10 results for the query.
+    $enquire->set_query($query);
+    $matches = $enquire->get_mset(0, 10);
+
+    // Display the results.
+    print "{$matches->get_matches_estimated()} results found:\n";
+
+    $i = $matches->begin();
+    while (!$i->equals($matches->end())) {
+	$n = $i->get_rank() + 1;
+	$data = $i->get_document()->get_data();
+	print "$n: {$i->get_percent()}% docid={$i->get_docid()} [$data]\n\n";
+	$i->next();
+    }
+} catch (Exception $e) {
+    print $e->getMessage() . "\n";
+    exit(1);
+}
+?>