How to create a search functionality with php mysql


Note: I wrote this post first on October , 2007 , nearly 3 years back and since then this post got a lot of audiences. Surely this topic is one of the good ones for the newbies. After reading the responses for this post I saw that users are facing some errors and after a long while I got some time to have a second look. So I have again installed PHP, APACHE, MYSQL and MYSQL WorkBench in my local machine and tested the script like a user. I have found some new bugs and made the modifications accordingly. Now the Script is completely new and tested fully.

To simplify I tried to use some out of box functionality so that one can run the example right away.

For the sample database I have used “SAKILA” database from MySQL. I have only used the “Customer” table for the example, but this can be extended to a bigger example. Hope you’ll find this useful.

First: Install the SAKILA Database to your local MySQL instance. You can download it from here. We will be using the CUSTOMER table. Here is the table for your reference:

CREATE TABLE customer (customer_id SMALLINT UNSIGNED NOT NULL AUTO_INCREMENT,store_id TINYINT UNSIGNED NOT NULL,

first_name VARCHAR(45) NOT NULL,

last_name VARCHAR(45) NOT NULL,

email VARCHAR(50) DEFAULT NULL,

address_id SMALLINT UNSIGNED NOT NULL,

active BOOLEAN NOT NULL DEFAULT TRUE,

create_date DATETIME NOT NULL,

last_update TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,

PRIMARY KEY (customer_id),

KEY idx_fk_store_id (store_id),

KEY idx_fk_address_id (address_id),

KEY idx_last_name (last_name),

CONSTRAINT fk_customer_address FOREIGN KEY (address_id) REFERENCES address (address_id) ON DELETE RESTRICT ON UPDATE CASCADE,

CONSTRAINT fk_customer_store FOREIGN KEY (store_id) REFERENCES store (store_id) ON DELETE RESTRICT ON UPDATE CASCADE

)ENGINE=InnoDB DEFAULT CHARSET=utf8;

 

 

Second: This table already have a lot of data. You can verify it by the simple select command.

Initially it has nearly 599 rows. A very good amount of data to test our code.

In this test we will use the CUSTOMER table and we’ll try to search a particular name from the three columns ‘First Name’, ‘Last Name’ and ‘Email’ and if found we’ll display the data. There are 2 ways to do it. I’ll first explain the easiest way and then a bit more advanced version of it. Both the scripts are tested by me using SAKILA database of MySQL and they are working fine. In case of any problem don’t forget to send me your queries.

So, lets get started.

In the first Example we’ll use a 2 page solution. The first page is the search page which is in plain HTML and will contain a Search box and a Submit button and it will post the data by GET method to the next page called ‘Search.php’

In the first Page, just after the <body> tag of your page, place the following HTML. This is for the form which will contain the textfield to enter our search string in.
<form name=”form” action=”search.php” method=”get”>
<input type=”text” name=”q” />
<input type=”submit” name=”Submit” value=”Search” />
</form>


Now, create a new page called ‘search.php’ and add the following into it. Follow the PHP comments for what the script is doing, if you get stuck, don’t forget to send me your queries!

<?php  // Get the search variable from URL
if(!isset($_GET[‘q’]))
die(“Search Query not found”);$var = $_GET[‘q’];
$trimmed = trim($var); //trim whitespace from the stored variable

// rows to return
$limit=10;

// check for an empty string and display a message.
if ($trimmed == “”){
echo “<p>Please enter a search…</p>”;
exit;
}

// check for a search parameter
if (!isset($var)){
echo “<p>We dont seem to have a search parameter!</p>”;
exit;
}

//connect to your database ** EDIT REQUIRED HERE **
mysql_connect(“localhost”,”username”,”password”);

//specify database ** EDIT REQUIRED HERE **
mysql_select_db(“sakila”) or die(“Unable to select database”);
// Build SQL Query
$query = “select * from customer where first_name like \”%$trimmed%\” or last_name like \”%$trimmed%\” or email like \”%$trimmed%\” order by first_name DESC”;

