Alpha Framework 3.1.0 API Documentation

SearchProviderInterface

A standard interface used for describing search engine implementations.

Tags
since
1.2.3
author

John Collins dev@alphaframework.org

license

http://www.opensource.org/licenses/bsd-license.php The BSD License

copyright

Copyright (c) 2018, 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.

Table of Contents

delete()  : mixed
Deletes the business object provided from the search engine index.
getNumberFound()  : int
Returns the number of matching objects found in the previous search carried out by this provider.
getRelated()  : array<string|int, mixed>
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).
index()  : mixed
Adds/updates the business object provided to the search engine index.
search()  : array<string|int, mixed>
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).

Methods

getNumberFound()

Returns the number of matching objects found in the previous search carried out by this provider.

public getNumberFound() : int
Tags
since
1.2.3
Return values
int —

getRelated()

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).

public getRelated(ActiveRecord $sourceObject[, string $returnType = 'all' ], int $start[, int $limit = 10 ][, string $distinct = '' ]) : array<string|int, mixed>
Parameters
$sourceObject : ActiveRecord

The source object for comparison.

$returnType : string = 'all'

Use this filter to determine that only business objects of a certain class hould be returned (default is to return all classes indexed).

$start : int

Start point for pagination.

$limit : int = 10

The maximum amount to return in the list (for pagination).

$distinct : string = ''

Related items will only be returned that have distinct values in this named field.

Tags
since
1.2.3
Return values
array<string|int, mixed> —

An array of related business objects.

search()

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).

public search(string $query[, string $returnType = 'all' ], int $start[, int $limit = 10 ], int $createdBy) : array<string|int, mixed>
Parameters
$query : string

The search query.

$returnType : string = 'all'

Use this filter to determine that only business objects of a certain class hould be returned (default is to return all classes indexed).

$start : int

Start point for pagination.

$limit : int = 10

The maximum amount to return in the list (for pagination).

$createdBy : int

Optionally provide the creator ID to restrict search to Tags created by that user.

Tags
since
1.2.3
Return values
array<string|int, mixed> —

An array of matching business objects.

Search results