NEPT-1591: Make sure that requests can be parsed via XML #62

src/Messages/AbstractMessage.php

@@ -6,6 +6,7 @@
 use EC\Poetry\Messages\Traits\ArrayAccessTrait;
 use Symfony\Component\Validator\Mapping\ClassMetadata;
 use Symfony\Component\Validator\Constraints as Assert;
+use EC\Poetry\Messages\Traits\ParserAwareTrait;
 
 /**
  * Class AbstractMessage
@@ -15,6 +16,7 @@
 abstract class AbstractMessage implements MessageInterface
 {
     use ArrayAccessTrait;
+    use ParserAwareTrait;
 
     const COMMUNICATION_SYNCHRONOUS = 'synchrone';
     const COMMUNICATION_ASYNCHRONOUS = 'asynchrone';
@@ -125,4 +127,20 @@ public function setMessageId($messageId)
     {
         $this->messageId = $messageId;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function withXml($xml)
+    {
+        $this->setRaw($xml);
+        $parser = $this->getParser();
+        $parser->addXmlContent($xml);
+
+        $xml = $parser->getOuterContent('POETRY/request/demandeId');
+        $this->getIdentifier()->withXml($xml);
+        $this->setMessageId($parser->getAttribute('POETRY/request', 'id'));
+
+        return $this;
+    }
 }

src/Messages/ComponentInterface.php

@@ -9,7 +9,7 @@
  *
  * @package EC\Poetry\Messages
  */
-interface ComponentInterface extends \ArrayAccess
+interface ComponentInterface extends ParserAwareInterface, \ArrayAccess
 {
     /**
      * Get template name.
@@ -30,10 +30,36 @@ public function getAttributes();
      * Construct component from given array.
      *
      * @param array $properties
+     *
      * @return $this
      */
     public function withArray(array $properties);
 
+    /**
+     * Set message or component internal properties given its XML representation.
+     *
+     * @param string $xml
+     *
+     * @return $this
+     */
+    public function withXml($xml);
+
+    /**
+     * Get raw XML.
+     *
+     * @return string
+     */
+    public function getRaw();
+
+    /**
+     * Set raw XML.
+     *
+     * @param string $raw
+     *
+     * @return $this
+     */
+    public function setRaw($raw);
+
     /**
      * @param \Symfony\Component\Validator\Mapping\ClassMetadata $metadata
      */

src/Messages/Components/AbstractComponent.php

@@ -5,14 +5,13 @@
 use EC\Poetry\Messages\ComponentInterface;
 use EC\Poetry\Messages\Traits\ArrayAccessTrait;
 use EC\Poetry\Messages\Traits\ParserAwareTrait;
-use EC\Poetry\Messages\ParserAwareInterface;
 
 /**
  * Class AbstractComponent
  *
  * @package EC\Poetry\Messages\Components
  */
-abstract class AbstractComponent implements ComponentInterface, ParserAwareInterface
+abstract class AbstractComponent implements ComponentInterface
 {
     use ArrayAccessTrait;
     use ParserAwareTrait;
@@ -29,27 +28,12 @@ public function getAttributes()
     }
 
     /**
-     * Set a message or a component internal properties given its XML representation.
-     *
-     * @param string $xml
-     *      XML string.
-     *
-     * @return \EC\Poetry\Messages\MessageInterface|\EC\Poetry\Messages\ComponentInterface
+     * {@inheritdoc}
      */
-    public function fromXml($xml)
+    public function withXml($xml)
     {
         $this->setRaw($xml);
 
-        return $this->parseXml($xml);
+        return $this;
     }
-
-    /**
-     * Parse a XML string into a set of properties.
-     *
-     * @param string $xml
-     *      XML string.
-     *
-     * @return \EC\Poetry\Messages\MessageInterface|\EC\Poetry\Messages\ComponentInterface
-     */
-    abstract protected function parseXml($xml);
 }

src/Messages/Components/Contact.php

@@ -132,7 +132,7 @@ public function setEmail($email)
     /**
      * {@inheritdoc}
      */
