SearchManager Class Reference

The SearchManager class provides a simple API for searching across all Searchable records in the application database. More...

Public Member Functions
	SearchManager ($results=null)
	search ($params)
	formatResults ()
	doSearch ($params)
	getSearchableClasses ()
	extractDataItems ()
	sortByRelevance ()
	sortByTitle ()
	sortByDate ()
	drawFacets ($id=null)
	showResults ($pageSize=0)

Static Public Member Functions
static	upgradeComponent ($version)
static	setDefaults ()
static	buildSearchMap ()
static	compareRelevance ($item1, $item2)
static	compareTitle ($item1, $item2)
static	compareDate ($item1, $item2)
static	formatSearchResult ($item)
static	wrap ($items, $resultClass)

Public Attributes
	$searchResults
	$useFacetFilter = false
	$displayMode = "list"
	$facetDropdown = true
	$facetMaxWidth = "200px"
	$facetWidth = "200px"
	$facetHeight = "120px"

Static Public Attributes
static	$map

Detailed Description

The SearchManager class provides a simple API for searching across all Searchable records in the application database.

Author

andy

Definition at line 47 of file search_manager.inc.

Member Function Documentation

buildSearchMap()

static SearchManager::buildSearchMap ( )

static

Definition at line 80 of file search_manager.inc.

     {
          if (!SearchManager::$map)
          {
               SearchManager::$map = Cache::get("fakoli_search_map");
          }
          
          if (!SearchManager::$map)
          {
               $map = array();
               $map = ComponentManager::fireEvent("RegisterSearchables", $map);
               Cache::put("fakoli_search_map", $map);
               SearchManager::$map = $map;
          }
     }

compareDate()

static SearchManager::compareDate (   $item1,   $item2  )

static

Definition at line 261 of file search_manager.inc.

     {
          return strtotime($item2->date()) - strtotime($item1->date());
     }

compareRelevance()

static SearchManager::compareRelevance (   $item1,   $item2  )

static

Definition at line 237 of file search_manager.inc.

     {
          return ($item1->relevance() > $item2->relevance())?-1:1;
     }

compareTitle()

static SearchManager::compareTitle (   $item1,   $item2  )

static

Definition at line 249 of file search_manager.inc.

     {
          return strcmp($item1->title(), $item2->title());
     }

doSearch()

SearchManager::doSearch

(

$params

)

Definition at line 152 of file search_manager.inc.

     {
          SearchManager::buildSearchMap();
          
          if (is_object($params))
          {
               $class_array = $_REQUEST["searchable_classes:"];
          }
          else
          {
               $params = trim($params);
          }
          
          $searchResults = array();
          if (!$params)
          {
               $this->searchResults = array();
          }
          else
          {
               trace(print_r(SearchManager::$map, true), 3);
               
               foreach(SearchManager::$map as $component => $searchables)
               {
                    Fakoli::using($component);
                    
                    foreach($searchables as $searchable)
                    {
                         if ($class_array && !array_key_exists($searchable, $class_array)) continue;
                         
                         $obj = new $searchable;
                         $results = $obj->search($params);
                         $searchResults = array_merge($searchResults, $results);
                    }
               }
               
               $this->searchResults = $searchResults;
          }
          
          trace("SEARCH: ".count($searchResults)." results found", 3);
          return $searchResults;
     }

drawFacets()

SearchManager::drawFacets

(

$id = null

)

Definition at line 271 of file search_manager.inc.

     {
          trace("Drawing Facets", 3);
          trace(getBacktrace(0), 3);
          
          global $script;
          if ($this->drawnFacets || !$this->facetManager) return;
          
          if ($id)
          {
               $this->facetManager->id = $id;
          }
          
          $script .= $this->facetManager->writeScript();
          echo $this->facetManager->drawForm();
          
          $this->drawnFacets = true;
     }

extractDataItems()

SearchManager::extractDataItems

(

)

Definition at line 218 of file search_manager.inc.

     {
          $items = array();
          
          foreach($this->searchResults as $result)
          {
               $items[] = $result->item;
          }
          
          return $items;
     }

formatResults()

SearchManager::formatResults

(

)

Definition at line 116 of file search_manager.inc.

     {
          switch($this->displayMode)
          {
               case "table":
                    $this->list = new DataListView($this->extractDataItems(), "search_results");
                    $this->list->emptyMessage = "Your search did not match any items.";
                    $this->list->writeIdTag = true;
                    $this->list->sortable = true;
                    $this->list->filter = false;
                    break;
          
               case "list":
               default:
                    $this->list = new PagedList($this->searchResults, "search_results", array(SearchManager, formatSearchResult));
                    $this->list->emptyList = "Your search did not match any items.";
                    $this->list->writeIdTag = true;
          }
          
          if ($this->enableFacetFilter)
          {
               $this->facetManager = new FacetManager('facet_manager', $this->list);
               $classes = $this->getSearchableClasses();
               trace("Facet Classes: ".implode(", ", $classes), 3);
          
               if ($this->searchResultTypeFacet)
               {
                    $this->facetManager->addFacet("Search Result Types", new SearchResultTypeFacetFilter($this->searchResults));
               }
          
               TaxonomyManager::addFacets($this->facetManager, $classes, $this->facetDropdown, $this->facetMaxWidth, $this->facetWidth, $this->facetHeight);
          }
          
          return $this;
     }

formatSearchResult()

