added error builder

Author: schmittjoh

Diff for: Plugin/ErrorBuilder.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace JMS\Payment\CoreBundle\Plugin;
+
+use JMS\Payment\CoreBundle\Plugin\Exception\InvalidPaymentInstructionException;
+
+/**
+ * Convenience class for building up error messages.
+ *
+ * @author Johannes M. Schmitt <[email protected]>
+ */
+class ErrorBuilder
+{
+    private $dataErrors = array();
+    private $globalErrors = array();
+
+    public function addDataError($field, $messageTemplate)
+    {
+        $this->dataErrors[$field] = $messageTemplate;
+    }
+
+    public function addGlobalError($messageTemplate)
+    {
+        $this->globalErrors[] = $messageTemplate;
+    }
+
+    public function hasErrors()
+    {
+        return $this->dataErrors || $this->globalErrors;
+    }
+
+    public function getException()
+    {
+        $ex = new InvalidPaymentInstructionException();
+        $ex->setDataErrors($this->dataErrors);
+        $ex->setGlobalErrors($this->globalErrors);
+
+        return $ex;
+    }
+}

Diff for: Resources/doc/plugins.rst

@@ -235,29 +235,30 @@ We are now going to implement the ``checkPaymentInstruction`` method for our for
     
     use JMS\Payment\CoreBundle\Plugin\AbstractPlugin;
     use JMS\Payment\CoreBundle\Model\PaymentInstructionInterface;
-    use JMS\Payment\CoreBundle\Plugin\Exception\InvalidPaymentInstructionException;
+    use JMS\Payment\CoreBundle\Plugin\ErrorBuilder;
     
     class CreditCardPlugin extends AbstractPlugin
     {
         public function checkPaymentInstruction(PaymentInstructionInterface $instruction)
         {
-            $errors = array();
+            $errorBuilder = new ErrorBuilder();
             $data = $instruction->getExtendedData();
             
             if (!$data->get('holder')) {
-                $errors['holder'] = 'form.error.required';
+                $errorBuilder->addDataError('holder', 'form.error.required');
             }
             if (!$data->get('number')) {
-                $errors['number'] = 'form.error.required';
+                $errorBuilder->addDataError('number', 'form.error.required');
+            }
+            
+            if ($instruction->getAmount() > 10000) {
+                $errorBuilder->addGlobalError('form.error.credit_card_max_limit_exceeded');
             }
             
             // more checks here ...
             
-            if (count($errors) > 0) {
-                $ex = new InvalidPaymentInstructionException('The payment instruction is invalid.');
-                $ex->setDataErrors($errors);
-                
-                throw $ex;
+            if ($errorBuilder->hasErrors()) {
+                throw $errorBuilder->getException();
             }
         }
     
@@ -270,9 +271,5 @@ We are now going to implement the ``checkPaymentInstruction`` method for our for
 .. note ::
 
     The data errors are automatically mapped to the respective fields of the form.
-    
-.. tip ::
+    Global errors are applied to the form itself.
 
-    If you have an error that is not related to a specific fields, but rather to several
-    fields, or the payment instruction as a whole, use ``setGlobalErrors`` instead of
-    ``setDataErrors``.

Diff for: Tests/Plugin/ErrorBuilderTest.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace JMS\Payment\CoreBundle\Tests\Plugin;
+
+use JMS\Payment\CoreBundle\Plugin\ErrorBuilder;
+
+class ErrorBuilderTest extends \PHPUnit_Framework_TestCase
+{
+    private $builder;
+
+    public function testHasErrors()
+    {
+        $this->assertFalse($this->builder->hasErrors());
+
+        $this->builder->addGlobalError('foo');
+        $this->assertTrue($this->builder->hasErrors());
+    }
+
+    public function testGetException()
+    {
+        $this->builder->addDataError('foo', 'bar');
+        $this->builder->addGlobalError('baz');
+
+        $ex = $this->builder->getException();
+        $this->assertInstanceOf('JMS\Payment\CoreBundle\Plugin\Exception\InvalidPaymentInstructionException', $ex);
+        $this->assertSame(array('foo' => 'bar'), $ex->getDataErrors());
+        $this->assertSame(array('baz'), $ex->getGlobalErrors());
+    }
+
+    protected function setUp()
+    {
+        $this->builder = new ErrorBuilder();
+    }
+}