File: README.md

Recommend this page to a friend!

README.md

File:	`README.md`
Role:	Documentation
Content type:	`text/markdown`
Description:	Documentation
Class:	Advanced PHP MySQL Search Controller Compose SQL to perform MySQL database searches
Author:	By Ujah Chigozie peter
Last change:	Update README.md Update README.md
Date:	8 months ago
Size:	`4,360 bytes`

Download

PHPSearchController

PHPSearchController is a simple php class to search mysql database, it can build SQL query to perform MySQL database searches by takeing 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 combine 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:

composer require peterujah/php-search-controller

Usages

Initialize the class with your preferred search method the default method is SearchController::OR.

use Peterujah\NanoBlock\SearchController;
$search = new SearchController();

Set your preferred search operator the default is SearchController::END_WITH_QUERY.

$search->setOperators(SearchController::HAVE_ANY_QUERY);

To perform a database search build the search query like below.

$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 query like example below.

$searchQuery = "PHP Code";
$search->setQuery($searchQuery)->split();
$search->setTags("code_tags");
//var_export($search->getQuery());

Set inital query and pass search query to your mysql connection

$search->setSQLQuery("SELECT * FROM code WHERE id = 1323");
$db->conn()->prepare($search->getAndQuery());
$db->conn()->execute();		
$resault = $db->conn()->getAll();
$db->conn()->free();

OR bulid it with other sql query like below in your mysql connection

$db->conn()->prepare("
    SELECT * FROM code 
    {$search->getWhereQuery()}
    AND id = 1323
");
$db->conn()->execute();		
$resault = $db->conn()->getAll();
$db->conn()->free();

Other Methods

Returns the computed sql search queries by checking if initial query was specified or not to determine which start clause is needed.

$search->getQuery()

Returns the computed search queries by using AND as the start clause.

$search->getAndQuery()

Returns the computed search queries by using WHERE as the start clause.

$search->getWhereQuery()

Refrence

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" |

Initalise 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 |