Contrib.social

Use readonly constructor property promotion for injected dependencies

Open on Drupal.org →
Created on 14 October 2024, 9 months ago

Problem/Motivation

Since we are requiring PHP 8.3 for the 3.x branch we can start using constructor property promotion for injected dependencies and clean up a lot of useless boilerplate code. Since we are touching these, let's also take the opportunity to apply best practices where possible:

  • Mark all injected services as readonly.
  • Remove the docblock for the constructor (since this is no longer required in the coding standards).
  • Make sure we are depending on the interface and not on the implementation (where possible).

Since this affects a large number of classes this change will be too large for a single MR. Let's do this in batches so it is easier to review and merge.

Proposed resolution

Before:

use Drupal\Core\Messenger\Messenger;

/**
 * Builds the form to delete Event series type entities.
 */
class EventSeriesTypeDeleteForm extends EntityConfirmFormBase {

  /**
   * The messenger service.
   *
   * @var \Drupal\Core\Messenger\Messenger
   */
  protected $messenger;

  /**
   * Construct a EventSeriesTypeDeleteForm.
   *
   * @param \Drupal\Core\Messenger\Messenger $messenger
   *   The messenger service.
   */
  public function __construct(Messenger $messenger) {
    $this->messenger = $messenger;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static(
      $container->get('messenger')
    );
  }

}

After:

use Drupal\Core\Messenger\MessengerInterface;

/**
 * Builds the form to delete Event series type entities.
 */
class EventSeriesTypeDeleteForm extends EntityConfirmFormBase {

  public function __construct(
    protected readonly MessengerInterface $messenger,
  ) {
    $this->messenger = $messenger;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static(
      $container->get('messenger')
    );
  }

}

API changes

Since this changes our constructor signatures this introduces a B/C break which may affect custom code that extends our classes. For this reason this can only be done in 3.x.

📌 Task
Status

Active

Version

3.0

Component

Recurring Events (Main module)

Created by

🇧🇬Bulgaria pfrenssen Sofia

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024