Code clean-up: second batch.

Author: drunken-monkey

Diff for: search_api.install

@@ -2,7 +2,7 @@
 
 /**
  * @file
- * Defines the schema of the search API module.
+ * Install, update and uninstall functions for the Search API module.
  */
 
 /**
@@ -31,21 +31,19 @@ function search_api_schema() {
         'not null' => TRUE,
       ),
       'changed' => array(
-        'description' => 'Either a flag or a timestamp to indicate if or when the item was changed since it was last indexed.',
+        'description' => 'A timestamp indicating when the item was last changed.',
         'type' => 'int',
         'unsigned' => TRUE,
         'not null' => TRUE,
-        'default' => 1,
       ),
       'status' => array(
-        'description' => 'Boolean indicating whether the entity should be in the index.',
+        'description' => 'Boolean indicating whether the item needs to be reindexed.',
         'type' => 'int',
         'not null' => TRUE,
-        'default' => 1,
       ),
     ),
     'indexes' => array(
-      'indexing' => array('index_id', 'changed'),
+      'indexing' => array('index_id', 'status', 'changed', 'item_id'),
     ),
     'primary key' => array('index_id', 'item_id'),
   );
@@ -59,7 +57,7 @@ function search_api_schema() {
         'not null' => TRUE,
       ),
       'server_id' => array(
-        'description' => 'The {search_api_server}.machine_name for which this task should be executed.',
+        'description' => 'The ID of the server for which this task should be executed.',
         'type' => 'varchar',
         'length' => 50,
         'not null' => TRUE,
@@ -71,7 +69,7 @@ function search_api_schema() {
         'not null' => TRUE,
       ),
       'index_id' => array(
-        'description' => 'The {search_api_index}.machine_name to which this task pertains, if applicable for this type.',
+        'description' => 'The ID of the index to which this task pertains, if applicable for this type.',
         'type' => 'varchar',
         'length' => 50,
         'not null' => FALSE,
@@ -85,7 +83,7 @@ function search_api_schema() {
       ),
     ),
     'indexes' => array(
-      'server' => array('server_id'),
+      'execution' => array('type', 'server_id', 'id'),
     ),
     'primary key' => array('id'),
   );

Diff for: search_api.links.menu.yml

@@ -1,5 +1,5 @@
 search_api.overview:
   title: Search API
-  description: 'Create and configure search engines.'
+  description: 'Create and configure search indexes and servers.'
   route_name: search_api.overview
-  parent: system.admin_config_search
+  parent: system.admin_config_search

Diff for: search_api.module

@@ -2,7 +2,7 @@
 
 /**
  * @file
- * Contains the Search API hook implementations.
+ * Provides a rich framework for creating searches.
  */
 
 use Drupal\Core\Entity\ContentEntityInterface;
@@ -16,7 +16,7 @@ use Drupal\search_api\Plugin\SearchApi\Datasource\ContentEntityDatasource;
 function search_api_help($route_name) {
   switch ($route_name) {
     case 'search_api.overview':
-      return t('Below is a list of indexes grouped by the server they are associated with. A server is the definition of the actual indexing, querying and storage engine (e.g. an Apache Solr or MongoDB server). An index is the definition of the actual indexed content that will be searched against (e.g. A core within Solr).');
+      return t('Below is a list of indexes grouped by the server they are associated with. A server is the definition of the actual indexing, querying and storage engine (e.g., an Apache Solr server, the database, …). An index is defines the indexed content (e.g., all content and all comments on "Article" posts).');
   }
 }
 
