2007-07-19 12:40:28 +02:00
< ? php
2008-02-25 03:10:37 +01:00
/**
2008-08-06 04:43:46 +02:00
* Standard basic search form which conducts a fulltext search on all { @ link SiteTree }
* objects .
2009-01-19 03:18:41 +01:00
*
* If multilingual content is enabled through the { @ link Translatable } extension ,
* only pages the currently set language on the holder for this searchform are found .
* The language is set through a hidden field in the form , which is prepoluated
2009-05-14 08:05:48 +02:00
* with { @ link Translatable :: get_current_locale ()} when then form is constructed .
2008-08-06 04:43:46 +02:00
*
2008-09-26 06:35:29 +02:00
* @ see Use ModelController and SearchContext for a more generic search implementation based around DataObject
2008-02-25 03:10:37 +01:00
* @ package sapphire
* @ subpackage search
*/
2007-07-19 12:40:28 +02:00
class SearchForm extends Form {
2008-12-04 23:38:32 +01:00
/**
* @ var int $pageLength How many results are shown per page .
2008-11-22 04:33:00 +01:00
* Relies on pagination being implemented in the search results template .
*/
2008-12-04 23:38:32 +01:00
protected $pageLength = 10 ;
2008-11-22 04:33:00 +01:00
2009-02-02 00:49:53 +01:00
/**
* Classes to search
*/
2009-06-05 05:44:28 +02:00
static public $classesToSearch = " SiteTree,File " ;
2009-02-02 00:49:53 +01:00
2008-11-22 04:33:00 +01:00
/**
*
* @ param Controller $controller
* @ param string $name The name of the form ( used in URL addressing )
* @ param FieldSet $fields Optional , defaults to a single field named " Search " . Search logic needs to be customized
* if fields are added to the form .
* @ param FieldSet $actions Optional , defaults to a single field named " Go " .
*/
2009-05-20 09:30:02 +02:00
function __construct ( $controller , $name , $fields = null , $actions = null ) {
2007-07-19 12:40:28 +02:00
if ( ! $fields ) {
2008-11-11 22:16:51 +01:00
$fields = new FieldSet (
new TextField ( 'Search' , _t ( 'SearchForm.SEARCH' , 'Search' )
));
2007-07-19 12:40:28 +02:00
}
2008-11-11 22:16:51 +01:00
2009-04-01 18:35:32 +02:00
if ( singleton ( 'SiteTree' ) -> hasExtension ( 'Translatable' )) {
2009-05-14 08:05:48 +02:00
$fields -> push ( new HiddenField ( 'locale' , 'locale' , Translatable :: get_current_locale ()));
2009-01-19 03:18:41 +01:00
}
2007-07-19 12:40:28 +02:00
if ( ! $actions ) {
$actions = new FieldSet (
2008-02-25 03:10:37 +01:00
new FormAction ( " getResults " , _t ( 'SearchForm.GO' , 'Go' ))
2007-07-19 12:40:28 +02:00
);
}
parent :: __construct ( $controller , $name , $fields , $actions );
2007-10-28 22:44:38 +01:00
2008-12-04 23:38:32 +01:00
$this -> setFormMethod ( 'get' );
2007-10-28 22:44:38 +01:00
$this -> disableSecurityToken ();
2007-07-19 12:40:28 +02:00
}
2008-12-04 23:38:32 +01:00
public function forTemplate () {
2008-11-11 22:16:51 +01:00
return $this -> renderWith ( array (
'SearchForm' ,
'Form'
));
2007-07-19 12:40:28 +02:00
}
2009-02-02 00:49:53 +01:00
/**
* Set the classes to search .
* Currently you can only choose from " SiteTree " and " File " , but a future version might improve this .
*/
function classesToSearch ( $classes ) {
$illegalClasses = array_diff ( $classes , array ( 'SiteTree' , 'File' ));
if ( $illegalClasses ) {
user_error ( " SearchForm::classesToSearch() passed illegal classes ' " . implode ( " ', ' " , $illegalClasses ) . " '. At this stage, only File and SiteTree are allowed " , E_USER_WARNING );
}
$legalClasses = array_intersect ( $classes , array ( 'SiteTree' , 'File' ));
$this -> classesToSearch = $legalClasses ;
}
2007-07-19 12:40:28 +02:00
/**
* Return dataObjectSet of the results using $_REQUEST to get info from form .
2008-11-22 04:33:00 +01:00
* Wraps around { @ link searchEngine ()} .
*
2008-12-04 23:38:32 +01:00
* @ param int $pageLength DEPRECATED 2.3 Use SearchForm -> pageLength
2008-11-22 04:33:00 +01:00
* @ param array $data Request data as an associative array . Should contain at least a key 'Search' with all searched keywords .
* @ return DataObjectSet
2007-07-19 12:40:28 +02:00
*/
2008-12-04 23:38:32 +01:00
public function getResults ( $pageLength = null , $data = null ){
2008-11-22 04:33:00 +01:00
// legacy usage: $data was defaulting to $_REQUEST, parameter not passed in doc.silverstripe.com tutorials
2009-06-05 05:44:28 +02:00
if ( ! isset ( $data ) || ! is_array ( $data )) $data = $_REQUEST ;
2009-01-19 03:18:41 +01:00
// set language (if present)
2009-04-01 18:35:32 +02:00
if ( singleton ( 'SiteTree' ) -> hasExtension ( 'Translatable' ) && isset ( $data [ 'locale' ])) {
2009-05-14 08:05:48 +02:00
$origLocale = Translatable :: get_current_locale ();
2009-05-17 07:36:01 +02:00
Translatable :: set_current_locale ( $data [ 'locale' ]);
2009-01-19 03:18:41 +01:00
}
2008-11-22 04:33:00 +01:00
$keywords = $data [ 'Search' ];
2007-07-19 12:40:28 +02:00
$andProcessor = create_function ( '$matches' , '
return " + " . $matches [ 2 ] . " + " . $matches [ 4 ] . " " ;
' );
$notProcessor = create_function ( '$matches' , '
return " - " . $matches [ 3 ];
' );
$keywords = preg_replace_callback ( '/()("[^()"]+")( and )("[^"()]+")()/i' , $andProcessor , $keywords );
$keywords = preg_replace_callback ( '/(^| )([^() ]+)( and )([^ ()]+)( |$)/i' , $andProcessor , $keywords );
$keywords = preg_replace_callback ( '/(^| )(not )("[^"()]+")/i' , $notProcessor , $keywords );
$keywords = preg_replace_callback ( '/(^| )(not )([^() ]+)( |$)/i' , $notProcessor , $keywords );
$keywords = $this -> addStarsToKeywords ( $keywords );
if ( strpos ( $keywords , '"' ) !== false || strpos ( $keywords , '+' ) !== false || strpos ( $keywords , '-' ) !== false || strpos ( $keywords , '*' ) !== false ) {
2009-06-05 05:44:28 +02:00
$results = DB :: GetConn () -> searchEngine ( $keywords , $pageLength , " Relevance DESC " , " " , true );
2007-07-19 12:40:28 +02:00
} else {
2009-06-05 05:44:28 +02:00
$results = DB :: GetConn () -> searchEngine ( $keywords , $pageLength );
2008-11-22 04:33:00 +01:00
}
// filter by permission
if ( $results ) foreach ( $results as $result ) {
if ( ! $result -> canView ()) $results -> remove ( $result );
}
2009-05-04 04:51:33 +02:00
// reset locale
if ( singleton ( 'SiteTree' ) -> hasExtension ( 'Translatable' ) && isset ( $data [ 'locale' ])) {
2009-05-17 07:36:01 +02:00
Translatable :: set_current_locale ( $origLocale );
2009-05-04 04:51:33 +02:00
}
2008-11-22 04:33:00 +01:00
return $results ;
2007-07-19 12:40:28 +02:00
}
2008-11-22 04:33:00 +01:00
protected function addStarsToKeywords ( $keywords ) {
2007-07-19 12:40:28 +02:00
if ( ! trim ( $keywords )) return " " ;
// Add * to each keyword
$splitWords = split ( " + " , trim ( $keywords ));
while ( list ( $i , $word ) = each ( $splitWords )) {
if ( $word [ 0 ] == '"' ) {
while ( list ( $i , $subword ) = each ( $splitWords )) {
$word .= ' ' . $subword ;
if ( substr ( $subword , - 1 ) == '"' ) break ;
}
} else {
$word .= '*' ;
}
$newWords [] = $word ;
}
return implode ( " " , $newWords );
}
2008-11-22 04:33:00 +01:00
/**
* Get the search query for display in a " You searched for ... " sentence .
*
* @ param array $data
* @ return string
*/
public function getSearchQuery ( $data = null ) {
// legacy usage: $data was defaulting to $_REQUEST, parameter not passed in doc.silverstripe.com tutorials
if ( ! isset ( $data )) $data = $_REQUEST ;
return Convert :: raw2xml ( $data [ 'Search' ]);
2007-07-19 12:40:28 +02:00
}
2008-12-04 23:38:32 +01:00
/**
* Set the maximum number of records shown on each page .
*
* @ param int $length
*/
public function setPageLength ( $length ) {
$this -> pageLength = $length ;
}
/**
* @ return int
*/
public function getPageLength () {
2009-05-20 08:13:53 +02:00
return $this -> pageLength ;
2008-12-04 23:38:32 +01:00
}
2007-07-19 12:40:28 +02:00
}
2009-02-02 00:49:53 +01:00
?>