https://github.com/davidjguru/dependency_injection_exercise
It shows how to approach service implementation and adaptation tasks in the context of the latest major Drupal versions: 8.x, 9.x. 10.x.
https://github.com/davidjguru/dependency_injection_exercise
Last synced: 2 months ago
JSON representation
It shows how to approach service implementation and adaptation tasks in the context of the latest major Drupal versions: 8.x, 9.x. 10.x.
- Host: GitHub
- URL: https://github.com/davidjguru/dependency_injection_exercise
- Owner: davidjguru
- License: gpl-3.0
- Created: 2024-02-04T13:19:15.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-22T12:19:20.000Z (over 1 year ago)
- Last Synced: 2025-04-02T02:55:04.118Z (2 months ago)
- Language: PHP
- Size: 97.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# The Dependency Injection exercise for Drupal
It shows how to approach service implementation and adaptation tasks in the context of the latest major Drupal versions: 8.x, 9.x. 10.x.
## Setup
1. Clone the repository within the `/web/modules/custom/` path.
1. Move to the final branch `git checkout merged/final_status`.
1. Install this module enabling the resource. Run `drush en dependency_injection_exercise`.
1. Add the new provided custom block 'Rest output block' to a page.
### Optional
The default initial branch is `main` branch it contains the starting point of the module (the initial scenario) without any change, but you can move to different branches in order to check refactoring tasks and/or features.
For instance, you can check the first exercise (see next section) by moving to the related branch:
```
git checkout refactor/rebuild_feature_as_service
```
Remember that the initial status of the exercises can be seen in the [main](https://github.com/davidjguru/dependency_injection_exercise/tree/main) branch. And the final status with the successive merges of working branches is available in the [merged/final_status](https://github.com/davidjguru/dependency_injection_exercise/tree/merged/final_status) branch.
**Working branches:**
- refactor/rebuild_feature_as_service
- feature/custom_breadcrumb
- feature/decorating_service
- feature/overriding_service
## Exercises
1. We've got a controller and block, both outputting roughly the same thing. Please refactor these so the call to fetch data happens in a service. Then, inject that service in both the controller and block instead of using \Drupal::service().
**Branch:** `refactor/rebuild_feature_as_service`.
1. Take over the MailManager service and ensure all mails are redirected to "[email protected]".
**Branch:** `feature/overriding_service`.
1. On the path /dropsolid/example/photos the breadcrumb should be Home > Dropsolid > Example > Photos.
**Branch:** `feature/custom_breadcrumb`.
1. Take over the LanguageManager service in a way that doesn't preclude others from also taking over the LanguageManager service. **Branch:** `feature/decorating_service`.
## Questions (Annotations of the rubber duck technique 🐤)
* **Why are you defining an interface for the new service?** It is considered "best practice" to do so. See "Defining a service" in [api.drupal.org/container/9.4.x](https://api.drupal.org/api/drupal/core%21core.api.php/group/container/9.4.x).
* **Are you using the logger to log messages?** Yes, although it is not used for production environments (dblog is usually disabled), I have found it useful in development environments to gather information.
* **Wait a minute, you're not implementing `ContainerInjectionInterface` in Controller!** Yes, indeed. Because I'm extending from `ControllerBase` class and this implements `ContainerInjectionInterface`. See [api.drupal.org/ControllerBase.php](https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Controller%21ControllerBase.php/10).
* **What changes did you make to LanguageManager?** I've implemented a service decorator to alter its `getStandardLanguageList()` method, adding a new language to its listing. You can see the change [here](https://github.com/davidjguru/dependency_injection_exercise/blob/15af3554162344182f155a8c1c67c6fb8c77b944/src/Service/LanguageManagerDecorator.php#L53).
* **What approach have you used to alter the MailManager.php based service?** Well, from two widely used approaches:
1. Creation a new custom `ServiceProvider.php` class.
1. Override core service using `*.services.yml` file.
I have used the latter option, as it seemed to me more natural and integrated with the approach of the exercise in general, regarding operating on the services description `dependency_injection_exercise.services.yml` file.
## Extra
1. Review and clean related menu item 'Photos' when install and uninstall module, from hooks in `.install` file. You can see the change [here](https://github.com/davidjguru/dependency_injection_exercise/commit/b0c35a192493ad26fa90969f6ad02719f988a115).
## TODO
1. Add some unit testing in order to execute automatized checks of the features.
1. Beyond ego-trippin', the `@author` tags are not validated in Drupal codestyle, please remove them ASAP.
1. Implement some way to call the LanguageManager decorator, invoking its `getStandardLanguageList()` method and see results of the implemented change.
1. Enable 'autowire' in services where it is possible to do so.
## Documentation
- [Services and dependency injection in Drupal 8+](https://www.drupal.org/docs/drupal-apis/services-and-dependency-injection/services-and-dependency-injection-in-drupal-8)
- [Altering existing services, providing dynamic services](https://www.drupal.org/docs/drupal-apis/services-and-dependency-injection/altering-existing-services-providing-dynamic-services)
- [Drupal 8: Service Decorators](https://www.axelerant.com/blog/drupal-8-service-decorators)
- [What is Autowiring? how to use Autowire in Drupal](https://www.yuseferi.com/en/blog/What-Autowiring-how-use-Autowire-Drupal)