// EDIT the above SQL query and specify your table and field names

$numresults=mysql_query($query);
$numrows=mysql_num_rows($numresults);

// If we have no results, offer a google search as an alternativethis is optional

if ($numrows == 0)
{
echo “<h4>Results</h4>”;
echo “<p>Sorry, your search: $trimmed returned zero results</p>”;

// google
echo “<p><a href=\”http://www.google.com/search?q=&#8221;
. $trimmed . “\” target=\”_blank\” title=\”Look up
” . $trimmed . ” on Google\”>Click here</a> to try the
search on google</p>”;
}

// next determine if s has been passed to script, if not use ZERO (0) to Limit the output
if (empty($s)) {
$s=0;
}

// get results
$query .= ” limit $s,$limit”;
$result = mysql_query($query) or die(“Couldn’t execute query”);

// display what the person searched for
echo “<p>You searched for: $var </p>”;

// begin to show results set
echo “Results: <br/>”;
$count = 1 + $s ;

// now you can display the results returned
while ($row= mysql_fetch_array($result)) {
$f_name = $row[“first_name”];
$l_name = $row[“last_name”];
$email = $row[“email”];

echo “$count.> $f_name $l_name $email<br/>” ;
$count++ ;
}

$currPage = (($s/$limit) + 1);

//break before paging
echo “<br />”;

// next we need to do the links to other results
if ($s>=1) {

// bypass PREV link if s is 0
$prevs=($s-$limit);
print ” <a href=\”$PHP_SELF?s=$prevs&q=$var\”><<
Prev 10</a>  “;
}

// calculate number of pages needing links
$pages=intval($numrows/$limit);

// $pages now contains int of pages needed unless there is a remainder from division

if ($numrows%$limit) {
// has remainder so add one page
$pages++;
}

// check to see if last page
if (!((($s+$limit)/$limit)==$pages) && $pages!=1) {

// not last page so give NEXT link
$news=$s+$limit;

echo ” <a href=\”$PHP_SELF?s=$news&q=$var\”>Next 10 >></a>”;
}

$a = $s + ($limit) ;
if ($a > $numrows) { $a = $numrows ; }
$b = $s + 1 ;
echo “<p>Showing results $b to $a of $numrows</p>”;

?>

Three major areas are covered in this script, the first is selecting data from the database which matches your entered keyword, the second is displaying the results on the web page and the last is generating the paging, which displays results in chunks of 10 with next/previous links where they are necessary.
Important: This script requires numerous edits before it can be adapted for use. The SQL query in this example is only selecting 1 field from a hypothetical database for the training purpose. Further down the script, the value of that field is being displayed on the page. The major amendments that need to be performed are 1.) The SQL statement, and 2.) The PHP which displays the results.

Lets Look at another example which is a bit complex than the previous one. It uses some PHP inbuilt functions which might be new for you. So I have added some documentation for you:

  • trim() –  Strip whitespace (or other characters) from the beginning and end of a string
  • explode() –  Split a string by string
  • array_unique() –   Removes duplicate values from an array
  • preg_replace() –  Perform a regular expression search and replace

Other functions used include common database access functions like mysql_connect,mysql_num_rows, etc. Please see code comments for more detailed explanation of the script. If you have questions or suggestions please use the comment box on the bottom of the page.

Open your favorite editor and create search.php file as shown below.

<?php//This is a working script

//Make sure to go through it and edit database table fields that you are searching

//This script assumes you are searching 3 fields

$hostname_logon = “localhost” ;

$database_logon = “sakila” ;

$username_logon = “username” ;

$password_logon = “password” ;

//open database connection

$connections = mysql_connect($hostname_logon, $username_logon, $password_logon) or die ( “Unable to connect to the database” );

//select database

mysql_select_db($database_logon) or die ( “Unable to select database!” );

//specify how many results to display per page

$limit = 10;

// Get the search variable from URL

$var = @$_GET[‘q’] ;

//trim whitespace from the stored variable

$trimmed = trim($var);

