MediaWiki master
MediaWiki\Search\SearchEventIngress Class Reference

The ingress adapter for the search component. More...

Inherits MediaWiki\DomainEvent\DomainEventIngress, MediaWiki\Page\Event\PageDeletedListener, and MediaWiki\Page\Event\PageLatestRevisionChangedListener.

Collaboration diagram for MediaWiki\Search\SearchEventIngress:

Public Member Functions

 handlePageDeletedEvent (PageDeletedEvent $event)
 Listener method for PageDeletedEvent, to be registered with a DomainEventSource.
 
 handlePageLatestRevisionChangedEvent (PageLatestRevisionChangedEvent $event)
 Listener method for PageLatestRevisionChangedEvent, to be registered with a DomainEventSource.
 
- Public Member Functions inherited from MediaWiki\DomainEvent\DomainEventIngress
 initSubscriber (array $options)
 Called by DomainEventDispatcher to provide access to the list of events to subscribe to and any other relevant information from the extension.json.
 
 registerListeners (DomainEventSource $eventSource)
 This default implementation of registerListeners() will automatically register a listener method for each event passed to initEvents() or initSubscriber().
 

Public Attributes

const OBJECT_SPEC
 Object spec intended for use with DomainEventSource::registerSubscriber().
 

Additional Inherited Members

- Protected Member Functions inherited from MediaWiki\DomainEvent\DomainEventIngress
 getListenerOptions (string $eventType, string $suffix)
 Placeholder method for allowing subclasses to define listener options.
 
 registerForEvent (DomainEventSource $eventSource, string $eventType)
 Registered any listener methods for the given event.
 

Detailed Description

The ingress adapter for the search component.

It updates search related state according to domain events coming from other components.

Access: internal

Definition at line 19 of file SearchEventIngress.php.

Member Function Documentation

◆ handlePageDeletedEvent()

MediaWiki\Search\SearchEventIngress::handlePageDeletedEvent ( PageDeletedEvent $event)

Listener method for PageDeletedEvent, to be registered with a DomainEventSource.

@noinspection PhpUnused

Implements MediaWiki\Page\Event\PageDeletedListener.

Definition at line 64 of file SearchEventIngress.php.

◆ handlePageLatestRevisionChangedEvent()

MediaWiki\Search\SearchEventIngress::handlePageLatestRevisionChangedEvent ( PageLatestRevisionChangedEvent $event)

Listener method for PageLatestRevisionChangedEvent, to be registered with a DomainEventSource.

@noinspection PhpUnused

Implements MediaWiki\Page\Event\PageLatestRevisionChangedListener.

Definition at line 39 of file SearchEventIngress.php.

References MediaWiki\Search\SearchUpdate\doUpdate(), MediaWiki\Page\Event\PageEvent\getPageId(), and MediaWiki\Page\Event\PageLatestRevisionChangedEvent\getPageRecordAfter().

Member Data Documentation

◆ OBJECT_SPEC

const MediaWiki\Search\SearchEventIngress::OBJECT_SPEC
Initial value:
= [
'class' => self::class,
'services' => [],
'events' => [
PageLatestRevisionChangedEvent::TYPE,
PageDeletedEvent::TYPE,
],
]

Object spec intended for use with DomainEventSource::registerSubscriber().

Definition at line 25 of file SearchEventIngress.php.


The documentation for this class was generated from the following file: