SearchService

Type
Class
Namespace
Craft
Inherits
Craft\SearchService » Craft\BaseApplicationComponent » CApplicationComponent » CComponent
Implements
IApplicationComponent
Since
1.0

Handles search operations.

See also http://craftcms.com

View source

Public Properties

PropertyDescription
$behaviorsarray – The behaviors that should be attached to this component.

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__get()Returns a property value, an event handler list or a behavior based on its name.
__isset()Checks if a property value is null.
__set()Sets value of a component property.
__unset()Sets a component property to be null.
asa()Returns the named behavior object.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
canGetProperty()Determines whether a property can be read.
canSetProperty()Determines whether a property can be set.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
evaluateExpression()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()Returns the list of attached event handlers for an event.
getIsInitialized()Checks if this application component has been initialized.
hasEvent()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()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()Initializes the application component.
isInitialized()Checks if this application component has been initialized yet, or not.
raiseEvent()Raises an event.

filterElementIdsByQuery()

Filters a list of element IDs by a given search query.

View source

Arguments

  • $elementIds (array) – 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) – Whether to order the results based on how closely they match the query.
  • $localeId (mixed) – The locale to filter by.
  • $returnScores (boolean) – Whether the search scores should be included in the results. If true, results will be returned as element ID => score.

Returns

array – 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

Arguments

Returns

boolean – 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

Arguments

  • $elementId (integer) – The ID of the element getting indexed.
  • $localeId (string) – The locale ID of the content getting indexed.
  • $fields (array) – The field values, indexed by field ID.

Returns

boolean – Whether the indexing was a success.

Signature

public boolean indexElementFields ( $elementId, $localeId, $fields )

Constants

ConstantDescription
DEFAULT_STOP_WORDS