//separate key-phrases into keywords

$trimmed_array = explode(” “,$trimmed); // check for an empty string and display a message.

if ($trimmed == “”) {

$resultmsg =  “<p>Search Error</p><p>Please enter a search…</p>” ;

}// check for a search parameter

if (!isset($var)){

$resultmsg =  “<p>Search Error</p><p>We don’t seem to have a search parameter! </p>” ;

}

// Build SQL Query for each keyword entered

foreach ($trimmed_array as $trimm){

// EDIT the following SQL Query and specify your table and field names

$query = “SELECT * FROM customer WHERE first_name LIKE \”%$trimm%\” OR last_name LIKE  \”%$trimm%\” OR email LIKE  \”%$trimm%\” ORDER BY first_name DESC” ;

// Execute the query to  get number of rows that contain search kewords

$numresults = mysql_query($query);

$row_num_links_main = mysql_num_rows($numresults);     // next determine if ‘s’ has been passed to script, if not use 0.

// ‘s’ is a variable that gets set as we navigate the search result pages.

if (empty($s)) {

$s=0;

}      // now let’s get results.

$query .= ” LIMIT $s,$limit” ;

$numresults = mysql_query ($query) or die ( “Couldn’t execute query” );

$row= mysql_fetch_array ($numresults);

//store record id of every item that contains the keyword in the array we need to do this to avoid display of duplicate search result.

do{

//EDIT HERE and specify your field name that is primary key

$adid_array[] = $row[ ‘customer_id’ ];

}while( $row= mysql_fetch_array($numresults));

} //end foreach

if($row_num_links_main == 0 && $row_set_num == 0){

$resultmsg = “<p>Search results for: $trimmed </p><p>Sorry, your search returned zero results</p>” ;

}

//delete duplicate record id’s from the array. To do this we will use array_unique function

$tmparr = array_unique($adid_array);

$i=0;

foreach ($tmparr as $v) {

$newarr[$i] = $v;

$i++;

} // now you can display the results returned. But first we will display the search form on the top of the page

?>

<form action=”search.php” method=”get” name=”search”>

<div align=”center”>

<input name=”q” type=”text” value=”<?php echo $var;?>” size=”15″>

<input name=”search” type=”submit” value=”Search”>

</div>

</form>

<?php

// display what the person searched for.

if( isset ($resultmsg)){

echo $resultmsg;

exit();

}else{

echo “Search results for: ” . $var;

}

foreach($newarr as $value){

// EDIT the following SQL Query and specify your table and field names

$query_value = “SELECT * FROM customer WHERE customer_id = ‘$value'”;

$num_value = mysql_query($query_value);

$row_linkcat = mysql_fetch_array($num_value);

$row_num_links = mysql_num_rows($num_value);

//now let’s make the keywods bold. To do that we will use preg_replace function.

//EDIT parts of the lines below that have fields names like $row_linkcat[ ‘field1’ ]

//This script assumes you are searching only 3 fields. If you are searching more fileds make sure that add appropriate line.

$first_name = preg_replace ( “‘($var)’si” , “<b>\\1</b>” , $row_linkcat[ ‘first_name’ ] );

$last_name = preg_replace ( “‘($var)’si” , “<b>\\1</b>” , $row_linkcat[ ‘last_name’ ] );

$email = preg_replace ( “‘($var)’si” , “<b>\\1</b>” , $row_linkcat[ ’email’ ] );

foreach($trimmed_array as $trimm){

if($trimm != ‘b’ ){

//IF you added more fields to search make sure to add them below as well.

$first_name = preg_replace( “‘($trimm)’si” ,  “<b>\\1</b>” , $first_name);

$last_name = preg_replace( “‘($trimm)’si” , “<b>\\1</b>” , $last_name);

$email = preg_replace( “‘($trimm)’si” ,  “<b>\\1</b>” , $email);

}

//end highlight?>

<p>

<?php echo $first_name; ?><br>

<?php echo $last_name; ?><br>

<?php echo $email; ?>

</p>

<?php

}   //end foreach $trimmed_array

if($row_num_links_main > $limit){

// next we need to do the links to other search result pages

if ($s>=1) { // do not display previous link if ‘s’ is ‘0’

$prevs=($s-$limit);

echo “<div align=’left’><a href=’$PHP_SELF?s=$prevs&q=$var&catid=$catid’>Previous ” .$limit. “</a></div>”;

}

// check to see if last page

$slimit =$s+$limit;

if (!($slimit >= $row_num_links_main) && $row_num_links_main!=1) {

// not last page so display next link

$n=$s+$limit;

echo “<div align=’right’><a href=’$PHP_SELF?s=$n&q=$var&catid=$catid’>Next ” .$limit. “</a></div>”;

}

}

}  //end foreach $newarr

