Add CargoRepository

Author: Codeliner

module/Application/config/module.config.php

@@ -99,8 +99,8 @@
             'orm_default' => array(
                 //Define custom doctrine types to map the ddd value objects
                 'types' => array(
-                    'uid'           => 'Application\Infrastructure\Type\UID',
-                    'trackingid'    => 'Application\Infrastructure\Type\TrackingId',
+                    'uid'           => 'Application\Infrastructure\Persistence\Doctrine\Type\UID',
+                    'trackingid'    => 'Application\Infrastructure\Persistence\Doctrine\Type\TrackingId',
                 ),
             ),
         ),

module/Application/src/Application/Domain/Model/Cargo/Cargo.php

@@ -10,8 +10,19 @@
 
 use Application\Domain\Shared\EntityInterface;
 use Application\Domain\Shared\UID;
+use Doctrine\ORM\Mapping\Entity;
+use Doctrine\ORM\Mapping\Table;
+use Doctrine\ORM\Mapping\Column;
+use Doctrine\ORM\Mapping\Id;
 /**
- *  Cargo
+ * A Cargo. This is the central class in the domain model.
+ * 
+ * A cargo is identified by a unique tracking id.
+ * 
+ * ---Annotations required by Doctrine---
+ * @Entity(repositoryClass="Application\Infrastructure\Persistence\Doctrine\CargoRepositoryDoctrine")
+ * @Table(name="cargo")
+ * --------------------------------------
  * 
  * @author Alexander Miertsch <[email protected]>
  */
@@ -20,6 +31,11 @@ class Cargo implements EntityInterface
     /**
      * Unique Identifier
      * 
+     * ---Annotations required by Doctrine---
+     * @Id
+     * @Column(type="trackingid", length=13, unique=true, nullable=false)
+     * --------------------------------------
+     * 
      * @var TrackingId
      */
     protected $trackingId;

module/Application/src/Application/Domain/Model/Cargo/CargoRepositoryInterface.php

@@ -0,0 +1,44 @@
+<?php
+/*
+ * This file is part of the codeliner/php-ddd-cargo-sample package.
+ * (c) Alexander Miertsch <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace Application\Domain\Model\Cargo;
+
+/**
+ * CargoRepository to load and store Cargos
+ * 
+ * @author Alexander Miertsch <[email protected]>
+ */
+interface CargoRepositoryInterface
+{
+    /**
+     * Finds a cargo using given id.
+     * 
+     * @param TrackingId $trackingId Id
+     * @return Cargo if found, else {@code null}
+     */
+    public function findCargo(TrackingId $trackingId);
+    
+    /**
+     * Finds all cargo.
+     * 
+     * @return Cargo[] all Cargo
+     */
+    public function findAll();
+    
+    /**
+     * Saves given cargo.
+     * 
+     * @param Cargo $cargo Cargo to save
+     */
+    public function store(Cargo $cargo);
+    
+    /**
+     * @return TrackingId A unique, generated tracking Id.
+     */
+    public function getNextTrackingId();
+}

module/Application/src/Application/Infrastructure/Persistence/Doctrine/CargoRepositoryDoctrine.php

@@ -0,0 +1,47 @@
+<?php
+/*
+ * This file is part of the codeliner/php-ddd-cargo-sample package.
+ * (c) Alexander Miertsch <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace Application\Infrastructure\Persistence\Doctrine;
+
+use Application\Domain\Model\Cargo\CargoRepositoryInterface;
+use Application\Domain\Model\Cargo\Cargo;
+use Application\Domain\Model\Cargo\TrackingId;
+use Doctrine\ORM\EntityRepository;
+/**
+ *  CargoRepositoryDoctrine
+ * 
+ * @author Alexander Miertsch <[email protected]>
+ */
+class CargoRepositoryDoctrine extends EntityRepository implements CargoRepositoryInterface
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function findCargo(TrackingId $trackingId)
+    {
+        return $this->find($trackingId);
+    }
+    
+    /**
+     * {@inheritDoc}
+     */
+    public function store(Cargo $cargo)
+    {
+        $this->getEntityManager()->persist($cargo);
+        $this->getEntityManager()->flush($cargo);
+    }
+    
+    /**
+     * {@inheritDoc}
+     */
+    public function getNextTrackingId()
+    {
+        return new TrackingId(uniqid());
+    }
+
+}

