Issue #3501599 by tr: Strict typing in ExecutionState

src/Context/ExecutionState.php

 <?php
 
+declare(strict_types=1);
+
 namespace Drupal\rules\Context;
 
 use Drupal\Core\TypedData\Exception\MissingDataException;
@@ -10,9 +12,9 @@ use Drupal\rules\Exception\InvalidArgumentException;
 use Drupal\typed_data\DataFetcherTrait;
 
 /**
- * The rules execution state.
+ * The Rules execution state.
  *
- * A rule element may clone the state, so any added variables are only visible
+ * A Rule element may clone the state, so any added variables are only visible
  * for elements in the current PHP-variable-scope.
  */
 class ExecutionState implements ExecutionStateInterface {
@@ -29,7 +31,7 @@ class ExecutionState implements ExecutionStateInterface {
    * @todo Move this out of Context namespace?
    * @see https://www.drupal.org/project/rules/issues/2677094
    */
-  static protected $blocked = [];
+  protected static $blocked = [];
 
   /**
    * The known variables.
@@ -53,31 +55,31 @@ class ExecutionState implements ExecutionStateInterface {
   protected $currentlyBlocked;
 
   /**
-   * Creates the object.
+   * Constructs the object.
    *
    * @param \Drupal\Core\TypedData\TypedDataInterface[] $variables
    *   (optional) Variables to initialize this state with.
-   *
-   * @return static
    */
-  public static function create(array $variables = []) {
-    return new static($variables);
+  protected function __construct(array $variables) {
+    $this->variables = $variables;
   }
 
   /**
-   * Constructs the object.
+   * Creates the object.
    *
    * @param \Drupal\Core\TypedData\TypedDataInterface[] $variables
    *   (optional) Variables to initialize this state with.
+   *
+   * @return static
    */
-  protected function __construct(array $variables) {
-    $this->variables = $variables;
+  public static function create(array $variables = []): static {
+    return new static($variables);
   }
 
   /**
    * {@inheritdoc}
    */
-  public function setVariable($name, ContextDefinitionInterface $definition, $value) {
+  public function setVariable(string $name, ContextDefinitionInterface $definition, $value): static {
     $data = $this->getTypedDataManager()->create(
       $definition->getDataDefinition(),
       $value
@@ -89,7 +91,7 @@ class ExecutionState implements ExecutionStateInterface {
   /**
    * {@inheritdoc}
    */
-  public function setVariableData($name, TypedDataInterface $data) {
+  public function setVariableData(string $name, TypedDataInterface $data): static {
     $this->variables[$name] = $data;
     return $this;
   }
@@ -97,7 +99,7 @@ class ExecutionState implements ExecutionStateInterface {
   /**
    * {@inheritdoc}
    */
-  public function getVariable($name) {
+  public function getVariable(string $name): TypedDataInterface {
     if (!$this->hasVariable($name)) {
       // @todo This crashes site in certain circumstances - for example if
       // you're reacting on a "Drupal is initializing" event ... Need to handle
@@ -111,14 +113,14 @@ class ExecutionState implements ExecutionStateInterface {
   /**
    * {@inheritdoc}
    */
-  public function getVariableValue($name) {
+  public function getVariableValue(string $name): string {
     return $this->getVariable($name)->getValue();
   }
 
   /**
    * {@inheritdoc}
    */
-  public function hasVariable($name) {
+  public function hasVariable(string $name): bool {
     if (!array_key_exists($name, $this->variables)) {
       // If there is no such variable, lazy-add global context variables. That
       // way we can save time fetching global context if it is not needed.
@@ -137,7 +139,7 @@ class ExecutionState implements ExecutionStateInterface {
   /**
    * {@inheritdoc}
    */
-  public function removeVariable($name) {
+  public function removeVariable(string $name): static {
     if (array_key_exists($name, $this->variables)) {
       unset($this->variables[$name]);
     }
@@ -147,7 +149,7 @@ class ExecutionState implements ExecutionStateInterface {
   /**
    * {@inheritdoc}
    */
-  public function fetchDataByPropertyPath($property_path, $langcode = NULL) {
+  public function fetchDataByPropertyPath(string $property_path, ?string $langcode = NULL): TypedDataInterface {
     try {
       // Support global context names as variable name by ignoring points in
       // the service name; e.g. @user.current_user_context:current_user.name.
@@ -176,7 +178,7 @@ class ExecutionState implements ExecutionStateInterface {
   /**
    * {@inheritdoc}
    */
-  public function saveChangesLater($selector) {
+  public function saveChangesLater(string $selector): static {
     $this->saveLater[$selector] = TRUE;
     return $this;
   }
@@ -184,14 +186,14 @@ class ExecutionState implements ExecutionStateInterface {
   /**
    * {@inheritdoc}
    */
-  public function getAutoSaveSelectors() {
+  public function getAutoSaveSelectors(): array {
     return array_keys($this->saveLater);
   }
 
   /**
    * {@inheritdoc}
    */
-  public function autoSave() {
+  public function autoSave(): static {
     // Make changes permanent.
     foreach ($this->saveLater as $selector => $flag) {
       $typed_data = $this->fetchDataByPropertyPath($selector);

src/Context/ExecutionStateInterface.php

@@ -21,7 +21,7 @@ interface ExecutionStateInterface {
    *
    * @return $this
    */
-  public function setVariable($name, ContextDefinitionInterface $definition, $value);
+  public function setVariable(string $name, ContextDefinitionInterface $definition, $value): static;
 
   /**
    * Sets a state variable with some typed data object.
@@ -33,7 +33,7 @@ interface ExecutionStateInterface {
    *
    * @return $this
    */
-  public function setVariableData($name, TypedDataInterface $data);
+  public function setVariableData(string $name, TypedDataInterface $data): static;
 
   /**
    * Gets a variable.
@@ -48,7 +48,7 @@ interface ExecutionStateInterface {
    *   Throws an EvaluationException if the variable does not exist in the
    *   state.
    */
-  public function getVariable($name);
+  public function getVariable(string $name): TypedDataInterface;
 
   /**
    * Gets the value of a variable.
@@ -63,7 +63,7 @@ interface ExecutionStateInterface {
    *   Throws an EvaluationException if the variable does not exist in the
    *   state.
    */
-  public function getVariableValue($name);
+  public function getVariableValue(string $name);
 
   /**
    * Checks if a variable exists by name in the execution state.
@@ -74,7 +74,7 @@ interface ExecutionStateInterface {
    * @return bool
    *   TRUE if the variable exists, FALSE otherwise.
    */
-  public function hasVariable($name);
+  public function hasVariable(string $name): bool;
 
   /**
    * Removes a variable from the state if it is set.
@@ -84,7 +84,7 @@ interface ExecutionStateInterface {
    *
    * @return $this
    */
-  public function removeVariable($name);
+  public function removeVariable(string $name): static;
 
   /**
    * Returns a value as specified in the selector.
@@ -102,7 +102,7 @@ interface ExecutionStateInterface {
    * @throws \Drupal\rules\Exception\EvaluationException
    *   Throws an EvaluationException in case the selector cannot be applied.
    */
-  public function fetchDataByPropertyPath($property_path, $langcode = NULL);
+  public function fetchDataByPropertyPath(string $property_path, ?string $langcode = NULL): TypedDataInterface;
 
   /**
    * Mark a variable to be saved later when the execution is finished.
@@ -113,7 +113,7 @@ interface ExecutionStateInterface {
    *
    * @return $this
    */
-  public function saveChangesLater($selector);
+  public function saveChangesLater(string $selector): static;
 
   /**
    * Returns the list of variables that should be auto-saved after execution.
@@ -122,13 +122,13 @@ interface ExecutionStateInterface {
    *   The list of data selectors that specify the target object to be saved.
    *   Example: node.uid.entity.
    */
-  public function getAutoSaveSelectors();
+  public function getAutoSaveSelectors(): array;
 
   /**
    * Saves all variables that have been marked for auto saving.
    *
    * @return $this
    */
-  public function autoSave();
+  public function autoSave(): static;
 
 }