?>

The search code is now available for Download. Hope this helps.

Pagination of Data using PHP-MySQL


Pagination of Data (Paging) using PHP (Hyper Text Pre Processor) and MySQL (the great database)

 

Note: I wrote this post first on October , 2007 , nearly 3 years back and since then this post got a lot of audiences. Surely this topic is one of the good ones for the newbies. After reading the responses for this post I saw that users are facing some errors and after a long while I got some time to have a second look. So I have again installed PHP, APACHE, MYSQL and MYSQL WorkBench in my local machine and tested the script like a user. I have found some new bugs and made the modifications accordingly. Now the Script is completely new and tested fully.

To simplify I tried to use some out of box functionality so that one can run the example right away.

For the sample database I have used “SAKILA” database from MySQL. I have only used the “Customer” table for the example, but this can be extended to a bigger example. Hope you’ll find this useful.


First: Install the SAKILA Database to your local MySQL instance. You can download it from here. We will be using the CUSTOMER table. Here is the table for your reference:


CREATE TABLE customer (

customer_id SMALLINT UNSIGNED NOT NULL AUTO_INCREMENT,

store_id TINYINT UNSIGNED NOT NULL,

first_name VARCHAR(45) NOT NULL,

last_name VARCHAR(45) NOT NULL,

email VARCHAR(50) DEFAULT NULL,

address_id SMALLINT UNSIGNED NOT NULL,

active BOOLEAN NOT NULL DEFAULT TRUE,

create_date DATETIME NOT NULL,

last_update TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,

PRIMARY KEY (customer_id),

KEY idx_fk_store_id (store_id),

KEY idx_fk_address_id (address_id),

KEY idx_last_name (last_name),

CONSTRAINT fk_customer_address FOREIGN KEY (address_id) REFERENCES address (address_id) ON DELETE RESTRICT ON UPDATE CASCADE,

CONSTRAINT fk_customer_store FOREIGN KEY (store_id) REFERENCES store (store_id) ON DELETE RESTRICT ON UPDATE CASCADE

)ENGINE=InnoDB DEFAULT CHARSET=utf8;

Second: This table already have a lot of data. You can verify it by the simple select command.

Initially it has nearly 599 rows. A very good amount of data to test our code.

Third: Create and Test this script

Create a file named pagination.php and put the below contents to that file. Upload that file to your local server or main server.

I have uploaded that on my local server where php is running. If you are testing this script elsewhere then change http://localhost with your server host name.

You’ll see that I have used a variable called $page_name to hold the page name with full address. This is because the link to the page is being used multiple times inside the coding. So, only one place to change your page name, rest will be taken care of automatically.


<?php
//Global Variable:
 

$page_name = “http://localhost/pagination.php&#8221;;

//REMEMBER TO CONNECT TO DATABASE!

$link = mysql_connect(‘localhost’,’root’,’rootpassword’)

or die(“Error connecting to Database: ” . mysql_error());

mysql_select_db(‘sakila’) or

die(“Error Selecting Database: ” . mysql_error());

//**EDIT TO YOUR TABLE NAME, ETC.

$t = mysql_query(“SELECT count(*) as cnt FROM customer”);

if(!$t){

die(“Error quering the Database: ” . mysql_error());

}

