Sunnysideup\SearchSimpleSmart\Forms\SearchEngineBasicForm
Synopsis
class SearchEngineBasicForm
extends Form
{
- // members
- protected bool $isMoreDetailsResult = false;
- protected integer $start = 0;
- protected integer $numberOfResultsPerPage = 10;
- protected integer $totalNumberOfItemsToReturn = 9999;
- protected bool $includeFilter = false;
- protected bool $includeSort = false;
- protected bool $useAutoComplete = false;
- protected bool $updateBrowserHistory = false;
- protected string $displayedFormInputSelector = '';
- protected bool $useInfiniteScroll = false;
- protected bool $outputAsJSON = false;
- protected array $customScript = ;
- protected string $keywords = '';
- protected bool $setLimitToZero = false;
- private static string $jquery_source = 'framework/thirdparty/jquery/jquery.js';
- private static array $sort_by_options = ;
- private static array $filter_for_options = ;
- private static string $full_results_page_type = '';
- private static boolean $_for_template_completed = false;
- // methods
- public SearchEngineBasicForm __construct()
- public void forTemplate()
- public void doSubmitForm()
- public SearchEngineBasicForm setIncludeSort()
- public SearchEngineBasicForm setIncludeFilter()
- public SearchEngineBasicForm setNumberOfResultsPerPage()
- public SearchEngineBasicForm setTotalNumberOfItemsToReturn()
- public SearchEngineBasicForm setIsMoreDetailsResult()
- public SearchEngineBasicForm setStart()
- public SearchEngineBasicForm setUseAutoComplete()
- public SearchEngineBasicForm setUseInfiniteScroll()
- public SearchEngineBasicForm setdisplayedFormInputSelector()
- public SearchEngineBasicForm setOutputAsJSON()
- public SearchEngineBasicForm setUpdateBrowserHistory()
- protected void addFields()
- protected void workOutRequirements()
- protected void workOutResults()
- protected void workOutResultsFilterAndSort()
- protected void workOutResultsPaginated()
- protected array SortByProvider()
- protected array FilterForProvider()
Hierarchy
Extends
- SilverStripe\Forms\Form
Members
private
- $_for_template_completed
- $filter_for_options
—
array
classnames of filters to be used - ClassName - ClassName - ClassName - $full_results_page_type
—
string
class name of the page that is used to show search results. - $jquery_source — string
- $sort_by_options
—
array
classnames of sort classes to be used - ClassName - ClassName - ClassName
protected
- $customScript — array
- $displayedFormInputSelector
—
string
alternative input field selector - $includeFilter — Sunnysideup\SearchSimpleSmart\Forms\bool
- $includeSort — Sunnysideup\SearchSimpleSmart\Forms\bool
- $isMoreDetailsResult — Sunnysideup\SearchSimpleSmart\Forms\bool
- $keywords — string
- $numberOfResultsPerPage — int
- $outputAsJSON — Sunnysideup\SearchSimpleSmart\Forms\bool
- $setLimitToZero — Sunnysideup\SearchSimpleSmart\Forms\bool
- $start
—
int
starting point - $totalNumberOfItemsToReturn — int
- $updateBrowserHistory — Sunnysideup\SearchSimpleSmart\Forms\bool
- $useAutoComplete — Sunnysideup\SearchSimpleSmart\Forms\bool
- $useInfiniteScroll — Sunnysideup\SearchSimpleSmart\Forms\bool
Methods
protected
- FilterForProvider() — returns a list of searchable objects
- SortByProvider()
- addFields()
- workOutRequirements()
- workOutResults()
- workOutResultsFilterAndSort()
- workOutResultsPaginated()
public
- __construct() — this function constructs a new Search Engine Basic Form
- doSubmitForm() — this method submits the Search Engine Form
- forTemplate()
- setIncludeFilter()
- setIncludeSort()
- setIsMoreDetailsResult() — what is the first item to return
- setNumberOfResultsPerPage() — this function sets the number of items to return per page when a search is conducted
- setOutputAsJSON()
- setStart() — what is the first item to return
- setTotalNumberOfItemsToReturn() — total number of items to return
- setUpdateBrowserHistory()
- setUseAutoComplete()
- setUseInfiniteScroll()
- setdisplayedFormInputSelector()