Nice plugin – I’m already using it (slightly modified).

Hi, I followed your tutorial but I get these errors as soon as I load a page:

Warning (2): include(/Sites/cake/app/plugins/searchable/config/routes.php) [function.include]: failed to open stream: No such file or directory [APP/config/routes.php, line 44]

Warning (2): include() [function.include]: Failed opening ‘Sites/cake/app/plugins/searchable/config/routes.php’ for inclusion (include_path=’/Sites/cake:/Users/ahandley/Sites/cake/app/:.:/Applications/MAMP/bin/php5/lib/php’) [APP/config/routes.php, line 44]

thanks

Great plugin.

Is it possible to search for associated data if it is a HABTM?

@Jasmin, not at the moment, but that would be a good enhancement, feel free to fork the code and have a go, and let me know how you get on.

@unidev, the shell deletes all the records in the search index in the db for the given model before rebuilding them. It does this by calling deleteSearchIndex() on the model. That method is on the SearchableBehavior, but cake will automatically pass it off to the Behavior if the method doesn’t exist in the model but does exist in one of the behaviors that are attached to the model. However, if cake isn’t aware that that method is available directly on the model, or in any behavior that is attached to it, it assumes it is a stored procedure in the db and tries to execute on the db directly – which is what is happening here. What you need to do is figure out why cake does not know that the method is available on the behavior that is attached to your model – sorry, I’m not sure.

@unclezoot, just add logic in the controller action to set conditions based on the logged in user.

Btw, if I remove deleteSearchIndex from the shell script it works.

@Neil, when I put the function in again, it works now. Maybe it has got something todo with an initial empty table or weird database issue?

Using # Server version: 5.0.41
# Protocol version: 10
# Server: Localhost via UNIX socket

with MAMP on MacOS X Leopard

@Nader, sorry, not my area of expertise, but check out the cook book for ajax form submissions and using the RequestHandler component for handling ajax requests.

Nevermind, I got it.

Of course I totally missed it in the comments until just after I posted here. Go Murphy.

[...] Neil Crookes’ Searchable plugin also helped. [...]

@Adam, good work. You’re right, that was unfinished. I’ll take a look at the patch and add it. Thanks.

@Jorge, hmm interesting. Can’t think of any reason why that would be, check the SQL debug queries and copy the one containing MATCH…AGAINST, then run it in your SQL editor and see if you get the same results. If you do, sounds like it could be your MySQL not working correctly, maybe?

Hi again Niel,

I cannot figure out how to do to customize the name and summary field when you said “The search_index table also includes fields for ‘name’ and ’summary’, you can configure which fields in your model are used to populate these fields in the search_index table in the settings array too”.
How and where do I need to write something like ‘name’ => ‘myFieldName’?
I tried putting that in the settings array in diferents ways but never worked.

Thank you very much!

Hi Neil,

Nop, doesn’t work for me.
I tried something like this:

var $actsAs = array(‘Searchable.Searchable’ => array(‘fields’ => array(‘email’, ‘email1′, ‘direccion’), ‘name’ => ‘nombre’));

Then I re run the build_search_index and nothing changes in the name field.

Thanks!

Sorry my bad. I’ve totally misintepreted…plugins… Well now it works

Hi Paul,

Thank you so much for your help!

Hi Neil,

This looks really interesting. Is it (or can it be) compatible with 1.3?

I did some basic test in 1.3 and seems pretty good.

When running the build_search_index shell, I got the following errors:

Warning: array_keys(): The first argument should be an array in /app/plugins/searchable/vendors/shells/build_search_index.php on line 113
Warning: current(): Passed variable is not an array or object in /app/plugins/searchable/vendors/shells/build_search_index.php on line 118

However, the rest of the process continued on as normal:

Possible Models based on your current database:
1. Product
Enter one or more numbers from the list above separated by a space, or type in the names of one or more other models, ‘a’ for all or ‘q’ to exit
[q] > 1

The error was in _setDbConfig(), the $config = get_class_vars(‘DATABASE_CONFIG’) is empty. Didn’t seem to affect the indexing, though, db table was populated with data as expected.

Also, I needed to modify the SearchIndexesController $helpers array by appending the plugin name to the searchable helper. Eg:
var $helpers = array(‘Searchable.Searchable’);

Other than that, seems to work fine. I’ll do some more in-depth testing and let you know of any other issues that come up.

By the way, this is pretty sweet. I was using a modified version of the Zend Lucene search, which is nice, but soooo slow! This is nice and fast to index and query, so that’s nice.

Neil,

I am trying to get this working but when I go to build the search index I am getting the following error

Parse error: syntax error, unexpected T_STRING, expecting T_OLD_FUNCTION or T_FUNCTION or T_VAR or ‘}’ in /home/user/example.com/app/plugins/searchable/vendors/shells/build_search_index.php on line 25

Looking at the build_search_index.php file line 25 is blank line 24 states protected $_useDbConfig;

I am using cakephp 1.2.6

Any help would be greatly appreciated.

Interesting. While my php info tells me I’m running PHP 5.2.12 the php -v states PHP 4.4.9 (cli) (built: Sep 17 2008 12:02:18)

