SearchEvent
- Type
- Class
- Namespace
- craft\events
- Inherits
- craft\events\SearchEvent » yii\base\Event (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 3.0.0
SearchEvent class.
View source (opens new window)
# Public Properties
# elementIds
- Type
- integer (opens new window)[], null (opens new window)
- Default value
null
View source (opens new window)
# elementQuery
- Type
- craft\elements\db\ElementQuery
- Default value
null- Since
- 3.7.14
The element query being executed.
View source (opens new window)
# query
- Type
- craft\search\SearchQuery
- Default value
null
The search query
View source (opens new window)
# results
- Type
- array (opens new window), null (opens new window)
- Default value
null- Since
- 3.6.0
The raw search result data
This will only be set ahead of time for craft\services\Search::EVENT_BEFORE_SCORE_RESULTS and craft\services\Search::EVENT_AFTER_SEARCH.
If an event handler modifies this from craft\services\Search::EVENT_BEFORE_SCORE_RESULTS, then craft\services\Search::searchElements() will score the results set on the event rather than the original results.
View source (opens new window)
# scores
- Type
- array (opens new window), null (opens new window)
- Default value
null- Since
- 4.3.0
The result scores, indexed by element ID
This will only be set ahead of time for craft\services\Search::EVENT_AFTER_SEARCH.
If an event handler sets this from craft\services\Search::EVENT_BEFORE_SCORE_RESULTS or modifies it from craft\services\Search::EVENT_AFTER_SEARCH, then craft\services\Search::searchElements() will return its value rather than calculate the result scores itself.
View source (opens new window)
# siteId
- Type
- integer (opens new window), integer (opens new window)[], null (opens new window)
- Default value
null
The site ID(s) to filter by
View source (opens new window)
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __construct() (opens new window) | Constructor. |
| __get() (opens new window) | Returns the value of an object property. |
| __isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
| __set() (opens new window) | Sets value of an object property. |
| __unset() (opens new window) | Sets an object property to null. |
| canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
| canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
| className() (opens new window) | Returns the fully qualified name of this class. |
| hasHandlers() (opens new window) | Returns a value indicating whether there is any handler attached to the specified class-level event. |
| hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
| hasProperty() (opens new window) | Returns a value indicating whether a property is defined. |
| init() (opens new window) | Initializes the object. |
| off() (opens new window) | Detaches an event handler from a class-level event. |
| offAll() (opens new window) | Detaches all registered class-level event handlers. |
| on() (opens new window) | Attaches an event handler to a class-level event. |
| trigger() (opens new window) | Triggers a class-level event. |