…ation/Infrastructure/Type/TrackingId.php …Persistence/Doctrine/Type/TrackingId.phpmodule/Application/src/Application/Infrastructure/Type/TrackingId.php renamed to module/Application/src/Application/Infrastructure/Persistence/Doctrine/Type/TrackingId.php module/Application/src/Application/Infrastructure/Type/TrackingId.php renamed to module/Application/src/Application/Infrastructure/Persistence/Doctrine/Type/TrackingId.php

@@ -6,7 +6,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-namespace Application\Infrastrucure\Type;
+namespace Application\Infrastructure\Persistence\Doctrine\Type;
 
 use Doctrine\DBAL\Types\TextType;
 use Doctrine\DBAL\Platforms\AbstractPlatform;

…/Application/Infrastructure/Type/UID.php …ucture/Persistence/Doctrine/Type/UID.phpmodule/Application/src/Application/Infrastructure/Type/UID.php renamed to module/Application/src/Application/Infrastructure/Persistence/Doctrine/Type/UID.php module/Application/src/Application/Infrastructure/Type/UID.php renamed to module/Application/src/Application/Infrastructure/Persistence/Doctrine/Type/UID.php

@@ -6,7 +6,7 @@
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
-namespace Application\Infrastrucure\Type;
+namespace Application\Infrastructure\Persistence\Doctrine\Type;
 
 use Doctrine\DBAL\Types\TextType;
 use Doctrine\DBAL\Platforms\AbstractPlatform;

module/Application/tests/PHPUnit/ApplicationTest/Infrastructure/Persistence/Doctrine/CargoRepositoryDoctrineTest.php

@@ -0,0 +1,52 @@
+<?php
+/*
+ * This file is part of the codeliner/php-ddd-cargo-sample package.
+ * (c) Alexander Miertsch <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace ApplicationTest\Infrastructure\Persistence\Doctrine;
+
+use ApplicationTest\TestCase;
+use Application\Domain\Model\Cargo;
+use Application\Infrastrucure\Persistence\Doctrine\CargoRepositoryDoctrine;
+/**
+ *  CargoRepositoryDoctrineTest
+ * 
+ * @author Alexander Miertsch <[email protected]>
+ */
+class CargoRepositoryDoctrineTest extends TestCase
+{
+    /**
+     *
+     * @var Cargo\CargoRepositoryInterface
+     */
+    protected $cargoRepository;
+    
+    protected function setUp()
+    {
+        $this->createEntitySchema('Application\Domain\Model\Cargo\Cargo');
+        
+        $this->cargoRepository = $this->getTestEntityManager()->getRepository('Application\Domain\Model\Cargo\Cargo');
+    }
+    
+    public function testGetNextTrackingId()
+    {
+        $trackingId = $this->cargoRepository->getNextTrackingId();
+        
+        $this->assertInstanceOf('Application\Domain\Model\Cargo\TrackingId', $trackingId);
+    }
+    
+    public function testStoreAndFindCargo()
+    {
+        $trackingId = $this->cargoRepository->getNextTrackingId();
+        $cargo = new Cargo\Cargo($trackingId);
+        
+        $this->cargoRepository->store($cargo);
+        
+        $checkCargo = $this->cargoRepository->findCargo($trackingId);
+        
+        $this->assertTrue($cargo->sameIdentityAs($checkCargo));
+    }
+}

module/Application/tests/PHPUnit/ApplicationTest/TestCase.php

@@ -10,6 +10,7 @@
 
 use PHPUnit_Framework_TestCase;
 use Doctrine\ORM\EntityManager;
+use Doctrine\DBAL\Types\Type;
 /**
  *  TestCase
  * 
@@ -47,13 +48,23 @@ public function getTestEntityManager()
 
             $config->setQueryCacheImpl(new \Doctrine\Common\Cache\ArrayCache());
             $config->setMetadataCacheImpl(new \Doctrine\Common\Cache\ArrayCache());
-
+            
             $this->entityManager = \Doctrine\ORM\EntityManager::create(array(
                 'driver' => 'pdo_sqlite',
                 'memory' => true
             ), $config);
+            
+            //Add custom DDD types to map ValueObjects correctly
+            if (!Type::hasType('trackingid')) {
+                Type::addType('trackingid', 'Application\Infrastructure\Persistence\Doctrine\Type\TrackingId');
+            } 
+            
+            if (!Type::hasType('uid')) {
+                Type::addType('uid', 'Application\Infrastructure\Persistence\Doctrine\Type\UID');
+            }
         }
-
+        
+        
         return $this->entityManager;
     }