-    protected function parseXml($xml)
+    public function withXml($xml)
     {
         $parser = $this->getParser();
         $parser->addXmlContent($xml);

src/Messages/Components/Details.php

@@ -382,7 +382,7 @@ public function setReferenceFilesRemark($referenceFilesRemark)
     /**
      * {@inheritdoc}
      */
-    protected function parseXml($xml)
+    public function withXml($xml)
     {
         $parser = $this->getParser();
         $parser->addXmlContent($xml);

src/Messages/Components/Identifier.php

@@ -269,7 +269,7 @@ public function getGroupSequence()
     /**
      * {@inheritdoc}
      */
-    protected function parseXml($xml)
+    public function withXml($xml)
     {
         $parser = $this->getParser();
         $parser->addXmlContent($xml);

src/Messages/Components/ReferenceDocument.php

@@ -248,7 +248,7 @@ public function setFile($file)
     /**
      * {@inheritdoc}
      */
-    protected function parseXml($xml)
+    public function withXml($xml)
     {
         $parser = $this->getParser();
         $parser->addXmlContent($xml);

src/Messages/Components/ReturnAddress.php

@@ -202,7 +202,7 @@ public function setRemark($remark)
     /**
      * {@inheritdoc}
      */
-    protected function parseXml($xml)
+    public function withXml($xml)
     {
         $parser = $this->getParser();
         $parser->addXmlContent($xml);

src/Messages/Components/Source.php

@@ -296,7 +296,7 @@ public function setFile($file)
     /**
      * {@inheritdoc}
      */
-    protected function parseXml($xml)
+    public function withXml($xml)
     {
         $parser = $this->getParser();
         $parser->addXmlContent($xml);
@@ -314,7 +314,7 @@ private function parseSourceLanguage(Parser $parser)
         $parser->eachComponent("documentSource/documentSourceLang", function (Parser $language) {
             $this->withSourceLanguage()
             ->setParser($this->getParser())
-            ->fromXml($language->outerHtml());
+            ->withXml($language->outerHtml());
         }, $this);
     }
 

src/Messages/Components/SourceLanguage.php

@@ -80,7 +80,7 @@ public function setPages($pages)
     /**
      * {@inheritdoc}
      */
-    protected function parseXml($xml)
+    public function withXml($xml)
     {
         $parser = $this->getParser();
         $parser->addXmlContent($xml);

src/Messages/Components/Status.php

@@ -200,7 +200,7 @@ public function setMessage($message)
     /**
      * {@inheritdoc}
      */
-    protected function parseXml($xml)
+    public function withXml($xml)
     {
         $parser = $this->getParser();
         $parser->addXmlContent($xml);

src/Messages/Components/Target.php

@@ -306,7 +306,7 @@ public function withReturnAddress()
     /**
      * {@inheritdoc}
      */
-    protected function parseXml($xml)
+    public function withXml($xml)
     {
         $parser = $this->getParser();
         $parser->addXmlContent($xml);

src/Messages/Components/TargetReturnAddress.php

@@ -9,7 +9,6 @@
  */
 class TargetReturnAddress extends ReturnAddress
 {
-
     /**
      * {@inheritdoc}
      */

src/Messages/MessageAwareInterface.php

@@ -2,8 +2,6 @@
 
 namespace EC\Poetry\Messages;
 
-use EC\Poetry\Messages\MessageInterface;
-
 /**
  * Interface MessageAwareInterface
  *

src/Messages/Notifications/AbstractNotification.php

@@ -4,19 +4,15 @@
 
 use EC\Poetry\Events\ParseNotificationEvent;
 use EC\Poetry\Messages\AbstractMessage;
-use EC\Poetry\Messages\Traits\ParserAwareTrait;
-use EC\Poetry\Messages\ParserAwareInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
 /**
  * Class AbstractNotification.
  *
  * @package EC\Poetry\Messages\Notifications
  */
-abstract class AbstractNotification extends AbstractMessage implements ParserAwareInterface, EventSubscriberInterface
+abstract class AbstractNotification extends AbstractMessage implements EventSubscriberInterface
 {
-    use ParserAwareTrait;
-
     /**
      * {@inheritdoc}
      */
@@ -33,32 +29,4 @@ public static function getSubscribedEvents()
      * @return mixed
      */
     abstract public function onParseNotification(ParseNotificationEvent $event);
-
-    /**
-     * Set a message or a component internal properties given its XML representation.
-     *
-     * @param string $xml
-     *      XML string.
-     *
-     * @return \EC\Poetry\Messages\MessageInterface|\EC\Poetry\Messages\ComponentInterface
-     */
-    public function fromXml($xml)
-    {
-        $this->setRaw($xml);
-
-        return $this->parseXml($xml);
-    }
-
-    /**
-     * Parse a XML string into a set of properties.
-     *
-     * @param string $xml
-     *      XML string.
-     *
-     * @return \EC\Poetry\Messages\MessageInterface|\EC\Poetry\Messages\ComponentInterface
-     */
-    protected function parseXml($xml)
-    {
-        return $this;
-    }
 }

src/Messages/Notifications/StatusUpdated.php

@@ -34,7 +34,7 @@ public function onParseNotification(ParseNotificationEvent $event)
         $parser = $this->getParser();
         $parser->addXmlContent($event->getXml());
         if ('status' === $parser->getAttribute('POETRY/request', 'type')) {
-            $this->fromXml($event->getXml());
+            $this->withXml($event->getXml());
             $event->setEvent(new StatusUpdatedEvent($this));
             $event->stopPropagation();
         }
@@ -43,26 +43,23 @@ public function onParseNotification(ParseNotificationEvent $event)
     /**
      * {@inheritdoc}
      */
-    protected function parseXml($xml)
+    public function withXml($xml)
     {
+        parent::withXml($xml);
+
         $parser = $this->getParser();
         $parser->addXmlContent($xml);
 
-        $xml = $parser->getOuterContent('POETRY/request/demandeId');
-        $this->getIdentifier()->fromXml($xml);
-
-        $this->setMessageId($parser->getAttribute('POETRY/request', 'id'));
-
         $parser->eachComponent("POETRY/request/status", function (Parser $component) {
             $this->withStatus()
               ->setParser($this->getParser())
-              ->fromXml($component->outerHtml());
+              ->withXml($component->outerHtml());
         }, $this);
 
         $parser->eachComponent("POETRY/request/attributions", function (Parser $component) {
             $this->withTarget()
               ->setParser($this->getParser())
-              ->fromXml($component->outerHtml());
+              ->withXml($component->outerHtml());
         }, $this);
 
         return $this;

src/Messages/Notifications/TranslationReceived.php

@@ -32,7 +32,7 @@ public function onParseNotification(ParseNotificationEvent $event)
         $parser = $this->getParser();
         $parser->addXmlContent($event->getXml());
         if ('translation' === $parser->getAttribute('POETRY/request', 'type')) {
-            $this->fromXml($event->getXml());
+            $this->withXml($event->getXml());
             $event->setEvent(new TranslationReceivedEvent($this));
             $event->stopPropagation();
         }
@@ -41,20 +41,17 @@ public function onParseNotification(ParseNotificationEvent $event)
     /**
      * {@inheritdoc}
      */
-    protected function parseXml($xml)
+    public function withXml($xml)
     {
+        parent::withXml($xml);
+
         $parser = $this->getParser();
         $parser->addXmlContent($xml);
 
-        $xml = $parser->getOuterContent('POETRY/request/demandeId');
-        $this->getIdentifier()->fromXml($xml);
-
-        $this->setMessageId($parser->getAttribute('POETRY/request', 'id'));
-
         $parser->eachComponent("POETRY/request/attributions", function (Parser $component) {
             $this->withTarget()
               ->setParser($this->getParser())
-              ->fromXml($component->outerHtml());
+              ->withXml($component->outerHtml());
         }, $this);
 
         return $this;

src/Messages/ParserAwareInterface.php

@@ -15,15 +15,13 @@ interface ParserAwareInterface
      * Get Parser property.
      *
      * @return \EC\Poetry\Services\Parser
-     *   Property value.
      */
     public function getParser();
 
     /**
      * Set Parser property.
      *
      * @param \EC\Poetry\Services\Parser $parser
-     *   Property value.
      *
      * @return $this
      */