Class craft\events\SearchEvent
- Inheritance
- craft\events\SearchEvent » yii\base\Event » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Available since version
- 3.0
- Source Code
- https://github.com/craftcms/cms/blob/master/src/events/SearchEvent.php
SearchEvent class.
| Property | Type | Description | Defined By |
|---|---|---|---|
$data |
mixed | The data that is passed to yii\base\Component::on() when attaching an event handler. | yii\base\Event |
$elementIds |
integer[] | The list of element IDs to filter by the search query, or the
filtered list of element IDs, depending on if this is a beforeSearch or
afterSearch event |
craft\events\SearchEvent |
$handled |
boolean | Whether the event is handled. | yii\base\Event |
$name |
string | The event name. | yii\base\Event |
$query |
craft\search\SearchQuery, null | The search query | craft\events\SearchEvent |
$sender |
object | The sender of this event. | yii\base\Event |
$siteId |
integer, null | The site ID to filter by | craft\events\SearchEvent |
| Method | Description | Defined By |
|---|---|---|
__call() |
Calls the named method which is not a class method. | yii\base\BaseObject |
__construct() |
Constructor. | yii\base\BaseObject |
__get() |
Returns the value of an object property. | yii\base\BaseObject |
__isset() |
Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject |
__set() |
Sets value of an object property. | yii\base\BaseObject |
__unset() |
Sets an object property to null. | yii\base\BaseObject |
canGetProperty() |
Returns a value indicating whether a property can be read. | yii\base\BaseObject |
canSetProperty() |
Returns a value indicating whether a property can be set. | yii\base\BaseObject |
className() |
Returns the fully qualified name of this class. | yii\base\BaseObject |
hasHandlers() |
Returns a value indicating whether there is any handler attached to the specified class-level event. | yii\base\Event |
hasMethod() |
Returns a value indicating whether a method is defined. | yii\base\BaseObject |
hasProperty() |
Returns a value indicating whether a property is defined. | yii\base\BaseObject |
init() |
Initializes the object. | yii\base\BaseObject |
off() |
Detaches an event handler from a class-level event. | yii\base\Event |
offAll() |
Detaches all registered class-level event handlers. | yii\base\Event |
on() |
Attaches an event handler to a class-level event. | yii\base\Event |
trigger() |
Triggers a class-level event. | yii\base\Event |
Property Details
$elementIds
public property
#
The list of element IDs to filter by the search query, or the
filtered list of element IDs, depending on if this is a beforeSearch or
afterSearch event
public integer[] $elementIds = true
$query
public property
#
The search query
public craft\search\SearchQuery, null $query = null
$siteId
public property
#
The site ID to filter by
public integer, null $siteId = null