Use fractal library for transforming data as to not dump data directly from DB to JSON

Author: jakefolio

composer.json

@@ -6,7 +6,8 @@
         "slim/slim": "2.*",
         "slimcontroller/slimcontroller": "0.4.*",
         "vlucas/phpdotenv": "1.0.*@dev",
-        "vlucas/spot2": "~2.1"
+        "vlucas/spot2": "~2.1",
+        "league/fractal": "^0.13.0"
     },
 
     "autoload": {

composer.lock

@@ -2,47 +2,60 @@
 
 namespace Lonestar\Controller;
 
+use League\Fractal;
+use Lonestar\Serializer\NoRootArray as NoRootArraySerializer;
+use Lonestar\Transformer\Talk as TalkTransformer;
+use Lonestar\Transformer\Speaker as SpeakerTransformer;
+
 class Speaker extends \SlimController\SlimController
 {
     public function indexAction()
     {
+        $manager = (new Fractal\Manager)
+            ->setSerializer(new NoRootArraySerializer)
+            ->parseIncludes(['talks']);
+
         $speakerMapper = $this->app->spot->mapper('Lonestar\Entity\Speaker');
-        $speakers = $speakerMapper->all()
+        $results = $speakerMapper->all()
             ->with(['talks'])
             ->order(['last_name' => 'ASC']);
+        $speakers = new Fractal\Resource\Collection($results, new SpeakerTransformer);
 
-        $results = [];
-        foreach ($speakers as $id => $speaker) {
-            $results[$id] = $speaker->toArray();
-            $results[$id]['talks'] = $speaker->talks->toArray();
-        }
-
-        $this->render(200, $results);
+        $this->render(200, $manager->createData($speakers)->toArray());
     }
 
     public function showAction($id)
     {
+        $manager = (new Fractal\Manager)
+            ->setSerializer(new NoRootArraySerializer)
+            ->parseIncludes(['talks']);
+
         $speakerMapper = $this->app->spot->mapper('Lonestar\Entity\Speaker');
 
         $results = $speakerMapper->all()
             ->where(['id' => (int) $id])
-            ->toArray();
+            ->first();
+        $speaker = new Fractal\Resource\Item($results, new SpeakerTransformer);
 
-        $this->render(200, $results);
+        $this->render(200, $manager->createData($speaker)->toArray());
     }
 
     public function talksAction($id)
     {
-        $talkMapper = $this->app->spot->mapper('Lonestar\Entity\Talk');
-        $results = $talkMapper->all()
-            ->where(['speaker_id' => (int) $id])
-            ->toArray();
+        $manager = (new Fractal\Manager)
+            ->setSerializer(new NoRootArraySerializer);
+
+        $talkMapper = $this->app->spot->mapper('Lonestar\Entity\Speaker');
+        $speaker = $talkMapper->all()
+            ->where(['id' => (int) $id])
+            ->first();
+        $talks = new Fractal\Resource\Collection($speaker->talks, new TalkTransformer);
 
-        $this->render(200, $results);
+        $this->render(200, $manager->createData($talks)->toArray());
     }
 
     public function createAction()
     {
         throw new \Exception('Not currently impelmented');
     }
-}
+}

src/Lonestar/Controller/Speaker.php

@@ -2,39 +2,27 @@
 
 namespace Lonestar\Controller;
 
+use League\Fractal;
+use Lonestar\Serializer\NoRootArray as NoRootArraySerializer;
+use Lonestar\Transformer\Sponsor as SponsorTransformer;
+
 class Sponsor extends \SlimController\SlimController
 {
-
-    /**
-     * Mapping of sponsor level ID to sponsor level name
-     * @var array
-     */
-    protected $sponsorLevelMap = [
-        4 => 'platinum',
-        3 => 'gold',
-        2 => 'silver',
-        1 => 'bronze',
-        0 => 'community',
-    ];
-
     /**
      * List of sponsors
      */
     public function indexAction()
     {
-        $sponsorMapper = $this->app->spot->mapper('Lonestar\Entity\Sponsor');
+        $manager = (new Fractal\Manager)
+            ->setSerializer(new NoRootArraySerializer);
 
+        $sponsorMapper = $this->app->spot->mapper('Lonestar\Entity\Sponsor');
         $results = $sponsorMapper->all()
-            ->order(['sponsor_level' => 'DESC', 'created_at' => 'ASC'])
-            ->toArray();
-
-        $sponsors = array_map(function($row) {
-            $row['sponsor_level'] = $this->getSponsorshipName($row['sponsor_level']);
+            ->order(['sponsor_level' => 'DESC', 'created_at' => 'ASC']);
 
-            return $row;
-        }, $results);
+        $sponsors = new Fractal\Resource\Collection($results, new SponsorTransformer);
 
-        $this->render(200, $sponsors);
+        $this->render(200, $manager->createData($sponsors)->toArray());
     }
 
     /**
@@ -43,28 +31,16 @@ public function indexAction()
      */
     public function showAction($id)
     {
-        $sponsorMapper = $this->app->spot->mapper('Lonestar\Entity\Sponsor');
+        $manager = (new Fractal\Manager)
+            ->setSerializer(new NoRootArraySerializer);
 
+        $sponsorMapper = $this->app->spot->mapper('Lonestar\Entity\Sponsor');
         $results = $sponsorMapper->all()
             ->where(['id' => (int) $id])
-            ->toArray();
-
-        $this->render(200, $results);
-    }
+            ->first();
 
-    /**
-     * Get the sponsorship name that corresponds with the sponsor level ID
-     *
-     * @param  integer $sponsorLevel Sponsor Level ID
-     * @throws \InvalidArgumentException If sponsor level does not exist in sponsor level map
-     * @return string
-     */
-    protected function getSponsorshipName($sponsorLevel)
-    {
-        if (!isset($this->sponsorLevelMap[$sponsorLevel])) {
-            throw new \InvalidArgumentException('Unknown Sponsorship Level');
-        }
+        $sponsor = new Fractal\Resource\Item($results, new SponsorTransformer);
 
-        return $this->sponsorLevelMap[$sponsorLevel];
+        $this->render(200, $manager->createData($sponsor)->toArray());
     }
-}
+}