# Interface SearchProviderInterface

A standard interface used for describing search engine implementations.

#### Direct known implementers

SearchProviderTags
Package: alpha::util::search
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: SearchProviderInterface.inc 1701 2013-12-18 22:33:25Z alphadevx $
Since: 1.2.3
Located at util/search/SearchProviderInterface.inc

Methods summary
`public array` | # `search( string $query, string $returnType = 'all', integer $start = 0, integer $limit = 10 )` The main search function, you should provide the user's search query as-is and pass it to the search engine. An array of business objects will be returned (ordered by the search engine). The main search function, you should provide the user's search query as-is and pass it to the search engine. An array of business objects will be returned (ordered by the search engine). #### Parameters $query `string` $query The search query. $returnType `string` $returnType Use this filter to determine that only business objects of a certain class hould be returned (default is to return all classes indexed). $start `integer` $start Start point for pagination. $limit `integer` $limit The maximum amount to return in the list (for pagination). #### Returns `array` An array of matching business objects. #### Since 1.2.3
`public array` | # `getRelated( `AlphaDAO` $sourceObject, string $returnType = 'all', integer $start = 0, integer $limit = 10 )` Gets a list of documents related to the business objects matching the object provided. An array of business objects will be returned (ordered by the search engine). Gets a list of documents related to the business objects matching the object provided. An array of business objects will be returned (ordered by the search engine). #### Parameters $sourceObject ``AlphaDAO`` $sourceObject The source object for comparison. $returnType `string` $returnType Use this filter to determine that only business objects of a certain class hould be returned (default is to return all classes indexed). $start `integer` $start Start point for pagination. $limit `integer` $limit The maximum amount to return in the list (for pagination). #### Returns `array` An array of related business objects. #### Since 1.2.3
`public` | # `index( `AlphaDAO` $sourceObject )` Adds/updates the business object provided to the search engine index. Adds/updates the business object provided to the search engine index. #### Parameters $sourceObject ``AlphaDAO`` $sourceObject The object to add to the search index. The sourceObject should already be stored in the database. #### Throws ``SearchIndexWriteException`` #### Since 1.2.3
`public` | # `delete( `AlphaDAO` $sourceObject )` Deletes the business object provided from the search engine index. Deletes the business object provided from the search engine index. #### Parameters $sourceObject ``AlphaDAO`` $sourceObject The object to delete from the search index. #### Throws ``SearchIndexWriteException`` #### Since 1.2.3
`public integer` | # `getNumberFound( )` Returns the number of matching objects found in the previous search carried out by this provider. Returns the number of matching objects found in the previous search carried out by this provider. #### Returns `integer` #### Since 1.2.3