$a = mysql_fetch_object($t);

$total_items = $a->cnt;

echo “Total Number of records in Database: “.$total_items;

echo “<br/>”;

$limit= (isset($_GET[“limit”])) ? $_GET[“limit”] : 10;

$page= (isset($_GET[“page”]))? $_GET[“page”] : 1;

echo “This is Page Number: ” . $page . “<br/>”;

echo “Current Limit: “. $limit. “<br/>”;

//Set defaults if: $limit is empty, non numerical,

//less than 10, greater than 50

if((!$limit) || (is_numeric($limit) == false)

|| ($limit < 10) || ($limit > 50)) {

$limit = 10; //default

}

//Set defaults if: $page is empty, non numerical,

//less than zero, greater than total available

if((!$page) || (is_numeric($page) == false)

|| ($page < 0) || ($page > $total_items)) {

$page = 1; //default

}

//calculate total pages

$total_pages = ceil($total_items / $limit);

$set_limit = ($page * $limit) – $limit;

echo “Total Pages: $total_pages <br/>”;

//query: **EDIT TO YOUR TABLE NAME, ETC.

$q = mysql_query(“SELECT * FROM customer LIMIT $set_limit, $limit“);

if(!$q) die(mysql_error());

$no_row = mysql_num_rows($q);

if($no_row == 0) die(“No matches met your criteria.”);

//Results per page:

echo(“<br/>Records Per Page:

<a href=$page_name?limit=10&page=1>

10</a> |

<a href=$page_name?limit=25&page=1>

25</a> |

<a href=$page_name?limit=50&page=1>

50</a><br/>

“);

//show data matching query:

while($object = mysql_fetch_object($q)) {

//print your data here.

echo(“<br/>————————————–<br/>”);

echo(“First Name: “.$object->first_name.”<BR/>”);

echo(“Last Name: “.$object->last_name.”<BR/>”);

echo(“Email: “.$object->email.”<BR/>”);

echo(“————————————–<br/>”);

}

//Results Per Page: Same as earlier one

echo(“<br/>Records Per Page:

<a href=$page_name?limit=10&page=1>

10</a> |

<a href=$page_name?limit=25&page=1>

25</a> |

<a href=$page_name?limit=50&page=1>

50</a><br/>

“);

//prev. page

$prev_page = $page – 1;

if($prev_page >= 1) {

echo(“<b><<</b> <a href=$page_name?limit=$limit&page=$prev_page>

<b>Prev.</b></a>”);

}

//Display middle pages:

for($a = 1; $a <= $total_pages; $a++)

{

if($a == $page) {

echo(“<b> $a</b> | “); //no link

}

else {

echo(”

<a href=$page_name?limit=$limit&page=$a> $a

</a> | “);

}

}

//Next page:

$next_page = $page + 1;

if($next_page <= $total_pages) {

echo(”

<a href=$page_name?limit=$limit

&page=$next_page><b>Next</b></a> > >”);

}
//all done
?>

Four: Run this script in browser and see pagination with php and mysql in action.

Explanation: First this script will query the database and get total number of rows by the “SELECT count(*) as cnt FROM customer ” query. It will return the count as cnt. Now get the count and store it in the variable $total_items.

Now get the limit and page number from the GET variables. For the first time both will be null, so by default we will set the limit to 10 and page to 1.

If this variables are not blank, i.e. if the users click on the next or previous or page links then the page number and number of items to displayed will be not null and we will display data accordingly.

If some how this limit and page values are greater than the specified values or less than the specified values we will set them as default.

Now we will calculate how many pages the data will span. i.e. if we select 10 data to displayed at one time and total number of data are 85 then there will be 9 pages and by default the first page will be displayed. In this way if we choose to display 25 data at one time then the total number of pages will be 4, first 3 will display 25 data each and the last will display 10 data.

Hope this tutorial will help you to explore the vast world of pagination using php and mysql.

Kindly send me any queries that you might have.

 

Here is the code to download. Its currently in a Word Document.