Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\search\Plugin;
Chris@0: 
Chris@0: /**
Chris@0:  * Defines an optional interface for SearchPlugin objects using an index.
Chris@0:  *
Chris@0:  * Plugins implementing this interface will have these methods invoked during
Chris@0:  * search_cron() and via the search module administration form. Plugins not
Chris@0:  * implementing this interface are assumed to be using their own methods for
Chris@0:  * searching, not involving separate index tables.
Chris@0:  *
Chris@0:  * The user interface for managing search pages displays the indexing status for
Chris@0:  * search pages implementing this interface. It also allows users to configure
Chris@0:  * default settings for indexing, and refers to the "default search index". If
Chris@0:  * your search page plugin uses its own indexing mechanism instead of the
Chris@0:  * default search index, or overrides the default indexing settings, you should
Chris@0:  * make this clear on the settings page or other documentation for your plugin.
Chris@0:  *
Chris@0:  * Multiple search pages can be created for each search plugin, so you will need
Chris@0:  * to choose whether these search pages should share an index (in which case
Chris@0:  * they must not use any search page-specific configuration while indexing) or
Chris@0:  * they will have separate indexes (which will use additional server resources).
Chris@0:  */
Chris@0: interface SearchIndexingInterface {
Chris@0: 
Chris@0:   /**
Chris@0:    * Updates the search index for this plugin.
Chris@0:    *
Chris@0:    * This method is called every cron run if the plugin has been set as
Chris@0:    * an active search module on the Search settings page
Chris@0:    * (admin/config/search/pages). It allows your module to add items to the
Chris@0:    * built-in search index using search_index(), or to add them to your module's
Chris@0:    * own indexing mechanism.
Chris@0:    *
Chris@0:    * When implementing this method, your module should index content items that
Chris@0:    * were modified or added since the last run. There is a time limit for cron,
Chris@0:    * so it is advisable to limit how many items you index per run using
Chris@0:    * config('search.settings')->get('index.cron_limit') or with your own
Chris@0:    * setting. And since the cron run could time out and abort in the middle of
Chris@0:    * your run, you should update any needed internal bookkeeping on when items
Chris@0:    * have last been indexed as you go rather than waiting to the end of
Chris@0:    * indexing.
Chris@0:    */
Chris@0:   public function updateIndex();
Chris@0: 
Chris@0:   /**
Chris@0:    * Clears the search index for this plugin.
Chris@0:    *
Chris@0:    * When a request is made to clear all items from the search index related to
Chris@0:    * this plugin, this method will be called. If this plugin uses the default
Chris@0:    * search index, this method can call search_index_clear($type) to remove
Chris@0:    * indexed items from the search database.
Chris@0:    *
Chris@0:    * @see search_index_clear()
Chris@0:    */
Chris@0:   public function indexClear();
Chris@0: 
Chris@0:   /**
Chris@0:    * Marks the search index for reindexing for this plugin.
Chris@0:    *
Chris@0:    * When a request is made to mark all items from the search index related to
Chris@0:    * this plugin for reindexing, this method will be called. If this plugin uses
Chris@0:    * the default search index, this method can call
Chris@0:    * search_mark_for_reindex($type) to mark the items in the search database for
Chris@0:    * reindexing.
Chris@0:    *
Chris@0:    * @see search_mark_for_reindex()
Chris@0:    */
Chris@0:   public function markForReindex();
Chris@0: 
Chris@0:   /**
Chris@0:    * Reports the status of indexing.
Chris@0:    *
Chris@0:    * The core search module only invokes this method on active module plugins.
Chris@0:    * Implementing modules do not need to check whether they are active when
Chris@0:    * calculating their return values.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   An associative array with the key-value pairs:
Chris@0:    *   - remaining: The number of items left to index.
Chris@0:    *   - total: The total number of items to index.
Chris@0:    */
Chris@0:   public function indexStatus();
Chris@0: 
Chris@0: }