nglasl\extensible\ExtensibleSearchSuggestion
Details of a user search generated suggestion.
@author Nathan Glasl <nathan@symbiote.com.au>
Synopsis
class ExtensibleSearchSuggestion
extends DataObject
implements
PermissionProvider
{
- // members
- private static string $table_name = 'ExtensibleSearchSuggestion';
- private static array $db = ;
- private static array $has_one = ;
- private static string $default_sort = 'Frequency DESC, Term ASC';
- private static array $summary_fields = ;
- private static array $indexes = ;
- private static boolean $enable_suggestions = true;
- private static boolean $automatic_approval = false;
- // methods
- public void providePermissions()
- public void canView()
- public void canEdit()
- public void canCreate()
- public void canDelete()
- public void getTitle()
- public void getCMSFields()
- public void validate()
- public void fieldLabels()
- public void getFrequencySummary()
- public void getFrequencyPercentage()
- public void getApprovedField()
Hierarchy
Extends
- SilverStripe\ORM\DataObject
Implements
- SilverStripe\Security\PermissionProvider
Members
private
-
$automatic_approval
Allow the ability to automatically approve user search generated suggestions. -
$db
Store the frequency to make search suggestion relevance more efficient. - $default_sort
-
$enable_suggestions
Allow the ability to disable search suggestions. - $has_one
- $indexes
- $summary_fields
- $table_name
Methods
public
- canCreate()
- canDelete()
- canEdit()
- canView()
- fieldLabels()
- getApprovedField() — Retrieve the approved field for update purposes.
- getCMSFields()
- getFrequencyPercentage() — Retrieve the frequency percentage.
- getFrequencySummary() — Retrieve the frequency for display purposes.
- getTitle() — Retrieve the search suggestion title.
- providePermissions() — Create a unique permission for management of search suggestions.
- validate() — Confirm that the current search suggestion is valid.