Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rapidwebltd/search
🔍 Search allows you to easily add an intelligent search engine to your website or web application.
https://github.com/rapidwebltd/search
php php-library search search-engine
Last synced: about 1 month ago
JSON representation
🔍 Search allows you to easily add an intelligent search engine to your website or web application.
- Host: GitHub
- URL: https://github.com/rapidwebltd/search
- Owner: rapidwebltd
- License: lgpl-3.0
- Created: 2017-07-19T12:13:51.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-04-19T15:15:06.000Z (over 1 year ago)
- Last Synced: 2024-08-16T22:45:12.187Z (4 months ago)
- Topics: php, php-library, search, search-engine
- Language: PHP
- Homepage:
- Size: 20.5 KB
- Stars: 2
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Search
Search allows you to easily add an intelligent search engine to your website or web application.
It can be configured to search any database table.
## Installation
You can install this package with Composer.
```
composer require rapidwebltd/search
```
## Usage
Using Search is easy. Take a look at the following example.
```php
use \RapidWeb\Search\Search;
// Setup your database connection.
// If you already have a connection setup, you can skip this step.
$pdo = new PDO('mysql:dbname=database_name;host=127.0.0.1', 'username', 'password');
// Create a new Search object
$search = new Search;
// Configure the Search object
$search->setDatabaseConnection($pdo)
->setTable('products')
->setPrimaryKey('product_groupid')
->setFieldsToSearch(['product_name', 'product_description', 'product_seokeywords'])
->setConditions(['product_live' => 1]);
// Perform a search for 'test product', limited to top 10 results
$results = $search->query('test product', 10);
// Output results
var_dump($results);
```
The results are returned as a `SearchResults` object, as shown below, containing an array of `SearchResult` objects.
This `SearchResults` object also contains various statistics such as the highest, lowest and average relevances,
and the time taken to perform the search.
Each `SearchResult` object in the array provides the primary key `id` and its `relevance`. The `relevance` is
simply a number that is higher on more relevant results. The array is sorted by relevance descending.
```php
object(RapidWeb\Search\SearchResults)#731 (5) {
["results"]=>
array(10) {
[0]=>
object(RapidWeb\Search\SearchResult)#588 (2) {
["id"]=>
int(80)
["relevance"]=>
float(637.80198499153)
}
/** ... snipped ... */
[9]=>
object(RapidWeb\Search\SearchResult)#597 (2) {
["id"]=>
int(18469)
["relevance"]=>
float(121.65783596237)
}
}
["highestRelevance"]=>
float(637.80198499153)
["lowestRelevance"]=>
float(121.65783596237)
["averageRelevance"]=>
float(336.74613218217)
["time"]=>
float(0.33661985397339)
}
```
### Caching Source Data
To speed up searching, you can cache the source data using any PSR-6 compliant cache pool. An example of this is shown below.
```php
// Create cache pool
$filesystemAdapter = new Local(storage_path().'/search-cache/');
$filesystem = new Filesystem($filesystemAdapter);
$cacheItemPool = new FilesystemCachePool($filesystem);
// Set cache expiry time
$cacheExpiryInSeconds = 300;
// Create a new Search object
$search = new Search;
// Configure the Search object
$search->setDatabaseConnection($pdo)
->setTable('products')
->setPrimaryKey('product_groupid')
->setFieldsToSearch(['product_name'])
->setCache($cacheItemPool, $cacheExpiryInSeconds); // Setup cache
```