mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-09-06 01:31:22 +02:00
Config system used to provide an add_static_source method, which was intended for use by Extensions to add statics. But extensions for a class arent initialised until at least one instance of that class is created, so before that the Config system didnt include values from extensions This patch reverses the control flow, so that the Config system explictly asks each Object for its additional config sources via the new method get_extra_config_sources. This method returns an array that can contain string names of classes and also raw associative arrays. The developer visible change is that Extension#add_to_class has been deprecated. Instead there is a new method, get_extra_config, which has the same method signature but needs to guarantee that it doesnt cause side effects. Additionally there is no need to call parent::get_extra_config - this is handled automatically.
100 lines
3.4 KiB
PHP
100 lines
3.4 KiB
PHP
<?php
|
|
/**
|
|
* Provides a simple search engine for your site based on the MySQL FULLTEXT index.
|
|
* Adds the {@link FulltextSearchable} extension to data classes,
|
|
* as well as the {@link ContentControllerSearchExtension} to {@link ContentController}
|
|
* (if the 'cms' module is available as well).
|
|
* (this means you can use $SearchForm in your template without changing your own implementation).
|
|
*
|
|
* CAUTION: Will make all files in your /assets folder searchable by file name
|
|
* unless "File" is excluded from FulltextSearchable::enable().
|
|
*
|
|
* @see http://doc.silverstripe.org/tutorial:4-site-search
|
|
*
|
|
* @package framework
|
|
* @subpackage search
|
|
*/
|
|
class FulltextSearchable extends DataExtension {
|
|
|
|
/**
|
|
* @var String Comma-separated list of database column names
|
|
* that can be searched on. Used for generation of the database index defintions.
|
|
*/
|
|
protected $searchFields;
|
|
|
|
/**
|
|
* @var Array List of class names
|
|
*/
|
|
protected static $searchable_classes;
|
|
|
|
/**
|
|
* Enable the default configuration of MySQL full-text searching on the given data classes.
|
|
* It can be used to limit the searched classes, but not to add your own classes.
|
|
* For this purpose, please use {@link Object::add_extension()} directly:
|
|
* <code>
|
|
* Object::add_extension('MyObject', "FulltextSearchable('MySearchableField,'MyOtherField')");
|
|
* </code>
|
|
*
|
|
* Caution: This is a wrapper method that should only be used in _config.php,
|
|
* and only be called once in your code.
|
|
*
|
|
* @param Array $searchableClasses The extension will be applied to all DataObject subclasses
|
|
* listed here. Default: {@link SiteTree} and {@link File}.
|
|
*/
|
|
static function enable($searchableClasses = array('SiteTree', 'File')) {
|
|
$defaultColumns = array(
|
|
'SiteTree' => 'Title,MenuTitle,Content,MetaTitle,MetaDescription,MetaKeywords',
|
|
'File' => 'Filename,Title,Content'
|
|
);
|
|
|
|
if(!is_array($searchableClasses)) $searchableClasses = array($searchableClasses);
|
|
foreach($searchableClasses as $class) {
|
|
if(!class_exists($class)) continue;
|
|
|
|
if(isset($defaultColumns[$class])) {
|
|
Config::inst()->update($class, 'create_table_options', array('MySQLDatabase' => 'ENGINE=MyISAM'));
|
|
Object::add_extension($class, "FulltextSearchable('{$defaultColumns[$class]}')");
|
|
} else {
|
|
throw new Exception("FulltextSearchable::enable() I don't know the default search columns for class '$class'");
|
|
}
|
|
}
|
|
self::$searchable_classes = $searchableClasses;
|
|
if(class_exists("ContentController")){
|
|
Object::add_extension("ContentController", "ContentControllerSearchExtension");
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param Array|String $searchFields Comma-separated list (or array) of database column names
|
|
* that can be searched on. Used for generation of the database index defintions.
|
|
*/
|
|
function __construct($searchFields = array()) {
|
|
if(is_array($searchFields)) $this->searchFields = implode(',', $searchFields);
|
|
else $this->searchFields = $searchFields;
|
|
|
|
parent::__construct();
|
|
}
|
|
|
|
static function get_extra_config($class, $extensionClass, $args) {
|
|
return array(
|
|
'indexes' => array(
|
|
'SearchFields' => array(
|
|
'type' => 'fulltext',
|
|
'name' => 'SearchFields',
|
|
'value' => $args[0]
|
|
)
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Shows all classes that had the {@link FulltextSearchable} extension applied through {@link enable()}.
|
|
*
|
|
* @return Array
|
|
*/
|
|
static function get_searchable_classes() {
|
|
return self::$searchable_classes;
|
|
}
|
|
|
|
}
|