Issue #2634356 by Mile23, id.medion: Replace deprecated db calls with injected connection in dbtng_example

Author: medion

dbtng_example/dbtng_example.install

@@ -15,26 +15,25 @@
  * @ingroup dbtng_example
  */
 function dbtng_example_install() {
-  // Add a default entry.
-  $fields = [
-    'name' => 'John',
-    'surname' => 'Doe',
-    'age' => 0,
+  // Insert some example data into our schema.
+  $entries = [
+    [
+      'name' => 'John',
+      'surname' => 'Doe',
+      'age' => 0,
+    ],
+    [
+      'name' => 'John',
+      'surname' => 'Roe',
+      'age' => 100,
+      'uid' => 1,
+    ],
   ];
-  db_insert('dbtng_example')
-    ->fields($fields)
-    ->execute();
 
-  // Add another entry.
-  $fields = [
-    'name' => 'John',
-    'surname' => 'Roe',
-    'age' => 100,
-    'uid' => 1,
-  ];
-  db_insert('dbtng_example')
-    ->fields($fields)
-    ->execute();
+  $connection = \Drupal::database();
+  foreach ($entries as $entry) {
+    $connection->insert('dbtng_example')->fields($entry)->execute();
+  }
 }
 
 /**

dbtng_example/dbtng_example.module

@@ -4,12 +4,8 @@
  * @file
  * This is an example outlining how a module can use the DBTNG database API.
  *
- * @todo Demonstrate transaction usage.
- *   https://www.drupal.org/project/examples/issues/2986423
- *
- * General documentation is available at
- * @link database Database abstraction layer documentation @endlink and
- * at @link http://drupal.org/node/310069 @endlink.
+ * @todo Demonstrate more things.
+ *   https://www.drupal.org/project/examples/issues/718672
  */
 
 /**
@@ -20,43 +16,18 @@
  *
  * 'DBTNG' means 'Database: The Next Generation.' Yes, Drupallers are nerds.
  *
- * General documentation is available at
- * @link database.inc database abstraction layer documentation @endlink and
- * at @link http://drupal.org/node/310069 Database API @endlink.
- *
- * The several examples in DbtngExampleController (see
- * /src/Drupal/dbtng_example/Controller/DbtngExampleController.php) demonstrate
- * basic database usage.
- *
- * db_insert() example:
- * @code
- *   // INSERT INTO {dbtng_example} (name, surname) VALUES('John, 'Doe')
- *   db_insert('dbtng_example')
- *     ->fields(array('name' => 'John', 'surname' => 'Doe'))
- *     ->execute();
- * @endcode
- *
- * db_update() example:
- * @code
- *   // UPDATE {dbtng_example} SET name = 'Jane' WHERE name = 'John'
- *   db_update('dbtng_example')
- *     ->fields(array('name' => 'Jane'))
- *     ->condition('name', 'John')
- *     ->execute();
- * @endcode
+ * The interesting database queries for this example module are located in the
+ * \Drupal\dbtng_example\DbtngExampleRepository class.
  *
- * db_delete() example:
- * @code
- *   // DELETE FROM {dbtng_example} WHERE name = 'Jane'
- *   db_delete('dbtng_example')
- *     ->condition('name', 'Jane')
- *     ->execute();
- * @endcode
+ * General documentation is available at @link
+ * https://www.drupal.org/docs/8/api/database-api Database API @endlink.
  *
- * See @link database Database Abstraction Layer @endlink
- * @see db_insert()
- * @see db_update()
- * @see db_delete()
+ * @see database
+ * @see \Drupal\dbtng_example\DbtngExampleRepository
+ * @see \Drupal\Core\Database\Connection:delete()
+ * @see \Drupal\Core\Database\Connection:insert()
+ * @see \Drupal\Core\Database\Connection:select()
+ * @see \Drupal\Core\Database\Connection:update()
  */
 
 /**

dbtng_example/dbtng_example.services.yml

@@ -0,0 +1,8 @@
+# This declares the plugin manager to the service container. For background
+# information on the service container, see https://www.drupal.org/node/2133171.
+# Changes here require that the cache be cleared in order to have Drupal notice
+# them.
+services:
+  dbtng_example.repository:
+    class: Drupal\dbtng_example\DbtngExampleRepository
+    arguments: ['@database', '@string_translation', '@messenger']

dbtng_example/src/Controller/DbtngExampleController.php

@@ -3,13 +3,42 @@
 namespace Drupal\dbtng_example\Controller;
 
 use Drupal\Core\Controller\ControllerBase;
-use Drupal\dbtng_example\DbtngExampleStorage;
+use Drupal\dbtng_example\DbtngExampleRepository;
+use Symfony\Component\DependencyInjection\ContainerInterface;
 
 /**
  * Controller for DBTNG Example.
+ *
+ * @ingroup dbtng_example
  */
 class DbtngExampleController extends ControllerBase {
 
+  /**
+   * The repository for our specialized queries.
+   *
+   * @var \Drupal\dbtng_example\DbtngExampleRepository
+   */
+  protected $repository;
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container) {
+    $controller = new static($container->get('dbtng_example.repository'));
+    $controller->setStringTranslation($container->get('string_translation'));
+    return $controller;
+  }
+
+  /**
+   * Construct a new controller.
+   *
+   * @param \Drupal\dbtng_example\DbtngExampleRepository $repository
+   *   The repository service.
+   */
+  public function __construct(DbtngExampleRepository $repository) {
+    $this->repository = $repository;
+  }
+
   /**
    * Render a list of entries in the database.
    */
@@ -29,7 +58,7 @@ public function entryList() {
       $this->t('Age'),
     ];
 
-    foreach ($entries = DbtngExampleStorage::load() as $entry) {
+    foreach ($entries = $this->repository->load() as $entry) {
       // Sanitize each entry.
       $rows[] = array_map('Drupal\Component\Utility\SafeMarkup::checkPlain', (array) $entry);
     }
@@ -64,7 +93,7 @@ public function entryAdvancedList() {
     ];
 
     $rows = [];
-    foreach ($entries = DbtngExampleStorage::advancedLoad() as $entry) {
+    foreach ($entries = $this->repository->advancedLoad() as $entry) {
       // Sanitize each entry.
       $rows[] = array_map('Drupal\Component\Utility\SafeMarkup::checkPlain', $entry);
     }