Firesphere\SolrSearch\Interfaces\SiteStateInterface
Interface SiteStateInterface defines the methods every State altering must implement.
These methods must exist in the SiteStates that are available
Synopsis
interface SiteStateInterface
{
- // methods
- public bool stateIsApplicable()
- public mixed setDefaultState()
- public string|int|null currentState()
- public mixed activateState()
- public mixed updateQuery()
Methods
public
- activateState() — Activate a given state. This should only be done if the state is applicable
- currentState() — Return the current state of the site
- setDefaultState() — Reset the SiteState to it's default state
- stateIsApplicable() — Is this state applicable to this extension E.g. in case of Fluent, the state "SubsiteID1" does not make sense
- updateQuery() — Method to alter the query. Can be no-op.