SearchService
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\SearchService » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
- Implements
IApplicationComponent- Since
- 1.0
Handles search operations.
See also http://craftcms.com
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $behaviors (opens new window) | array (opens new window) – The behaviors that should be attached to this component. |
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __get() (opens new window) | Returns a property value, an event handler list or a behavior based on its name. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | Sets value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| asa() (opens new window) | Returns the named behavior object. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| attachEventHandler() (opens new window) | Attaches an event handler to an event. |
| canGetProperty() (opens new window) | Determines whether a property can be read. |
| canSetProperty() (opens new window) | Determines whether a property can be set. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| detachEventHandler() (opens new window) | Detaches an existing event handler. |
| disableBehavior() (opens new window) | Disables an attached behavior. |
| disableBehaviors() (opens new window) | Disables all behaviors attached to this component. |
| enableBehavior() (opens new window) | Enables an attached behavior. |
| enableBehaviors() (opens new window) | Enables all behaviors attached to this component. |
| evaluateExpression() (opens new window) | Evaluates a PHP expression or callback under the context of this component. |
| filterElementIdsByQuery() | Filters a list of element IDs by a given search query. |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| getIsInitialized() (opens new window) | Checks if this application component has been initialized. |
| hasEvent() (opens new window) | Determines whether an event is defined. |
| hasEventHandler() (opens new window) | Checks whether the named event has attached handlers. |
| hasProperty() (opens new window) | Determines whether a property is defined. |
| indexElementAttributes() | Indexes the attributes of a given element defined by its element type. |
| indexElementFields() | Indexes the field values for a given element and locale. |
| init() (opens new window) | Initializes the application component. |
| isInitialized() | Checks if this application component has been initialized yet, or not. |
| raiseEvent() (opens new window) | Raises an event. |
# filterElementIdsByQuery()
Filters a list of element IDs by a given search query.
View source (opens new window)
Arguments
$elementIds(array (opens new window)) – The list of element IDs to filter by the search query.$query(mixed) – The search query (either a string or a SearchQuery instance)$scoreResults(boolean (opens new window)) – Whether to order the results based on how closely they match the query.$localeId(mixed) – The locale to filter by.$returnScores(boolean (opens new window)) – Whether the search scores should be included in the results. If true, results will be returned aselement ID => score.
Returns
array (opens new window) – The filtered list of element IDs.
Signature
public array filterElementIdsByQuery ( $elementIds, $query, $scoreResults = true, $localeId = null, $returnScores = false )
# indexElementAttributes()
Indexes the attributes of a given element defined by its element type.
View source (opens new window)
Arguments
$element(Craft\BaseElementModel)
Returns
boolean (opens new window) – Whether the indexing was a success.
Signature
public boolean indexElementAttributes ( Craft\BaseElementModel $element )
# indexElementFields()
Indexes the field values for a given element and locale.
View source (opens new window)
Arguments
$elementId(integer (opens new window)) – The ID of the element getting indexed.$localeId(string (opens new window)) – The locale ID of the content getting indexed.$fields(array (opens new window)) – The field values, indexed by field ID.
Returns
boolean (opens new window) – Whether the indexing was a success.
Signature
public boolean indexElementFields ( $elementId, $localeId, $fields )
# Constants
| Constant | Description |
|---|---|
DEFAULT_STOP_WORDS |