Make access strategies aware of the context

src/Accessor/AccessorStrategyInterface.php

@@ -4,7 +4,9 @@
 
 namespace JMS\Serializer\Accessor;
 
+use JMS\Serializer\DeserializationContext;
 use JMS\Serializer\Metadata\PropertyMetadata;
+use JMS\Serializer\SerializationContext;
 
 /**
  * @author Asmir Mustafic <[email protected]>
@@ -16,13 +18,13 @@ interface AccessorStrategyInterface
      * @param PropertyMetadata $metadata
      * @return mixed
      */
-    public function getValue(object $object, PropertyMetadata $metadata);
+    public function getValue(object $object, PropertyMetadata $metadata, SerializationContext $context);
 
     /**
      * @param object $object
      * @param mixed $value
      * @param PropertyMetadata $metadata
      * @return void
      */
-    public function setValue(object $object, $value, PropertyMetadata $metadata): void;
+    public function setValue(object $object, $value, PropertyMetadata $metadata, DeserializationContext $context): void;
 }

src/Accessor/DefaultAccessorStrategy.php

@@ -4,12 +4,14 @@
 
 namespace JMS\Serializer\Accessor;
 
+use JMS\Serializer\DeserializationContext;
 use JMS\Serializer\Exception\ExpressionLanguageRequiredException;
 use JMS\Serializer\Exception\LogicException;
 use JMS\Serializer\Expression\ExpressionEvaluatorInterface;
 use JMS\Serializer\Metadata\ExpressionPropertyMetadata;
 use JMS\Serializer\Metadata\PropertyMetadata;
 use JMS\Serializer\Metadata\StaticPropertyMetadata;
+use JMS\Serializer\SerializationContext;
 
 /**
  * @author Asmir Mustafic <[email protected]>
@@ -30,7 +32,7 @@ public function __construct(ExpressionEvaluatorInterface $evaluator = null)
         $this->evaluator = $evaluator;
     }
 
-    public function getValue(object $object, PropertyMetadata $metadata)
+    public function getValue(object $object, PropertyMetadata $metadata, SerializationContext $context)
     {
         if ($metadata instanceof StaticPropertyMetadata) {
             return $metadata->getValue(null);
@@ -40,8 +42,7 @@ public function getValue(object $object, PropertyMetadata $metadata)
             if ($this->evaluator === null) {
                 throw new ExpressionLanguageRequiredException(sprintf('The property %s on %s requires the expression accessor strategy to be enabled.', $metadata->name, $metadata->class));
             }
-
-            return $this->evaluator->evaluate($metadata->expression, ['object' => $object]);
+            return $this->evaluator->evaluate($metadata->expression, ['object' => $object, 'context' => $context, 'property_metadata' => $metadata ]);
         }
 
         if (null === $metadata->getter) {
@@ -71,7 +72,7 @@ public function getValue(object $object, PropertyMetadata $metadata)
         return $object->{$metadata->getter}();
     }
 
-    public function setValue(object $object, $value, PropertyMetadata $metadata): void
+    public function setValue(object $object, $value, PropertyMetadata $metadata, DeserializationContext $context): void
     {
         if ($metadata->readOnly) {
             throw new LogicException(sprintf('%s on %s is read only.', $metadata->name, $metadata->class));

src/GraphNavigator/DeserializationGraphNavigator.php

@@ -182,7 +182,7 @@ public function accept($data, array $type = null)
                     $this->context->pushPropertyMetadata($propertyMetadata);
                     try {
                         $v = $this->visitor->visitProperty($propertyMetadata, $data);
-                        $this->accessor->setValue($object, $v, $propertyMetadata);
+                        $this->accessor->setValue($object, $v, $propertyMetadata, $this->context);
                     } catch (NotAcceptableException $e) {
 
                     }

src/GraphNavigator/SerializationGraphNavigator.php

@@ -215,7 +215,7 @@ public function accept($data, array $type = null)
                         continue;
                     }
 
-                    $v = $this->accessor->getValue($data, $propertyMetadata);
+                    $v = $this->accessor->getValue($data, $propertyMetadata, $this->context);
 
                     if (null === $v && $this->shouldSerializeNull !== true) {
                         continue;

tests/Fixtures/AuthorExpressionAccessContext.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace JMS\Serializer\Tests\Fixtures;
+
+use JMS\Serializer\Annotation as Serializer;
+
+/**
+ * @Serializer\VirtualProperty("firstName", exp="object.getFirstName()")
+ * @Serializer\VirtualProperty("direction", exp="context.getDirection()")
+ * @Serializer\VirtualProperty("name", exp="property_metadata.name")
+ */
+class AuthorExpressionAccessContext
+{
+    /**
+     * @Serializer\Exclude()
+     */
+    private $firstName;
+
+    public function __construct($firstName)
+    {
+        $this->firstName = $firstName;
+    }
+
+    public function getFirstName()
+    {
+        return $this->firstName;
+    }
+}

tests/Serializer/BaseSerializationTest.php

@@ -30,6 +30,7 @@
 use JMS\Serializer\Tests\Fixtures\Article;
 use JMS\Serializer\Tests\Fixtures\Author;
 use JMS\Serializer\Tests\Fixtures\AuthorExpressionAccess;
+use JMS\Serializer\Tests\Fixtures\AuthorExpressionAccessContext;
 use JMS\Serializer\Tests\Fixtures\AuthorList;
 use JMS\Serializer\Tests\Fixtures\AuthorReadOnly;
 use JMS\Serializer\Tests\Fixtures\AuthorReadOnlyPerClass;
@@ -741,6 +742,19 @@ public function testExpressionAuthor()
         self::assertEquals($this->getContent('author_expression'), $serializer->serialize($author, $this->getFormat()));
     }
 
+    public function testExpressionAuthorWithContextVars()
+    {
+        $evaluator = new ExpressionEvaluator(new ExpressionLanguage());
+
+        $builder = SerializerBuilder::create();
+        $builder->setExpressionEvaluator($evaluator);
+        $serializer = $builder->build();
+
+        $author = new AuthorExpressionAccessContext("Ruud");
+        self::assertEquals($this->getContent('author_expression_context'), $serializer->serialize($author, $this->getFormat()));
+    }
+
+
     /**
      * @expectedException \JMS\Serializer\Exception\ExpressionLanguageRequiredException
      * @expectedExceptionMessage The property firstName on JMS\Serializer\Tests\Fixtures\AuthorExpressionAccess requires the expression accessor strategy to be enabled.

tests/Serializer/JsonSerializationTest.php

@@ -107,6 +107,7 @@ protected function getContent($key)
             $outputs['object_with_object_property_no_array_to_author'] = '{"foo": "bar", "author": "baz"}';
             $outputs['object_with_object_property'] = '{"foo": "bar", "author": {"full_name": "baz"}}';
             $outputs['author_expression'] = '{"my_first_name":"Ruud","last_name":"Kamphuis","id":123}';
+            $outputs['author_expression_context'] = '{"first_name":"Ruud","direction":1,"name":"name"}';
             $outputs['maxdepth_skippabe_object'] = '{"a":{"xxx":"yyy"}}';
             $outputs['array_objects_nullable'] = '[]';
             $outputs['type_casting'] = '{"as_string":"8"}';

tests/Serializer/xml/author_expression_context.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<result>
+  <first_name><![CDATA[Ruud]]></first_name>
+  <direction>1</direction>
+  <name><![CDATA[name]]></name>
+</result>