Free Text Search: Search for data taking common words typed by users

Recommend this page to a friend!

Download

Info

Example

Screenshots

Files

Install with Composer

Download

Reputation

Support forum

Blog

Links

Ratings				Unique User Downloads		Download Rankings
Not enough user ratings				Total: 173		All time: 8,802 This week: 47

Version		License		PHP version		Categories
`free-text-search` 1.0.0		Custom (specified...		5		PHP 5, Searching, Parsers

Description

Author

Pierre-Henry Soria

This package can search for data taking common words typed by users.

It takes as parameters a string with common English words types or spoken by the users.

The package sends HTTP requests to the Daft.ie API with the words entered by the users to search for the data he wants.

Innovation Award

June 2019
Number 3

Many people solve their problems by asking questions that express the difficulty they are having to find a solution.

Usually they use natural language in the idiom that they use to define the problem by asking a question.

This package can perform searches for solutions to problems that people may have using the Daft.ie API

This package can search for data taking common words typed by users.

It takes as parameters a string with common English words types or spoken by the users.

The package sends HTTP requests to the Daft.ie API with the words entered by the users to search for the data he wants like for instance finding locations for sale or rent in a given city.

Manuel Lemos

Pierre-Henry Soria

Performance

Level

Name:	Pierre-Henry Soria `<contact>`
Classes:	49 packages by Pierre-Henry Soria
Country:	United Kingdom

Level 1

Innovation award

Nominee: 18x

Winner: 3x

Example


<?php

/**

 * @author           Pierre-Henry Soria <pierrehenrysoria@gmail.com>

 * @copyright        (c) 2015, Pierre-Henry Soria. All Rights Reserved.

 * @license          CC-BY - http://creativecommons.org/licenses/by/3.0/

 * @link             http://hizup.uk

 */



// Hey there! Be careful, the script requires PHP 5.4 or higher ;-)

namespace FreeTextSearch;

use FreeTextSearch\Engine as E;



/* Check if the current PHP version us compatible with the script */

if (version_compare(PHP_VERSION, '5.4.0', '<'))

    exit('Whoops! Your PHP version is ' . PHP_VERSION . '. The script requires PHP 5.4 or higher.');



try

{

    require __DIR__ . '/Engine/Loader.php';

    E\Loader::getInstance()->init(); // Loads necessary classes



    $aParams = ['ctrl' => (!empty($_GET['p']) ? $_GET['p'] : 'main'), 'act' => (!empty($_GET['a']) ? $_GET['a'] : 'index')]; // I use the new PHP 5.4 short array syntax

    E\Router::run($aParams);

}

catch (\Exception $oE)

{

    echo $oE->getMessage();

}

Details

Simple Free Text Property Search

Description

Free Text Search Engine for the Irish Estate Properties using the Daft.ie API.

The Engine translates what the user are looking for and transforms the input string into a string requests and then will send that request to the Daft.ie API.

The script also offers the voice speech recognition thanks HTML5 & JavaScript speech-input.

In this script, I use:

PSR0 to PSR4 coding standards
Formatted/documented code
DRY (Don't Repeat Yourself) principle
OOP code (including PHP Interfaces & Traits (PHP 5.4 specification)
spl_autoload_register (which is very useful with PHP namespaces)
View/Controller pattern
Singleton pattern (even if not necessary...)
PHP alternative syntax for the template (which makes the visibility easier)
Class member access on instantiation (PHP >= 5.4)
Short Array syntax (PHP >= 5.4)
Using SOAPClient

Search Query Examples

2 or 3 bed to rent between 1000 and 2000
3 bedrooms to buy in Dublin
2 or 3 beds apartment to rent in Cork around 400 and 600 euro
4 bedroom house to let in Galway for 1000 around 900 and 14000 per month

Specification

Search Type (Rental/Sale)
Price (Min-Max)
Bedroom (Min-Max)
Property Types (house, apartment, site)
House Types (terraced, semi-detached, detached, end-of-terrace, townhouse)
Retrieve Areas from the API
Retrieve Counties from the API
Each search term has its own Class and is getting back by the "Parser" class and included by spl_autoload_register() SPL function
HTML5 speech-input search
Displayed the property results thanks to Daft's API

Other Coding Convention

In addition of using the PSR and PHP Pear, I use my own for the naming of the variables

Here are the variable prefixes: * a = Array * i = Integer * f = Float, Double * b = Boolean * s = String * o = Object * m = Mixed * r = Resource * c = 1 Character (I used only sometime that, as char is not a PHP valid type)

Following the "letter type lower case, the variable name is in UpperCamelCase (e.g., $aMyVariable)

Server Requirements of the Web App

Application Server PHP 5.4.0 or higher.

PHP Extension SOAPClient

Other Requirements

A Valid Daft API Key

About Me

I'm Pierre-Henry Soria, IT developer and passionate about e-businesses and marketing.

Where to contact me?

You can by email at pierrehenrysoria [[AT]] gmail [[D0T]] com

License

The script is under Creative Commons Attribution 3.0 license or later; See the LICENSE.txt file.

Screenshots (3)

Files (40)

File	Role	Description
`Controller` (2 files)
`Engine` (5 files, 2 directories)
`static` (3 directories)
`View` (3 files, 1 directory)
`index.php`	Example	Example script
`LICENSE.txt`	Lic.	License
`README.md`	Doc.	Documentation
`requirements.txt`	Doc.	Documentation

Files (40)

Controller

File	Role	Description
`Controller.php`	Class	Class source
`Main.php`	Class	Class source

Files (40)

Engine

File	Role	Description
`FreeText` (3 files, 1 directory)
`Pattern` (2 files)
`Config.php`	Class	Class source
`Loader.php`	Class	Class source
`Router.php`	Class	Class source
`Str.php`	Class	Class source
`View.php`	Class	Class source

Files (40)

Engine

FreeText

File	Role	Description
`Type` (8 files)
`Looking.php`	Class	Class source
`Parser.php`	Class	Class source
`Type.php`	Class	Class source

Files (40)

Engine

FreeText

Type

File	Role	Description
`Area.php`	Class	Class source
`Bedroom.php`	Class	Class source
`County.php`	Class	Class source
`HouseType.php`	Class	Class source
`Price.php`	Class	Class source
`Property.php`	Class	Class source
`Rental.php`	Class	Class source
`Sale.php`	Class	Class source

Files (40)

Engine

Pattern

File	Role	Description
`Singleton.php`	Class	Class source
`Stic.php`	Class	Class source

Files (40)

static

File	Role	Description
`css` (4 files)
`img` (1 file)
`js` (3 files)

Files (40)

static

css

File	Role	Description
`bootstrap.css`	Data	Auxiliary data
`general.css`	Data	Auxiliary data
`speech-input.css`	Data	Auxiliary data
`tipsy.css`	Data	Auxiliary data

Files (40)

static

img

File	Role	Description
`daft_logo.gif`	Icon	Icon image

Files (40)

static

File	Role	Description
`general.js`	Data	Auxiliary data
`speech-input.js`	Data	Auxiliary data
`tipsy.js`	Data	Auxiliary data

Files (40)

View

File	Role	Description
`inc` (2 files)
`not_found.tpl.php`	Aux.	Auxiliary script
`result.tpl.php`	Example	Example script
`search_form.tpl.php`	Aux.	Auxiliary script

Files (40)

View

inc

File	Role	Description
`footer.tpl.php`	Aux.	Auxiliary script
`header.tpl.php`	Example	Example script

The PHP Classes site has supported package installation using the Composer tool since 2013, as you may verify by reading this instructions page.

Install with Composer

	free-text-search-2019-06-10.zip 571KB
	free-text-search-2019-06-10.tar.gz 564KB
	Install with Composer

Version Control

Unique User Downloads

Download Rankings

100%

Total:	173
This week:	0

All time:	8,802
This week:	47

Applications that use this package

No pages of applications that use this class were specified.

If you know an application of this package, send a message to the author to add a link here.

About us

Advertise on this site

For more information send a message to info at phpclasses dot org.