First commit.

Author: philipnorton42

README.md

@@ -0,0 +1,3 @@
+# Drupal Services Examples
+
+A set of examples of different ways to use the services system in Drupal.

drupal_services_examples.info.yml

@@ -0,0 +1,5 @@
+name: 'Drupal Services Examples'
+type: module
+description: 'A set of examples of Drupal services in action.'
+package: Example
+core_version_requirement: ^10 || ^11

modules/services_argument_example/services_argument_example.info.yml

@@ -0,0 +1,7 @@
+name: 'Services Argument Example'
+type: module
+description: 'Passing arguments to services.'
+package: Example
+core_version_requirement: ^10 || ^11
+dependencies:
+  - drupal_services_examples:drupal_services_examples

modules/services_argument_example/services_argument_example.services.yml

@@ -0,0 +1,11 @@
+services:
+  services_argument_example.single_argument:
+    class: \Drupal\services_argument_example\SingleArgument
+    arguments: ['@serialization.json']
+
+# uuid?
+  # state
+
+ #parent argumen
+
+  #decorates

modules/services_argument_example/src/SingleArgument.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Drupal\services_argument_example;
+
+use Drupal\Component\Serialization\SerializationInterface;
+
+/**
+ * An example of a service that accepts an argument.
+ *
+ * This service has a dependency on the serialization.json service. Although
+ * any of the classes that implement SerializationInterface will work as long
+ * as the payload is of the correct type.
+ */
+class SingleArgument implements SingleArgumentInterface {
+
+  /**
+   * Creates a SingleArgument service object.
+   *
+   * @param \Drupal\Component\Serialization\SerializationInterface $serializer
+   *   A serializer service.
+   */
+  public function __construct(protected SerializationInterface $serializer) {
+  }
+
+  /**
+   * {@inheritDoc}
+   */
+  public function removeItemFromPayload(string $payload, int $id):string {
+    $payload = $this->serializer->decode($payload);
+    foreach ($payload as $key => $item) {
+      if ($item['id'] === $id) {
+        unset($payload[$key]);
+      }
+    }
+    return $this->serializer->encode($payload);
+  }
+
+}

modules/services_argument_example/src/SingleArgumentInterface.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Drupal\services_argument_example;
+
+/**
+ * Interface for the SimpleService service.
+ */
+interface SingleArgumentInterface {
+
+  /**
+   * Removes an item from a payload.
+   *
+   * @param string $payload
+   *   The payload to alter.
+   * @param int $id
+   *   The ID to remove from the payload.
+   *
+   * @return string
+   *   The resulting payload string.
+   */
+  public function removeItemFromPayload(string $payload, int $id):string;
+
+}

modules/services_argument_example/tests/Kernel/SingleArgumentTest.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Drupal\Tests\services_argument_example\Kernel;
+
+use Drupal\KernelTests\KernelTestBase;
+
+/**
+ * Kernel tests for the SingleArgument service.
+ */
+class SingleArgumentTest extends KernelTestBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $modules = [
+    'services_argument_example',
+  ];
+
+  /**
+   * Test that the getArray method returns an array.
+   */
+  public function testSimpleService() {
+    $payload = '{"0":{"id":1},"1":{"id":2},"2":{"id":3}}';
+    $id = 2;
+
+    $result = '{"0":{"id":1},"2":{"id":3}}';
+
+    /** @var \Drupal\services_argument_example\SingleArgument $simpleService */
+    $argumentService = \Drupal::service('services_argument_example.single_argument');
+    $this->assertEquals($result, $argumentService->removeItemFromPayload($payload, $id));
+  }
+
+}

modules/services_argument_example/tests/Unit/SingleArgumentTest.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Drupal\Tests\services_argument_example\Unit;
+
+use Drupal\Component\Serialization\Json;
+use Drupal\services_argument_example\SingleArgument;
+use Drupal\Tests\UnitTestCase;
+
+/**
+ * Unit tests for the SingleArgument service.
+ */
+class SingleArgumentTest extends UnitTestCase {
+
+  /**
+   * Test that removeItemFromPayload removes an item from the payload.
+   */
+  public function testSimpleService() {
+    $payload = '{"0":{"id":1},"1":{"id":2},"2":{"id":3}}';
+    $id = 2;
+
+    $result = '{"0":{"id":1},"2":{"id":3}}';
+
+    $argumentService = new SingleArgument(new Json());
+    $this->assertEquals($result, $argumentService->removeItemFromPayload($payload, $id));
+  }
+
+}

modules/services_simple_example/services_simple_example.info.yml

@@ -0,0 +1,7 @@
+name: 'Services Simple Example'
+type: module
+description: 'A very simple service.'
+package: Example
+core_version_requirement: ^10 || ^11
+dependencies:
+  - drupal_services_examples:drupal_services_examples

modules/services_simple_example/services_simple_example.services.yml

@@ -0,0 +1,3 @@
+services:
+  services_simple_example.simple_service:
+    class: \Drupal\services_simple_example\SimpleService

modules/services_simple_example/src/SimpleService.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace Drupal\services_simple_example;
+
+/**
+ * An example of a simple service.
+ *
+ * This service has no dependencies.
+ */
+class SimpleService implements SimpleServiceInterface {
+
+  /**
+   * {@inheritDoc}
+   */
+  public function getArray():array {
+    return [];
+  }
+
+}

modules/services_simple_example/src/SimpleServiceInterface.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace Drupal\services_simple_example;
+
+/**
+ * Interface for the SimpleService service.
+ */
+interface SimpleServiceInterface {
+
+  /**
+   * Get an array.
+   *
+   * @return array
+   *   The array.
+   */
+  public function getArray():array;
+
+}

modules/services_simple_example/tests/Kernel/SimpleServiceTest.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Drupal\Tests\services_simple_example\Kernel;
+
+use Drupal\KernelTests\KernelTestBase;
+
+/**
+ * Kernel tests for the SimpleService service.
+ */
+class SimpleServiceTest extends KernelTestBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $modules = [
+    'services_simple_example',
+  ];
+
+  /**
+   * Test that the getArray method returns an array.
+   */
+  public function testSimpleService() {
+    /** @var \Drupal\services_simple_example\SimpleService $simpleService */
+    $simpleService = \Drupal::service('services_simple_example.simple_service');
+    $this->assertEquals([], $simpleService->getArray());
+  }
+
+}

modules/services_simple_example/tests/Unit/SimpleServiceTest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace Drupal\Tests\services_simple_example\Unit;
+
+use Drupal\services_simple_example\SimpleService;
+use Drupal\Tests\UnitTestCase;
+
+/**
+ * Unit tests for the SimpleService service.
+ */
+class SimpleServiceTest extends UnitTestCase {
+
+  /**
+   * Test that the getArray method returns an array.
+   */
+  public function testSimpleService() {
+    $simpleService = new SimpleService();
+    $this->assertEquals([], $simpleService->getArray());
+  }
+
+}