You are here

Home » API reference » Search API Location 7.2

README.txt in Search API Location 7.2

Same filename in this branch
  1. 7.2 README.txt
  2. 7.2 search_api_location_page/README.txt
  3. 7.2 search_api_location_views/README.txt
Search API location views
-------------------------

This module adds location search capabilities to Search API views. It adds both
filters and contextual filters for filtering by proximity to a specified
location.

* Filters

When you're creating a filter on a field that is indexed as "Latitude/longitude"
(and the server's service class supports location searches) the filter will
change to allow filtering based on proximity to a specified location. The
location can be input as text and will be converted to a physical location using
the Geocoder module. As the operator, a radius can be selected, which can also
be exposed to the user like for normal filters. In addition, you have the option
to make the radius a select box instead of a text field.

* Contextual filters

There are three contextual filters:
- LonLat: Here you can fix the radius for the search distance filter. The
  central point argument is then expected as: "LAT,LON", where LAT and LON are
  the decimal latitude and longitude, respectively, of the location. If you have
  the geoPHP module installed, additional accepted formats are: WKT, geoJSON or
  any other format geoPHP accepts.
- LonLat Point: This filter accepts the point for the centre of the search
  distance filter. The same formats as above can be used. If you use this filter
  you must also use the radius filter.
- LonLat Radius: This filter accepts a radius (in km) for the search distance
  filter. This must be used with the point filter.

File

search_api_location_views/README.txt
View source 
  1. Search API location views

  2. -------------------------

  3. 

  4. This module adds location search capabilities to Search API views. It adds both

  5. filters and contextual filters for filtering by proximity to a specified

  6. location.

  7. 

  8. * Filters

  9. 

  10. When you're creating a filter on a field that is indexed as "Latitude/longitude"

  11. (and the server's service class supports location searches) the filter will

  12. change to allow filtering based on proximity to a specified location. The

  13. location can be input as text and will be converted to a physical location using

  14. the Geocoder module. As the operator, a radius can be selected, which can also

  15. be exposed to the user like for normal filters. In addition, you have the option

  16. to make the radius a select box instead of a text field.

  17. 

  18. * Contextual filters

  19. 

  20. There are three contextual filters:

  21. - LonLat: Here you can fix the radius for the search distance filter. The

  22.   central point argument is then expected as: "LAT,LON", where LAT and LON are

  23.   the decimal latitude and longitude, respectively, of the location. If you have

  24.   the geoPHP module installed, additional accepted formats are: WKT, geoJSON or

  25.   any other format geoPHP accepts.

  26. - LonLat Point: This filter accepts the point for the centre of the search

  27.   distance filter. The same formats as above can be used. If you use this filter

  28.   you must also use the radius filter.

  29. - LonLat Radius: This filter accepts a radius (in km) for the search distance

  30.   filter. This must be used with the point filter.