Feature 34483 - Taking into account code review.

oliverde8 · oliverde8 · commit 759432c35d75 · 2020-09-16T13:55:18.000+02:00
diff --git a/src/Symfony/Component/Form/Extension/Validator/ViolationMapper/ViolationPath.php b/src/Symfony/Component/Form/Extension/Validator/ViolationMapper/ViolationPath.php
@@ -196,9 +196,8 @@ public function isIndex(int $index)
     /**
      * {@inheritdoc}
      */
-    public function isOptional(int $index)
+    public function isNullSafe(int $index)
     {
-        // Nothing is optional
         return false;
     }
 
diff --git a/src/Symfony/Component/PropertyAccess/PropertyAccessor.php b/src/Symfony/Component/PropertyAccess/PropertyAccessor.php
@@ -279,7 +279,12 @@ private function readPropertiesUntil(array $zval, PropertyPathInterface $propert
         for ($i = 0; $i < $lastIndex; ++$i) {
             $property = $propertyPath->getElement($i);
             $isIndex = $propertyPath->isIndex($i);
-            $isOptional = $propertyPath->isOptional($i);
+
+            $isOptional = false;
+            if (method_exists($propertyPath, 'isNullSafe')) {
+                // To be removed in symfony 6 once we are sure isOptional is always implemented.
+                $isOptional = $propertyPath->isNullSafe($i);
+            }
 
             if ($isIndex) {
                 // Create missing nested arrays on demand
@@ -375,11 +380,10 @@ private function readProperty(array $zval, string $property, bool $ignoreInvalid
         if (!\is_object($zval[self::VALUE])) {
             if (!$isOptional) {
                 throw new NoSuchPropertyException(sprintf('Cannot read property "%s" from an array. Maybe you intended to write the property path as "[%1$s]" instead.', $property));
-            } else {
-                $result[self::VALUE] = null;
-
-                return $result;
             }
+
+            $result[self::VALUE] = null;
+            return $result;
         }
 
         $object = $zval[self::VALUE];
diff --git a/src/Symfony/Component/PropertyAccess/PropertyPath.php b/src/Symfony/Component/PropertyAccess/PropertyPath.php
@@ -55,7 +55,7 @@ class PropertyPath implements \IteratorAggregate, PropertyPathInterface
      *
      * @var array
      */
-    private $isOptional = [];
+    private $isNullSafe = [];
 
     /**
      * String representation of the path.
@@ -80,7 +80,7 @@ public function __construct($propertyPath)
             $this->elements = $propertyPath->elements;
             $this->length = $propertyPath->length;
             $this->isIndex = $propertyPath->isIndex;
-            $this->isOptional = $propertyPath->isOptional;
+            $this->isNullSafe = $propertyPath->isNullSafe;
             $this->pathAsString = $propertyPath->pathAsString;
 
             return;
@@ -111,10 +111,10 @@ public function __construct($propertyPath)
 
             // Mark as optional when last character is "?".
             if ('?' === substr($element, -1, 1)) {
-                $this->isOptional[] = true;
+                $this->isNullSafe[] = true;
                 $element = substr($element, 0, -1);
             } else {
-                $this->isOptional[] = false;
+                $this->isNullSafe[] = false;
             }
             $this->elements[] = $element;
 
@@ -161,7 +161,7 @@ public function getParent()
         $parent->pathAsString = substr($parent->pathAsString, 0, max(strrpos($parent->pathAsString, '.'), strrpos($parent->pathAsString, '[')));
         array_pop($parent->elements);
         array_pop($parent->isIndex);
-        array_pop($parent->isOptional);
+        array_pop($parent->isNullSafe);
 
         return $parent;
     }
@@ -223,12 +223,12 @@ public function isIndex(int $index)
     /**
      * {@inheritdoc}
      */
-    public function isOptional(int $index)
+    public function isNullSafe(int $index)
     {
-        if (!isset($this->isOptional[$index])) {
+        if (!isset($this->isNullSafe[$index])) {
             throw new OutOfBoundsException(sprintf('The index %s is not within the property path', $index));
         }
 
-        return $this->isOptional[$index];
+        return $this->isNullSafe[$index];
     }
 }
diff --git a/src/Symfony/Component/PropertyAccess/PropertyPathInterface.php b/src/Symfony/Component/PropertyAccess/PropertyPathInterface.php
@@ -15,6 +15,8 @@
  * A sequence of property names or array indices.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @method bool isNullSafe(int $index) Returns whether the element at the given index is null sage. Not implementing it is deprecated since Symfony 5.2
  */
 interface PropertyPathInterface extends \Traversable
 {
@@ -83,15 +85,4 @@ public function isProperty(int $index);
      * @throws Exception\OutOfBoundsException If the offset is invalid
      */
     public function isIndex(int $index);
-
-    /**
-     * Returns whether the element at the given index is optional.
-     *
-     * @param int $index The index in the property path
-     *
-     * @return bool Whether the element at this index is an array index
-     *
-     * @throws Exception\OutOfBoundsException If the offset is invalid
-     */
-    public function isOptional(int $index);
 }

Original file line number	Diff line number	Diff line change
`@@ -196,9 +196,8 @@ public function isIndex(int $index)`
`196`	`196`	`/**`
`197`	`197`	`* {@inheritdoc}`
`198`	`198`	`*/`
`199`		`- public function isOptional(int $index)`
	`199`	`+ public function isNullSafe(int $index)`
`200`	`200`	`{`
`201`		`- // Nothing is optional`
`202`	`201`	`return false;`
`203`	`202`	`}`
`204`	`203`