Changeset 1023

Timestamp:

04/21/07 14:07:37 (19 months ago)

Author:

kake

Message:

Added format => "raw" option to OpenGuides::Search->run to let you get your results back as a hash.

Location:

trunk

Files:

• Changes (modified) (1 diff)
• MANIFEST (modified) (1 diff)
• lib/OpenGuides/Search.pm (modified) (5 diffs)
• t/30_search_raw.t (added)

trunk/Changes

@@ -15 +15 @@
           the whole form.
         Added links to the "revision N" and "Last edited" text in the navbar.
+        Added format => "raw" option to OpenGuides::Search->run to let you get
+          your results back as a hash.
         Add JavaScript to the Create New Page page so the prefilled
           "New page name" disappears when you click in the field (it doesn't

trunk/MANIFEST

@@ -93 +93 @@
 t/27_geo_data_edit_form.t
 t/28_wgs84_coords.t
+t/30_search_raw.t
 t/31_search.t
 t/32_search_simple_metadata.t

trunk/lib/OpenGuides/Search.pm

@@ -119 +119 @@
 want to use them in production.
 
+You can also request just the raw search results:
+
+  my %results = $search->run(
+                              os_x    => 528864,
+                              os_y    => 180797,
+                              os_dist => 750,
+                              format  => "raw",
+                            );
+
+Results are returned as a hash, keyed on the page name.  All results
+are returned, not just the first C<page>.  The values in the hash are
+hashes themselves, with the following key/value pairs:
+
+=over 4
+
+=item * name
+
+=item * wgs84_lat - WGS-84 latitude
+
+=item * wgs84_long - WGS-84 longitude
+
+=item * summary
+
+=item * distance - distance (in metres) from origin, if origin exists
+
+=item * score - relevance to search string, if search string exists; higher score means more relevance
+
+=back
 
 In case you're struggling to follow the code, it does the following:
@@ -140 +168 @@
     $self->{return_output}  = $args{return_output}  || 0;
     $self->{return_tt_vars} = $args{return_tt_vars} || 0;
+
+    my $want_raw;
+    if ( $args{format} && $args{format} eq "raw" ) {
+        $want_raw = 1;
+    }
 
     $self->process_params( $args{vars} );
@@ -185 +218 @@
     }
 
-    # If we're not doing a search then just print the search form.
-    unless ( $doing_search ) {
-        return $self->process_template( tt_vars => \%tt_vars );
+    # If we're not doing a search then just print the search form (or return
+    # an empty hash if we were asked for raw results).
+    if ( !$doing_search ) {
+        if ( $want_raw ) {
+            return ( );
+        } else {
+            return $self->process_template( tt_vars => \%tt_vars );
+        }
     }
 
@@ -208 +246 @@
 
     my %results_hash = %{ $self->{results} || [] };
+
+    # If we were asked for just the raw results, return them now, after
+    # grabbing additional info.
+    if ( $want_raw ) {
+        foreach my $node ( keys %results_hash ) {
+            my %data = $self->wiki->retrieve_node( $node );
+            $results_hash{$node}{summary} = $data{metadata}{summary}[0];
+            my $lat  = $data{metadata}{latitude}[0];
+            my $long = $data{metadata}{longitude}[0];
+            my ( $wgs84_lat, $wgs84_long ) = OpenGuides::Utils->get_wgs84_coords( latitude => $lat, longitude => $long, config => $self->config );
+            $results_hash{$node}{wgs84_lat} = $wgs84_lat;
+            $results_hash{$node}{wgs84_long} = $wgs84_long;
+        }
+        return %results_hash;
+    }
+
     my @results = values %results_hash;
     my $numres = scalar @results;
@@ -605 +659 @@
     delete $self->{distance_in_metres};
     delete $self->{search_string};
+    delete $self->{results};
 
     # Strip out any non-digits from distance and OS co-ords.