FulltextSearchable
class FulltextSearchable extends Extension (View source)
Provides a simple search engine for your site based on the MySQL FULLTEXT index.
Adds the FulltextSearchable extension to data classes, as well as the 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().
Properties
| protected | T | $owner | The object this extension is applied to. |
from Extension |
| protected | string | $searchFields | Comma-separated list of database column names that can be searched on. Used for generation of the database index definitions. |
|
| protected static | array | $searchable_classes |
Methods
Called when this extension is added to a particular class
Temporarily modify the owner. The original owner is ensured to be restored
Clear the current owner, and restore extension to the state prior to the last setOwner()
Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().
Invoke extension point. This will prefer explicit extend prefixed
methods.
Enable the default configuration of MySQL full-text searching on the given data classes.
Shows all classes that had the FulltextSearchable} extension applied through {@link enable().
Details
__construct(array|string $searchFields = [])
No description
static
add_to_class(string $class, string $extensionClass, mixed $args = null)
Called when this extension is added to a particular class
setOwner(object $owner)
Set the owner of this extension.
mixed
withOwner(mixed $owner, callable $callback, array $args = [])
Temporarily modify the owner. The original owner is ensured to be restored
clearOwner()
Clear the current owner, and restore extension to the state prior to the last setOwner()
T
getOwner()
Returns the owner of this extension.
static string
get_classname_without_arguments(string $extensionStr)
Helper method to strip eval'ed arguments from a string that's passed to DataObject::$extensions or Object::add_extension().
mixed
invokeExtension(object $owner, string $method, array ...$arguments)
Invoke extension point. This will prefer explicit extend prefixed
methods.
static
enable(array $searchableClasses = [SiteTree::class, File::class])
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 Object::add_extension() directly:
MyObject::add_extension("FulltextSearchable('MySearchableField,MyOtherField')");Caution: This is a wrapper method that should only be used in _config.php, and only be called once in your code.
static
get_extra_config($class, $extensionClass, $args)
No description
static array
get_searchable_classes()
Shows all classes that had the FulltextSearchable} extension applied through {@link enable().