Update all variables to the new config system.

Author: amateescu

README.txt

@@ -102,28 +102,28 @@ Clean field identifiers:
 Hidden variables
 ----------------
 
-- search_api_solr_autocomplete_max_occurrences (default: 0.9)
+- search_api_solr.settings.autocomplete_max_occurrences (default: 0.9)
   By default, keywords that occur in more than 90% of results are ignored for
   autocomplete suggestions. This setting lets you modify that behaviour by
   providing your own ratio. Use 1 or greater to use all suggestions.
-- search_api_solr_index_prefix (default: '')
+- search_api_solr.settings.index_prefix (default: '')
   By default, the index ID in the Solr server is the same as the index's machine
   name in Drupal. This setting will let you specify a prefix for the index IDs
   on this Drupal installation. Only use alphanumeric characters and underscores.
   Since changing the prefix makes the currently indexed data inaccessible, you
   should change this vairable only when no indexes are currently on any Solr
   servers.
-- search_api_solr_index_prefix_INDEX_ID (default: '')
+- search_api_solr.settings.index_prefix_INDEX_ID (default: '')
   Same as above, but a per-index prefix. Use the index's machine name as
   INDEX_ID in the variable name. Per-index prefixing is done before the global
   prefix is added, so the global prefix will come first in the final name:
   (GLOBAL_PREFIX)(INDEX_PREFIX)(INDEX_ID)
   The same rules as above apply for setting the prefix.
-- search_api_solr_http_get_max_length (default: 4000)
+- search_api_solr.settings.http_get_max_length (default: 4000)
   The maximum number of bytes that can be handled as an HTTP GET query when
   HTTP method is AUTO. Typically Solr can handle up to 65355 bytes, but Tomcat
   and Jetty will error at slightly less than 4096 bytes.
-- search_api_solr_cron_action (default: "spellcheck")
+- search_api_solr.settings.cron_action (default: "spellcheck")
   The Search API Solr Search module can automatically execute some upkeep
   operations daily during cron runs. This variable determines what particular
   operation is carried out.
@@ -134,7 +134,7 @@ Hidden variables
   to "true") will be rebuilt, too.
   - none: No action is executed.
   If an unknown setting is encountered, it is interpreted as "none".
-- search_api_solr_site_hash (default: random)
+- search_api_solr.settings.site_hash (default: random)
   A unique hash specific to the local site, created the first time it is needed.
   Only change this if you want to display another server's results and you know
   what you are doing. Old indexed items will be lost when the hash is changed
@@ -162,6 +162,7 @@ take effect.
 Developers
 ----------
 
+// @todo Not really true anymore :)
 The SearchApiSolrService class has a few custom extensions, documented with its
 code. Methods of note are deleteItems(), which treats the first argument
 differently in certain cases, and the methods at the end of service.inc.

config/install/search_api_solr.settings.yml

@@ -0,0 +1,6 @@
+last_optimize: 0
+autocomplete_max_occurrences: 0.9
+index_prefix: ''
+http_get_max_length: 4000
+cron_action: 'spellcheck'
+site_hash: ''

config/schema/search_api_solr.schema.yml

@@ -0,0 +1,24 @@
+# Schema for configuration files of the Search API Solr module.
+
+search_api_solr.settings:
+  type: mapping
+  label: 'Search API Solr settings'
+  mapping:
+    last_optimize:
+      type: integer
+      label: 'Last time the indexes were optimized'
+    autocomplete_max_occurrences:
+      type: float
+      label: 'Autocomplete max occurences'
+    index_prefix:
+      type: string
+      label: 'The default prefix for Solr indexes'
+    http_get_max_length:
+      type: integer
+      label: 'The maximum number of bytes that can be handled as an HTTP GET query'
+    cron_action:
+      type: string
+      label: 'Cron action'
+    site_hash:
+      type: string
+      label: 'Site hash'

includes/solr_connection.inc