So if I can update my cli then I should be able to run the build_search_index script otherwise I’ll need to make the above modifications?

Neil,

I now have cli 5.2.12 running and can access the Build Search Index Shell. It offers me a choice between either my default database or my test. However Possible Models based on your current database: always returns no results. I have added var $actsAs => array(‘Searchable.Searchable’); to the two models I want searchable. I have also tried to add the names of the models and ‘a’ for all but I still get nothing.

in the example you had:

var $actsAs => array(‘Searchable.Searchable’);

but it should be

var $actsAs = array(‘Searchable.Searchable’);

this might be causing some problems for people

I am having a problem with the plug-in causing some of my links from my default.ctp layout being redirected to the searchable controller. Any idea why this would happen? They point to somewhere that does not exist and therefore I get an error when I click on them.

I have implemented the searchable plug-in to several models in my app, but I can’t for the life of me find out how to do run a search across all those models, all fields.

The Google documentation says to use Model->find(), but how do I pass in the search parameter to find()?

I want the equivalent of:

$this->AllModels->search($mySearchString);

Hey Neil Thanks for the gr8 plugin .
I am tying to modify to support habtm can you help me ?!!!!

tell me can i replace this
if (empty($nonStandardUrlComponents)) {
$url[] = $this->_foreignKey;
$this->SearchIndex->data['SearchIndex']['url'] = json_encode($url);
return;
}

in function setUrl
with
if (empty($nonStandardUrlComponents)) {
$url[] = $foreignKey = $model->getInsertID();
$this->SearchIndex->data['SearchIndex']['url'] = json_encode($url);
return;
}

Hi Avinash, thanks for the comment. To be honest, I haven’t tried it with hasMany or hasAndBelongsToMany. In theory, it could, see SearchableBehavior line 195:

      if (method_exists($model, 'getSearchableData')) {
        $data = $model->getSearchableData($this->_modelData);
      } else {
      .....

You can implement your own getSearchableData() method in your model that the behavior is attached to and get any data you want from within that method. For example, listing the names of the tags that that record is tagged with. Let me know how you get on.

Neil, let me first thank you for the awesome plugin! I’ve noticed something which I believe is intended behavior but wanted to clarify. If I search for the word “browse” and my data contains the word “browser” but not “browse” I get no results; if I search for “browse*” it matches “browser”. How can I get “browse” to match “browser” without the asterisk?

ok, problem solved!

I realized that the strange encoding was json.
for some the search term was not decoded and the data in the table was in json.

So i changed line 50 in search_indexes_controller.php and added the json_ensode function:

$term = Sanitize::escape(json_encode($term));

I wander if the data in the table should have been not in json?…

by the way –
The search does not work for me when i look for strings in english. i assume it has something to do with me using utf-8.

@unidev,
@Nader,

There seems to be an error in:
app/plugins/searchable/models/behaviors/searchable.php and deleteSearchIndex() method.

The problem is with different versions of CakePHP and model method: deleteAll() which returns false or empty array() on empty table.
Before triggering SearchIndex->deleteAll() we need to check for presence of records.
I did something like this:

if(!isset($this->SearchIndex))
$this->SearchIndex = ClassRegistry::init(‘Searchable.SearchIndex’);

$records = $this->SearchIndex->find(‘all’, array(‘conditions’ => $conditions));
if($records === false || (is_array($records) && empty($records)))
return true;
else
return $this->SearchIndex->deleteAll($conditions);

Hi,

I am trying your search plugin and I am getting the error below when running the build-search_index shell:

Parse error: parse error, unexpected T_OBJECT_OPERATOR in /var/www/html/crm/app/vendors/shells/build_search_index.php on line 158

I am using PHP4 and cake 1.2.5

thanks
mb

Hi!

First of all, thank you for the plugin!
Unfortunately I have a problem. I tried cakephp 1.2 and php5, cakephp blog tutorial.
I’ve got a little menu top of the screen (posts, add post, and search link). Everything works fine, except I click on the search link. After the search I get weird links, if I want to click the posts or add post link.
Before the search the links: localhost/blog/posts/ and localhost/blog/posts/add
After the search: localhost/blog/searchable/posts and localhost/blog/seachable/posts/add
And they don’t work. What should I do, to resolve this problem?
Thanks!

@mb, glad you got it working, if you have time, other PHP4 users might benefit from you experiences so please come back and add a comment about what you did

@Neil Crookes,
Everything is working. I can search in both english and in hebrew.
I has to add some addslashes() and stripslashes() because in hebrew some letters contain tags (‘) but now everything in fine!

Thanks again for the plugin!

@Mathias, see comments above, this has already been answered twice. Look for “‘plugin’ => null”.

@Mark hmmm, good question. You’ve probably figured out there is no functionality built-in to allow this. You could probably achieve it quite easily though by adding some elements to the query options. In the search_indexes_controller.php file, lines 52 & 53 add in something like:

$this->paginate['SearchIndex']['fields'] = "*, MATCH(data) AGAINST('$term' IN BOOLEAN MODE) AS score, CASE `model` WHEN 'Venues' THEN 0 WHEN 'Special Events' THEN 0 WHEN 'Listings' THEN 1 END AS mycustomorder";
$this->paginate['SearchIndex']['order'] = "mycustomorder, score DESC";

This is untested, but you get the idea – you add a MySQL case statement to the fields array setting a mycustomorder field to an integer depending on the value of the record’s model field, then in the order by clause, we first order by mycustomorder, then by score.

Let me know how you get on.

Update:
Got the custom ordering to work… I kept on reading about the mysql CASE (wasn’t actually too complicated after all), and then when reviewing the sql I noticed my models were named wrong (plural rather than singular).

The code you provided above works perfectly (as long as the models are spelled correctly of course).

Thanks!

Can anyone offer advice on how to set up a crontab to update the search index? Thanks!

Re: crontabs
Hey Neil, sorry to be a pita, but I cannot figure out how to edit the shell to run automatically. Can you expand on that if/when you get a chance?

It would be ideal to be able to update the index using a cronjob on my production server, and also by simply clicking a link in my admin panel. Is the latter even possible?

Thanks for any insight you can offer.

The plugin is great, there’s one feature I’m missing however.

I’ve Images (id, url, caption, album_id) that belongs to an Album (id, title). Now I’d like to search those images witch respect for their caption, but in search results I’d like name to be taken from the album title field, otherwise it appears as Image.id which is preety ugly (the Image doesn’t have name/title field on their own) :-)

