modx CMS

AjaxSearch 1.8.3-final | Author: coroico

Updates
AjaxSearch - version 1.8.3

See ajaxSearch_version_183.txt and ajaxSearch_readme.txt in the zip file
Wiki documentation : http://wiki.modxcms.com/index.php/AjaxSearch
Bugs & features tracker : http://svn.modxcms.com/jira/browse/AJAXSEARCH
Demo site : http://www.modx.wangba.fr

Includes the version 1.4.0 of the plugin searchHighlight
and the version 1.4.0 of the plugin advSearchHighlight


--- NEW OPTIONS AND NEW FEATURES ---

==== Adding the number of the result - AJAXSEARCH-34
+as.resultNumber+ placeholder available to display the number of the search result
Use this placeholder inside your result.tpl.html or ajaxResult.tpl.html template

==== Mootools (1.11 or 1.2.1) or Jquery js library

&jscript 'jquery' | 'mootools1.2' | 'mootools'
Set this to jquery if you would like to include the jquery library
set this to mootools1.2 to include the mootools 1.2.1 library (limited to JS functions used by AS)
by default: mootools. This default include the mootools library provided by MODx

e.g: &jscript=`jquery` or &jscript=`mootools1.2`

==== Capturing failed search criteria and search logs

&asLog - ajaxSearch log level : comment : purge

level:
0 : disallow the ajaxSearch log (default)
1 : failed search requests are logged
2 : all ajaxSearch requests are logged

comment:
0 : user comment not allowed (default)
1 : user comment allowed

purge: number of logs allowed before to do an automatic purge of the table
0 : no purge allowed (= illimited number of logs)
default: 200

&asLog=`x` is equivalent to &asLog=`x:0:200`
&asLog=`x:y` is equivalent to &asLog=`x:y:200`

&asLog=`1:1:500` means that 500 failed search requests possibly commented
by the end user could be stored in the ajaxSearch_log table


&tplComment : chunk to style comment form
by default: @FILE:".AS_SPATH.'templates/comment.tpl.html'

The user searches are stored in the database table $modx_table_prefix."ajaxsearch_log". These data are not for the end user only for the site administrator.

The table could be drop without any impacts on the AjaxSearch behaviour. Simply, if the asLog parameter is set and the table inexisting, the table is rebuilt.

==== SearchString metacharacter available with &filter parameter

The metacharacter '#' is replaced by the search string provided by the web user when used with the filter parameter. The advSearch parameter is also taken into account. e.g: &filter=`pagetitle,#,8` with searchString=`school child` and advSearch='oneword' is equivalent to &filter=`pagetitle,school,8|pagetitle,child,8` 'oneword','allwords','nowords' generate as many clause as searchterms. 'exactphrase' generate only one clause with the exactphrase as criterion. Multiple clauses have an "OR" relationship. I.e. a document will be excluded if it meets the criterion of any one clause (clause-1 OR clause-2 OR clause-3, etc.). (see http://ditto.modxcms.com/tutorials/basic_filtering.html)

==== Limit the amount of keywords that will be queried by a search

&maxWords int
Maximum number of words for searching - Default: 5

==== php_mbstring extension

&mbstring 0 | 1
1 - mbstring extension available (default)
0 - don't use php_mbstring extension

The php_mbstring is supposed to be loaded.
If html charset page is "UTF-8", php_mbstring extension should be loaded for language which need a multi-byte representation.
If the extension is not available for the PHP server, some charset like ISO-8859-1 (latin1) could be used.
With UTF-8, a message "Php_mbstring extension is required" when &mbstring=`1` and the extension not loaded.
In this case load the extension or set the mbstring parameter to 0 if you couldn't load the extension


==== Always display paging

&showPagingAlways 1 | 0 (optional)

always display paging. Even if you get only one page.
Set this to `1` if you would like to always show paging.

Two use cases: You are using non-ajax search or when you are using ajax search but you have set up showMoreResults to `1` and you have defined moreResultsPage, then it may happen that ajax search result have only one page and pagination isn't showed
by default : 0

==== searchString available as placeholder

Use to get the search string used for the search.
For instance use "Search results for " as pagetitle for
your landing page.

==== searchHighlight and advSearchHighlight plugins 1.4

Removed useless urldecode calls;
Added check for magic quotes - if set, remove slashes
Highlights terms searched for when target is a HTML entity


-- ISSUES CORRECTED --

AJAXSEARCH-6 : Sort with order and ranking parameters. Results with a wrong order
AJAXSEARCH-12 : Take into account of the &advSearch parameter when the &minChars is checked
AJAXSEARCH-13 : Wrong Highlighting of search terms
AJAXSEARCH-15 : use $modx->getFullTableName('')
AJAXSEARCH-17 : Livesearch - start of the search only when the minimum character is reached
AJAXSEARCH-18 : function stripHtml incorrectly works
AJAXSEARCH-19 : Parse error if the user enters two or more spaces between words in the query
AJAXSEARCH-21 : search for something like "ecuador span"
AJAXSEARCH-22 : you get a TV value with tvPHX, only if the search has found your term in the TV
AJAXSEARCH-24 : AjaxSearch stops searching through TV content after a certain number of characters
AJAXSEARCH-25 : Security issue with AS_offset
AJAXSEARCH-26 : If the offset exceeds the number of documents retrieved, modx crashes
AJAXSEARCH-27 : AjaxSearch and Document Group permissions
AJAXSEARCH-29 : When using french UTF8 or english UTF8, I get a blank line at the top of the search
AJAXSEARCH-30 : htmlspecialchars() expects at most 3 parameters, 4 given
AJAXSEARCH-31 : parse error with AjaxSearch 1.8.2 when the search has no results and filter parameter used
AJAXSEARCH-32 : pages not to validate as XHTML
AJAXSEARCH-33 : preg_match fails with Segmentation Fault on capturing subpattern

Download

• ajaxsearch183.rev5114.zip (155 downloads)