@@ -928,7 +928,7 @@ class SearchApiSolrConnection implements SearchApiSolrConnectionInterface {
 
     if ($method == 'GET' || $method == 'AUTO') {
       $searchUrl = $this->constructUrl(self::SEARCH_SERVLET, array(), $queryString);
-      if ($method == 'GET' || strlen($searchUrl) <= variable_get('search_api_solr_http_get_max_length', 4000)) {
+      if ($method == 'GET' || strlen($searchUrl) <= \Drupal::config('search_api_solr.settings')->get('http_get_max_length', 4000)) {
         return $this->sendRawGet($searchUrl);
       }
     }

search_api_solr.module

@@ -54,7 +54,7 @@ function search_api_solr_help($route_name, Request $request) {
  * day.
  */
 function _search_api_solr_cron() {
-  $action = variable_get('search_api_solr_cron_action', 'spellcheck');
+  $action = \Drupal::config('search_api_solr.settings')->get('cron_action');
   // We treat all unknown action settings as "none". However, we turn a blind
   // eye for Britons and other people who can spell.
   if (!in_array($action, array('spellcheck', 'optimize', 'optimise'))) {
@@ -63,8 +63,8 @@ function _search_api_solr_cron() {
   // 86400 seconds is one day. We use slightly less here to allow for some
   // variation in the request time of the cron run, so that the time of day will
   // (more or less) stay the same.
-  if (REQUEST_TIME - variable_get('search_api_solr_last_optimize', 0) > 86340) {
-    variable_set('search_api_solr_last_optimize', REQUEST_TIME);
+  if (REQUEST_TIME - \Drupal::config('search_api_solr.settings')->get('last_optimize') > 86340) {
+    \Drupal::config('search_api_solr.settings')->set('last_optimize', REQUEST_TIME);
     $conditions = array('class' => 'search_api_solr_service', 'enabled' => TRUE);
     $count = 0;
     foreach (search_api_server_load_multiple(FALSE, $conditions) as $server) {
@@ -222,10 +222,10 @@ function search_api_solr_get_data_type_info($type = NULL) {
  */
 function search_api_solr_site_hash() {
   // Copied from apachesolr_site_hash().
-  if (!($hash = variable_get('search_api_solr_site_hash', FALSE))) {
+  if (!($hash = \Drupal::config('search_api_solr.settings')->get('site_hash'))) {
     global $base_url;
     $hash = substr(base_convert(sha1(uniqid($base_url, TRUE)), 16, 36), 0, 6);
-    variable_set('search_api_solr_site_hash', $hash);
+    \Drupal::config('search_api_solr.settings')->set('site_hash', $hash);
   }
   return $hash;
 }

src/Plugin/SearchApi/Backend/SearchApiSolrBackend.php

@@ -7,6 +7,7 @@
 
 namespace Drupal\search_api_solr\Plugin\SearchApi\Backend;
 
+use Drupal\Core\Config\Config;
 use Drupal\Core\Form\FormBuilderInterface;
 use Drupal\search_api\Exception\SearchApiException;
 use Drupal\search_api\Index\IndexInterface;
@@ -76,13 +77,21 @@ class SearchApiSolrBackend extends BackendPluginBase {
    */
   protected $formBuilder;
 
+  /**
+   * A config object for 'search_api_solr.settings'.
+   *
+   * @var \Drupal\Core\Config\Config
+   */
+  protected $searchApiSolrSettings;
+
   /**
    * {@inheritdoc}
    */
-  public function __construct(array $configuration, $plugin_id, array $plugin_definition, FormBuilderInterface $form_builder) {
+  public function __construct(array $configuration, $plugin_id, array $plugin_definition, FormBuilderInterface $form_builder, Config $search_api_solr_settings) {
     parent::__construct($configuration, $plugin_id, $plugin_definition);
 
     $this->formBuilder = $form_builder;
+    $this->searchApiSolrSettings = $search_api_solr_settings;
   }
 
   /**
@@ -93,7 +102,8 @@ public static function create(ContainerInterface $container, array $configuratio
       $configuration,
       $plugin_id,
       $plugin_definition,
-      $container->get('form_builder')
+      $container->get('form_builder'),
+      $container->get('config.factory')->get('search_api_solr.settings')
     );
   }
 
@@ -1862,7 +1872,7 @@ public function getAutocompleteSuggestions(SearchApiQueryInterface $query, Searc
             // Don't suggest terms that are too frequent (by default in more
             // than 90% of results).
             $result_count = $response->response->numFound;
-            $max_occurrences = $result_count * variable_get('search_api_solr_autocomplete_max_occurrences', 0.9);
+            $max_occurrences = $result_count * $this->searchApiSolrSettings->get('autocomplete_max_occurrences');
             if (($max_occurrences >= 1 || $i > 0) && $max_occurrences < $result_count) {
               foreach ($matches as $match => $count) {
                 if ($count > $max_occurrences) {
@@ -2259,8 +2269,9 @@ public function getFile($file = NULL) {
    * Prefixes an index ID as configured.
    *
    * The resulting ID will be a concatenation of the following strings:
-   * - If set, the "search_api_solr_index_prefix" variable.
-   * - If set, the index-specific "search_api_solr_index_prefix_INDEX" variable.
+   * - If set, the "search_api_solr.settings.index_prefix" configuration.
+   * - If set, the index-specific "search_api_solr.settings.index_prefix_INDEX"
+   *   configuration.
    * - The index's machine name.
    *
    * @param string $machine_name
@@ -2271,9 +2282,9 @@ public function getFile($file = NULL) {
    */
   protected function getIndexId($machine_name) {
     // Prepend per-index prefix.
-    $id = variable_get('search_api_solr_index_prefix_' . $machine_name, '') . $machine_name;
+    $id = $this->searchApiSolrSettings->get('index_prefix_' . $machine_name) . $machine_name;
     // Prepend environment prefix.
-    $id = variable_get('search_api_solr_index_prefix', '') . $id;
+    $id = $this->searchApiSolrSettings->get('index_prefix') . $id;
     return $id;
   }