@@ -37,7 +37,7 @@ function search_api_permission() {
  *
  * This will first execute any pending server tasks. After that, items will
  * be indexed on all enabled indexes with a non-zero cron limit. Indexing will
- * run for the time set in the cron_limit config setting(defaulting to 15
+ * run for the time set in the cron_limit config setting (defaulting to 15
  * seconds), but will at least index one batch of items on each index.
  */
 function search_api_cron() {
@@ -123,6 +123,7 @@ function search_api_entity_insert(EntityInterface $entity) {
       return;
     }
 
+    // Compute the item IDs for all languages of the entity.
     $item_ids = array();
     $entity_id = $entity->id();
     foreach (array_keys($entity->getTranslationLanguages()) as $langcode) {
@@ -138,8 +139,8 @@ function search_api_entity_insert(EntityInterface $entity) {
 /**
  * Implements hook_entity_update().
  *
- * Updates the entry to the tracking table for each index that tracks this
- * entity.
+ * Updates the corresponding tracking table entries for each index that tracks
+ * this entity.
  *
  * Also takes care of new or deleted translations.
  */
@@ -151,6 +152,8 @@ function search_api_entity_update(EntityInterface $entity) {
       return;
     }
 
+    // Compare old and new languages for the entity to identify inserted,
+    // updated and deleted translations (and, therefore, search items).
     $entity_id = $entity->id();
     $combine_id = function($langcode) use ($entity_id) {
       return $entity_id . ':' . $langcode;
@@ -203,6 +206,7 @@ function search_api_entity_delete(EntityInterface $entity) {
       return;
     }
 
+    // Remove the search items for all the entity's translations.
     $item_ids = array();
     $entity_id = $entity->id();
     foreach (array_keys($entity->getTranslationLanguages()) as $langcode) {
@@ -234,26 +238,3 @@ function search_api_theme() {
     ),
   );
 }
-
-/**
- * Implements hook_entity_type_build().
- */
-function search_api_entity_type_build(array &$entity_types) {
-  /** @var $entity_types \Drupal\Core\Entity\EntityTypeInterface[] */
-  if (isset($entity_types['node'])) {
-    $entity_types['node']->set('search_api_default_fields', array(
-      'node:title' => array(
-        'type' => 'string',
-      ),
-      'node:path' => array(
-        'type' => 'string',
-      ),
-      'node:created' => array(
-        'type' => 'date',
-      ),
-      'node:changed' => array(
-        'type' => 'date',
-      )
-    ));
-  }
-}

Diff for: search_api.routing.yml

@@ -87,13 +87,6 @@ search_api.index_delete:
   requirements:
     _entity_access: 'search_api_index.delete'
 
-search_api.index_disable:
-  path: '/admin/config/search/search-api/index/{search_api_index}/disable'
-  defaults:
-    _entity_form: 'search_api_index.disable'
-  requirements:
-    _entity_access: 'search_api_index.disable'
-
 search_api.index_enable:
   path: '/admin/config/search/search-api/index/{search_api_index}/enable'
   defaults:
@@ -102,15 +95,15 @@ search_api.index_enable:
     _entity_access: 'search_api_index.enable'
     _csrf_token: 'TRUE'
 
-search_api.index_fields:
-  path: '/admin/config/search/search-api/index/{search_api_index}/fields'
+search_api.index_disable:
+  path: '/admin/config/search/search-api/index/{search_api_index}/disable'
   defaults:
-    _entity_form: 'search_api_index.fields'
+    _entity_form: 'search_api_index.disable'
   requirements:
-    _entity_access: 'search_api_index.fields'
+    _entity_access: 'search_api_index.disable'
 
-search_api.index_fields_datasource:
-  path: '/admin/config/search/search-api/index/{search_api_index}/fields/{datasource_id}'
+search_api.index_fields:
+  path: '/admin/config/search/search-api/index/{search_api_index}/fields'
   defaults:
     _entity_form: 'search_api_index.fields'
   requirements:

Diff for: search_api.services.yml

@@ -1,8 +1,4 @@
 services:
-  plugin.manager.search_api.processor:
-    class: Drupal\search_api\Processor\ProcessorPluginManager
-    parent: default_plugin_manager
-
   plugin.manager.search_api.backend:
     class: Drupal\search_api\Backend\BackendPluginManager
     parent: default_plugin_manager
@@ -11,6 +7,10 @@ services:
     class: Drupal\search_api\Datasource\DatasourcePluginManager
     parent: default_plugin_manager
 
+  plugin.manager.search_api.processor:
+    class: Drupal\search_api\Processor\ProcessorPluginManager
+    parent: default_plugin_manager
+
   plugin.manager.search_api.tracker:
     class: Drupal\search_api\Tracker\TrackerPluginManager
     parent: default_plugin_manager