Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chris48s/cakephp-searchable
:cake: A CakePHP 3 behavior for creating MySQL MATCH() AGAINST() queries :mag:
https://github.com/chris48s/cakephp-searchable
cakephp fulltext-indexes mysql
Last synced: 24 days ago
JSON representation
:cake: A CakePHP 3 behavior for creating MySQL MATCH() AGAINST() queries :mag:
- Host: GitHub
- URL: https://github.com/chris48s/cakephp-searchable
- Owner: chris48s
- License: mit
- Created: 2016-02-28T13:37:21.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-04-20T07:02:12.000Z (over 2 years ago)
- Last Synced: 2024-08-21T22:32:30.583Z (3 months ago)
- Topics: cakephp, fulltext-indexes, mysql
- Language: PHP
- Homepage: https://packagist.org/packages/chris48s/cakephp-searchable
- Size: 24.4 KB
- Stars: 4
- Watchers: 7
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
[](https://travis-ci.org/chris48s/cakephp-searchable)
[](https://coveralls.io/github/chris48s/cakephp-searchable?branch=master)
# CakePHP Searchable Behavior Plugin
A CakePHP 3 Behavior for creating MySQL [MATCH() AGAINST() queries](https://dev.mysql.com/doc/refman/5.6/en/fulltext-search.html).
CakePHP-Searchable adds a custom `find('matches')` method to your CakePHP models, alleviating the need to pass raw SQL into your queries. It is safe against SQL injection and uses a query syntax which is consistent with the conventions of CakePHP's ORM.
## Installation
Install from [packagist](https://packagist.org/packages/chris48s/cakephp-searchable) using [composer](https://getcomposer.org/).
Add the following to your `composer.json`:
```
"require": {
"chris48s/cakephp-searchable": "^2.0.0"
}
```
and run `composer install` or `composer update`, as applicable.
## Database Support
In order to use FULLTEXT indexes on InnoDB tables, you must be using MySQL >=5.6.4. Earlier versions only allow use of FULLTEXT indexes on MyISAM tables.
## Usage
### Loading the plugin
Add the code `Plugin::load('Chris48s/Searchable');` to your `bootstrap.php`.
### Using the Behavior
Add the behavior in your table class.
```php
addBehavior('Chris48s/Searchable.Searchable');
}
}
```
### Querying data
Having added the behavior to a table class, you now have access to the query method `find('matches')`, which you can use to construct MATCH() AGAINST() queries. For example:
```php
find('matches', [
[
'match' => 'textcol1',
'against' => 'foo'
],
[
'match' => 'textcol2, textcol3',
'against' => '+foo bar*',
'mode' => 'IN BOOLEAN MODE'
]
]);
```
Available modes are:
* `'IN NATURAL LANGUAGE MODE'`
* `'IN BOOLEAN MODE'`
* `'WITH QUERY EXPANSION'`
* `'IN NATURAL LANGUAGE MODE WITH QUERY EXPANSION'`
When using boolean mode, some [additional operators](https://dev.mysql.com/doc/refman/5.6/en/fulltext-boolean.html) are available.
The method `find('matches')` returns a CakePHP query object, so you can chain
additional methods on to this (e.g: `->where()`, `->order()`, `->limit()`, etc).
## Error Handling
If the keys `'match'` or `'against'` are not set, or if any of the columns contained in the column list are not of type `string` or `text`, an exception of class `SearchableException` will be thrown.
## Reporting Issues
If you have any issues with this plugin then please feel free to create a new [Issue](https://github.com/chris48s/cakephp-searchable/issues) on the [GitHub repository](https://github.com/chris48s/cakephp-searchable). This plugin is licensed under the MIT Licence.