So for an Image sth. like that:
var $actsAs = array(‘Searchable.Searchable’ => array(
‘fields’ => array(‘caption’),
‘name’ => array(‘album_id’ => ‘Album.title’),
‘summary’ => ‘caption’
));

i am getting this error when i try to build index http://variable3.com/files/screenshots/2010-11-08_1255.png

I think I fixed my problem, so It have a new problem, the search plugin is good to find English, but it can’t find any thing by vietnamese :(

Hi Neil – just wanted to say thank you for this plugin. Its really rather good and the comments covered all the modifications i needed, especially the custom ordering solution – very clever.
I’m just getting into CakePHP and this helped alot.

For anyone getting “SQL Error: 1062: Duplicate entry ‘Model-######’ for key ‘model’” errors – Make sure the foreign_key is the same type/length INT as your model’s id column.

I have a table using BIGINT(20) and was getting this error because it truncated the value of the foreign key and caused duplicates.

I’m wondering if it’s possible to improve on the search function so that even if you are searching for part of a word, the result will still show. For example if you search for ‘Car’, any entry in the search index table containing ‘cars’ will be returned.

I am also having trouble setting the ‘name’ and ‘summary’ setting for the search.
For example I want to search through user’s usernames and emails but I only want their usernames to be returned in the search results. The code I have is
‘Searchable.Searchable’ => array((‘fields’ => array(‘username’,'email’)), ‘name’ => ‘username’, ‘summary’ =>’username’),
But the email field still shows in the results and no name is set

Hi Neil,

Apologies if you’ve answered this question previously… Does your plugin require cakephp version 1.3 as this one does: http://cakedc.com/eng/downloads/view/cakephp_search_plugin

Your thoughts would be hugely helpful on this!

Cheers,
N

Ok I figured that out… but whenever I try to search anything (after successful creating and filling my search_index) I get the following errors:

Warning (512): Model “User” is not associated with model “Person” [CORE/cake/libs/model/behaviors/containable.php, line 363]
Warning (2): Cannot modify header information – headers already sent by (output started at /cake/libs/debugger.php:673) [CORE/cake/libs/controller/controller.php, line 742]

I’m using admin routing and wanted to deploy the search plugin in the admin backend. It seems to lose the [SearchIndex] array data coming from the form input. Any clue on why that would happen?

Hey Nail, Terry

I’m having the same problem that terry .

I’m having problems to run the shell to index. Copied the codes over to my app and once I ran the shell, prompted with
Fatal error: Class ‘SearchableAppModel’ not found in …… search_index.php on line 2

Any idea what is really happening? Thanks Neil

Please Help.

Hi Louis G,

Can you tell me how you fixed the shell problem please?

Thanks,

@Jari: You’re probably running the console from the cake directory, while your shell is in the app directory.

Copy your /cake/sonsole to /app/console and try again.

Nvm.. I got it.. Now I’m getting another error when I’m in the shell -

Notice: Undefined index: SearchIndex in /var/www/html/iw4dev2/app/plugins/searchable/models/behaviors/searchable.php on line 385

Warning: array_merge(): Argument #1 is not an array in /var/www/html/iw4dev2/app/plugins/searchable/models/behaviors/searchable.php on line 389

Warning: array_merge(): Argument #1 is not an array in /var/www/html/iw4dev2/app/plugins/searchable/models/behaviors/searchable.php on line 203
Station 157 XETV

Any thoughts?

Hi,

I followed you directions, but now it throws

Error: Class PhpShell could not be loaded.

// Jari

If anyone else is getting Duplicate entry for key ‘model’ errors, I noticed it was happening with multiple saves in some controller actions, which I solved for now by removing the if (!$created) condition in _initialiseSearchIndexData function of the searchable behaviour, which creates some extra db calls but nothing too terrible.