https://github.com/peterujah/php-search-controller
"Php advance search class for mysql database.
https://github.com/peterujah/php-search-controller
Last synced: about 1 year ago
JSON representation
"Php advance search class for mysql database.
- Host: GitHub
- URL: https://github.com/peterujah/php-search-controller
- Owner: peterujah
- License: mit
- Created: 2021-12-13T12:23:37.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-06-05T00:48:31.000Z (about 2 years ago)
- Last Synced: 2025-03-29T18:18:38.717Z (about 1 year ago)
- Language: PHP
- Homepage: https://github.com/peterujah/PHPSearchController
- Size: 45.9 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PHPSearchController
PHPSearchController is a simple PHP class to search MySQL database, it can build SQL queries to perform MySQL database searches by taking parameters that define database table fields and field values to search.
The class generates SQL conditions used to build SQL queries to perform database searches for records that match the criteria based on the table fields and field values defined by the parameters, It then combines several conditions using SQL operators such as `AND, OR, NAND, LIKE NOR & FIND_IN_SET` and return the appropriate queries for the search.
## Installation
Installation is super-easy via Composer:
```md
composer require peterujah/php-search-controller
```
# Usages
Initialize the class with your preferred search method the default method is `SearchController::OR`.
```php
use Peterujah\NanoBlock\SearchController;
$search = new SearchController();
```
Set your preferred search operator the default is `SearchController::END_WITH_QUERY`.
```php
$search->setOperators(SearchController::HAVE_ANY_QUERY);
```
To perform a database search, you can just build your search query like the one below.
```php
$searchQuery = "PHP Code";
$search->setQuery($searchQuery)->split();
$search->setParameter(array(
'code_title',
'code_description',
'code_info'
));
//var_export($search->getQuery());
```
To search by tag using MySQL `FIND_IN_SET`, build a query like the example below.
```php
$searchQuery = "PHP Code";
$search->setQuery($searchQuery)->split();
$search->setTags("code_tags");
//var_export($search->getQuery());
```
Set the initial query and pass the search query to your MySQL connection
```php
$search->setIniQuery("SELECT * FROM code WHERE id = 1323");
$db->conn()->prepare($search->getQuery());
$db->conn()->execute();
$result = $db->conn()->getAll();
$db->conn()->free();
```
OR build it with other sql queries like the below in your MySQL connection
```php
$db->conn()->prepare("
SELECT * FROM code
{$search->getQuery()}
AND id = 1323
");
$db->conn()->execute();
$result = $db->conn()->getAll();
$db->conn()->free();
```
# Other Methods
Returns the computed sql search queries by checking if the initial query was specified or not to determine which start clause is needed.
```php
$search->getQuery()
```
Set your search keyword
```php
$search->setQuery("Foo Bar")
```
Split search keyword `Foo Bar` into `Foo`, `Bar` as separate search terms
```php
$search->split()
```
Mapping your database column keys to perform a search on
```php
$search->setParameter(array)
```
Set the initial SQL query before appending the search after your query string
```php
$search->setIniQuery('SELECT * FROM ...')
```
# Reference
Specify search operator `$search->setOperators(SearchController::HAVE_ANY_QUERY)`
| Search Operators | Description |
|--------------------------|-----------------------------------------------------------------------------------|
| START_WITH_QUERY | Finds any values that start with "query" |
| END_WITH_QUERY | Finds any values that end with "query" |
| HAVE_ANY_QUERY | Finds any values that have "query" in any position |
| HAVE_SECOND_QUERY | Finds any values that have "query" in the second position |
| START_WITH_QUERY_2LENGTH | Finds any values that start with "query" and are at least 2 characters in length |
| START_WITH_QUERY_3LENGTH | Finds any values that start with "query" and are at least 3 characters in length |
| START_END_WITH_QUERY | Finds any values that start with "query" and ends with "query" |
Initialize search class with a method `new SearchController(SearchController::OR)`
| Search Methods | Description |
|------------------------|-------------------------------------------------------------------------------------|
| OR | Retrieve result with any one of search query |
| AND | Retrieve result with the exact of search quer |
| NAND | Retrieve result without the exact search query |
| NOR | Retrieve result without any on of the search query |