FulltextSearchable
class FulltextSearchable extends DataExtension
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().
Properties
| $class | from Extension |
Methods
No description
Called when this extension is added to a particular class
Helper method to strip eval'ed arguments from a string thats passed to {@link DataObject::$extensions} or {@link Object::add_extension()}.
No description
Define extra database fields
This function is used to provide modifications to the form in the CMS by the extension. By default, no changes are made. {@link DataObject->getCMSFields()}.
This function is used to provide modifications to the form used for front end forms. {@link DataObject->getFrontEndFields()}
This is used to provide modifications to the form actions used in the CMS. {@link DataObject->getCMSActions()}.
this function is used to provide modifications to the summary fields in CMS by the extension By default, the summaryField() of its owner will merge more fields defined in the extension's $extra_fields['summary_fields']
this function is used to provide modifications to the fields labels in CMS by the extension By default, the fieldLabels() of its owner will merge more fields defined in the extension's $extra_fields['field_labels']
Enable the default configuration of MySQL full-text searching on the given data classes.
Shows all classes that had the {@link FulltextSearchable} extension applied through {@link enable()}.
Details
at line 75
__construct(Array|String $searchFields = array())
in Extension at line 54
static
add_to_class(string $class, string $extensionClass, mixed $args = null)
Called when this extension is added to a particular class
in Extension at line 66
setOwner(SS_Object $owner, string $ownerBaseClass = null)
Set the owner of this extension.
in Extension at line 74
clearOwner()
in Extension at line 97
static string
get_classname_without_arguments(string $extensionStr)
Helper method to strip eval'ed arguments from a string thats passed to {@link DataObject::$extensions} or {@link Object::add_extension()}.
at line 82
static
get_extra_config($class, $extensionClass, $args)
in DataExtension at line 32
static
unload_extra_statics($class, $extension)
in DataExtension at line 42
validate(ValidationResult $validationResult)
Hook for extension-specific validation.
in DataExtension at line 50
augmentSQL(SQLQuery $query)
Edit the given query object to support queries for this extension
in DataExtension at line 59
augmentDatabase()
Update the database schema as required by this extension.
When duplicating a table's structure, remember to duplicate the create options as well. See {@link Versioned->augmentDatabase} for an example.
in DataExtension at line 67
augmentWrite(array $manipulation)
Augment a write-record request.
in DataExtension at line 70
onBeforeWrite()
in DataExtension at line 73
onAfterWrite()
in DataExtension at line 76
onBeforeDelete()
in DataExtension at line 79
onAfterDelete()
in DataExtension at line 82
requireDefaultRecords()
in DataExtension at line 85
populateDefaults()
in DataExtension at line 88
can($member)
in DataExtension at line 91
canEdit($member)
in DataExtension at line 94
canDelete($member)
in DataExtension at line 97
canCreate($member)
in DataExtension at line 112
array
extraStatics($class = null, $extension = null)
Define extra database fields
Return a map where the keys are db, has_one, etc, and the values are additional fields/relations to be defined.
in DataExtension at line 129
updateCMSFields(FieldList $fields)
This function is used to provide modifications to the form in the CMS by the extension. By default, no changes are made. {@link DataObject->getCMSFields()}.
Please consider using {@link updateFormFields()} to globally add formfields to the record. The method {@link updateCMSFields()} should just be used to add or modify tabs, or fields which are specific to the CMS-context.
Caution: Use {@link FieldList->addFieldToTab()} to add fields.
in DataExtension at line 140
updateFrontEndFields(FieldList $fields)
This function is used to provide modifications to the form used for front end forms. {@link DataObject->getFrontEndFields()}
Caution: Use {@link FieldList->push()} to add fields.
in DataExtension at line 149
updateCMSActions(FieldList $actions)
This is used to provide modifications to the form actions used in the CMS. {@link DataObject->getCMSActions()}.
in DataExtension at line 160
updateSummaryFields(array $fields)
this function is used to provide modifications to the summary fields in CMS by the extension By default, the summaryField() of its owner will merge more fields defined in the extension's $extra_fields['summary_fields']
in DataExtension at line 180
updateFieldLabels(array $labels)
this function is used to provide modifications to the fields labels in CMS by the extension By default, the fieldLabels() of its owner will merge more fields defined in the extension's $extra_fields['field_labels']
at line 44
static
enable(Array $searchableClasses = array('SiteTree', 'File'))
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:
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.
at line 99
static Array
get_searchable_classes()
Shows all classes that had the {@link FulltextSearchable} extension applied through {@link enable()}.