# Class Search

Generic tag-based search engine controller

  AlphaController
  Search implements AlphaControllerInterface

Package: alpha::controller
Copyright: Copyright (c) 2013, John Collins (founder of Alpha Framework). All rights reserved.

    Redistribution and use in source and binary forms, with or
    without modification, are permitted provided that the
    following conditions are met:

    * Redistributions of source code must retain the above
      copyright notice, this list of conditions and the
      following disclaimer.
    * Redistributions in binary form must reproduce the above
      copyright notice, this list of conditions and the
      following disclaimer in the documentation and/or other
      materials provided with the distribution.
    * Neither the name of the Alpha Framework nor the names
      of its contributors may be used to endorse or promote
      products derived from this software without specific
      prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
    CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
    MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
    NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
    OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

License: The BSD License
Author: John Collins <dev@alphaframework.org>
Version: $Id: Search.php 1652 2013-02-26 15:13:13Z alphadevx $
Since: 1.0
Located at controller/Search.php

Methods summary
`public` | # `__construct( string $visibility = 'Public' )` constructor to set up the object constructor to set up the object #### Parameters $visibility `string` $visibility The name of the rights group that can access this controller. #### Since 1.0 #### Overrides `AlphaController::__construct()`
`public` | # `doGET( array $params )` Handle GET requests Handle GET requests #### Parameters $params `array` $params #### Throws ``IllegalArguementException`` #### Since 1.0 #### Implementation of `AlphaControllerInterface::doGET()`
`protected array` | # `doTagSearch( string $query, string $BOName, array $BOIDs = array() )` Searches for tags on the given BO type matching the query provided Searches for tags on the given BO type matching the query provided #### Parameters $query `string` $query $BOName `string` $BOName $BOIDs `array` $BOIDs #### Returns `array` #### Since 1.1
`protected` | # `renderResultList( array $BOIDs, string $BO, string $query = '', boolean $showTags = true, boolean $showScore = false )` Renders the search result list Renders the search result list #### Parameters $BOIDs `array` $BOIDs $BO `string` $BO $query `string` $query $showTags `boolean` $showTags $showScore `boolean` $showScore #### Since 1.0
`public` | # `doPOST( array $params )` Handle POST requests Handle POST requests #### Parameters $params `array` $params #### Since 1.0 #### Implementation of `AlphaControllerInterface::doPOST()`
`public string` | # `after_displayPageHead_callback( )` Displays a search form on the top of the page Displays a search form on the top of the page #### Returns `string` #### Since 1.0
`public string` | # `before_displayPageFoot_callback( )` Method to display the page footer with pageination links Method to display the page footer with pageination links #### Returns `string` #### Since 1.0
`protected string` | # `renderPageLinks( )` Method for rendering the pagination links Method for rendering the pagination links #### Returns `string` #### Since 1.0

Methods inherited from AlphaController
`abort(), accessError(), checkControllerDefExists(), checkIfAccessingFromSecureURL(), checkRights(), checkSecurityFields(), commit(), generateSecurityFields(), getBO(), getCustomControllerName(), getDescription(), getDirtyObjects(), getEndTime(), getFirstJob(), getKeywords(), getLastJob(), getMAXDuration(), getName(), getNewObjects(), getNextJob(), getPreviousJob(), getStartTime(), getStatusMessage(), getTitle(), getUnitDuration(), getVisibility(), loadControllerDef(), loadCustomController(), markDirty(), markNew(), setBO(), setDescription(), setKeywords(), setName(), setStatusMessage(), setTitle(), setUnitEndTime(), setUnitMAXDuration(), setUnitOfWork(), setUnitStartTime(), setVisibility()`

Properties summary
`private static `Logger`` | $logger | `null` | # Trace logger Trace logger #### Since 1.0
`protected integer` | $startPoint | `` | # The start number for list pageination The start number for list pageination #### Since 1.0
`private integer` | $resultCount | `0` | # The result count from the search The result count from the search #### Since 1.0
`private string` | $query | `` | # The search query supplied The search query supplied #### Since 1.0

Properties inherited from AlphaController
`$BO, $description, $dirtyObjects, $firstJob, $keywords, $lastJob, $name, $newObjects, $nextJob, $previousJob, $statusMessage, $title, $unitEndTime, $unitMAXDuration, $unitOfWork, $unitStartTime, $visibility`