static SearchManager::formatSearchResult (   $item )

static

Definition at line 266 of file search_manager.inc.

     {
          return $item->summary();
     }

getSearchableClasses()

SearchManager::getSearchableClasses

(

)

Definition at line 196 of file search_manager.inc.

     {
          SearchManager::buildSearchMap();
          if (isset($_REQUEST["searchable_classes:"]))
          {
               $class_array = $_REQUEST["searchable_classes:"];
          }
          
          $cl = array();
          
          foreach(SearchManager::$map as $component => $searchables)
          {         
               foreach($searchables as $searchable)
               {
                    if ($class_array && !array_key_exists($searchable, $class_array)) continue;
                    $cl[] = $searchable;
               }
          }
          
          return $cl;
     }

search()

SearchManager::search

(

$params

)

Definition at line 96 of file search_manager.inc.

     {
          $searchResults = array();
 
          $searchHandler = ComponentManager::fireEvent("OverrideSearchHandler");
          
          if ($searchHandler)
          {
               trace("Search Handler: ".get_class($searchHandler), 3);
               $this->searchResults = $searchHandler->search($params, $this);
          }
          else
          {         
               trace("Search Handler: Using built-in SearchManager", 3);
               $this->doSearch($params);
          }
          
          return $this;
     }    

SearchManager()

SearchManager::SearchManager

(

$results = null

)

Definition at line 61 of file search_manager.inc.

     {
          $this->searchResults = $results;
     }

setDefaults()

static SearchManager::setDefaults ( )

static

Definition at line 71 of file search_manager.inc.

     {
          Settings::setDefaultValue("search", "search_result_format", "Combined List", "String", "Specifies the display format to use when displaying results", "", "Combined List\nGrouped by Type");
          Settings::setDefaultValue("search", "results_per_page", "20", "Number", "Specifies the number of results to show per page. Set to zero for no pagination.");
          Settings::setDefaultValue("search", "show_text_fragment", false, "Boolean", "Specifies whether to show with the search results. Note that not all search types will return a text fragment"); 
          
          SearchManager::buildSearchMap();
     }

showResults()

SearchManager::showResults

(

$pageSize = 0

)

Definition at line 290 of file search_manager.inc.

     {
          global $script;
          
          if (!$this->list)
          {
               $this->formatResults();
          }
          
          if ($pageSize == 0) $pageSize = Settings::getValue("search", "results_per_page");
          
          $this->list->pageSize = $pageSize;
          
          $script .= $this->list->writeScript();
          
          $num = count($this->searchResults);
          
          if ($num)
          {
               echo "<p><em>$num ".pluralize("match", $num)." found.</em></p>";
          }
          
          $this->drawFacets();
          
          switch($this->displayMode)
          {
               case "table":
                    $this->list->drawView();
                    break;
                    
               case "list":
               default:
                    $this->list->drawList();
                    break;
          }
     }

sortByDate()

SearchManager::sortByDate

(

)

Definition at line 254 of file search_manager.inc.

     {
          trace("Sorting ".count($this->searchResults)." items by date", 3);
          usort($this->searchResults, array(SearchManager, compareDate));
          return $this;
     }

sortByRelevance()

SearchManager::sortByRelevance

(

)

Definition at line 230 of file search_manager.inc.

     {
          trace("Sorting ".count($this->searchResults)." items by relevance", 3);
          usort($this->searchResults, array(SearchManager, compareRelevance));
          return $this;
     }

sortByTitle()

SearchManager::sortByTitle

(

)

Definition at line 242 of file search_manager.inc.

     {
          trace("Sorting ".count($this->searchResults)." items by title", 3);
          usort($this->searchResults, array(SearchManager, compareTitle));
          return $this;
     }

upgradeComponent()

static SearchManager::upgradeComponent (   $version )

static

Definition at line 66 of file search_manager.inc.

     {
          Cache::invalidate("fakoli_search_map");
     }

wrap()

static SearchManager::wrap (   $items,   $resultClass  )

static

Definition at line 327 of file search_manager.inc.

     {
          $results = array();
 
          if (is_array($items))
          {
               foreach($items as $item)
               {
                    $result = new $resultClass($item);
                    // Store some class metadata in the wrapper record
                    $result->innerClass = get_class($item);
                    $result->prettyClassName = $result->prettifyClassName(true);
                    
                    $results[] = $result;
               }
          }
                    
          return $results;
     }

Member Data Documentation

$displayMode

SearchManager::$displayMode = "list"

Definition at line 53 of file search_manager.inc.

$facetDropdown

SearchManager::$facetDropdown = true

Definition at line 56 of file search_manager.inc.

$facetHeight

SearchManager::$facetHeight = "120px"

Definition at line 59 of file search_manager.inc.

$facetMaxWidth

SearchManager::$facetMaxWidth = "200px"

Definition at line 57 of file search_manager.inc.

$facetWidth

SearchManager::$facetWidth = "200px"

Definition at line 58 of file search_manager.inc.

$map

SearchManager::$map

static

Definition at line 49 of file search_manager.inc.

$searchResults

SearchManager::$searchResults

Definition at line 51 of file search_manager.inc.

$useFacetFilter

SearchManager::$useFacetFilter = false

Definition at line 52 of file search_manager.inc.

---

The documentation for this class was generated from the following file:

• C:/code/cms.sonjara.com/cms/components/search/search_manager.inc