Added Fractal Support for compactparameters

Author: Fabian Widmann

composer.json

@@ -12,7 +12,8 @@
   "require": {
     "mjaschen/phpgeo": "^1.3",
     "nesbot/carbon": "^1.22",
-    "monolog/monolog": "~1.12"
+    "monolog/monolog": "~1.12",
+    "league/fractal": "^0.17.0"
   },
   "autoload": {
     "psr-0": {

composer.lock

@@ -3,6 +3,10 @@
 use FWidm\DWDHourlyCrawler\DWDLib;
 use FWidm\DWDHourlyCrawler\Hourly\Variables\DWDHourlyParameters;
 use FWidm\DWDHourlyCrawler\Model\DWDCompactParameter;
+use FWidm\DWDHourlyCrawler\Transformer\CompactParameterTransformer;
+use League\Fractal\Manager;
+use League\Fractal\Serializer\ArraySerializer;
+use League\Fractal\Serializer\DataArraySerializer;
 use Location\Coordinate;
 use Location\Formatter\Coordinate\GeoJSON;
 use Carbon\Carbon;
@@ -65,5 +69,12 @@ function prettyPrint($obj)
 print "<hr>";
 $dwdCompact = new DWDCompactParameter(1,["a"=>"b"],"none",100.3,10,20,Carbon::now(),2030.45,"x");
 var_dump($dwdCompact);
-prettyPrint(json_encode([$dwdCompact],JSON_PRETTY_PRINT));
-prettyPrint($dwdCompact->getVarArray());
+
+prettyPrint(json_encode($dwdCompact));
+$resource=$dwdCompact->toResource();
+
+$manager = new Manager();
+$manager->setSerializer(new ArraySerializer());
+
+// Run all transformers
+prettyPrint($manager->createData($resource)->toJson(JSON_PRETTY_PRINT));

dwd_geo_test.php

@@ -84,7 +84,7 @@ public function getDate(): DateTime
     }
 
 
-    public function exportSingleVariables():array
+    public function exportSingleVariables(): array
     {
         return [
             new DWDCompactParameter($this->stationId,

src/fwidm/dwdHourlyCrawler/model/DWDCloudiness.php

@@ -9,11 +9,17 @@
 namespace FWidm\DWDHourlyCrawler\Model;
 
 use Carbon\Carbon;
+use FWidm\DWDHourlyCrawler\Exceptions\DWDLibException;
+use FWidm\DWDHourlyCrawler\Transformer\CompactParameterTransformer;
+use League\Fractal\Manager;
+use League\Fractal\Resource\Item;
+use League\Fractal\Serializer\ArraySerializer;
+use League\Fractal\Serializer\DataArraySerializer;
 
 /**
  * Class DWDCompactParameter
  * @package FWidm\DWDHourlyCrawler\fwidm\dwdHourlyCrawler\model
- * @author Fabian Widmann <fabian.widmann@uni-ulm.de>
+ * @author Fabian Widmann <fabian.widmann@gmail.com>
  * target: json
  * "$variable": [
  * {
@@ -78,10 +84,7 @@ public function __construct($stationID, $description, $classification, $distance
      */
     function jsonSerialize()
     {
-        $vars = get_object_vars($this);
-        //replace standard format by ISO DateTime::ATOM Format.
-        $vars['date'] = $this->date->toIso8601String();
-        return $vars;
+        return $this->toArray();
     }
 
     /**
@@ -161,9 +164,32 @@ public function __toString()
         return "DWDCompactParameter: [type=" . $this->type . "; classification=" . $this->getClassification() . "; value=" . $this->value . "]";
     }
 
-    public function getVarArray(): array
+    /**
+     * Applies the default (or given) transformer to this object, returns a fractal resource containing the values of the object.
+     * @param string $customTransformer
+     * @return Item
+     */
+    public function toResource($customTransformer = CompactParameterTransformer::class): Item
     {
-        return get_object_vars($this);
+        try {
+            $resource = new Item($this, new $customTransformer());
+            return $resource;
+
+        } catch (\Error $e) {
+            throw new DWDLibException("Specified transformer is not a class. Got transformer class=$customTransformer");
+        }
     }
 
+    /** Uses the given serializer and transformer to transform $this into an array of the expected format.
+     * @param string $serializer
+     * @param string $transformer
+     * @return array
+     */
+    function toArray($serializer = ArraySerializer::class, $transformer = CompactParameterTransformer::class)
+    {
+        $resource = $this->toResource(new $transformer());
+        $manager = new Manager();
+        $manager->setSerializer(new $serializer());
+        return $manager->createData($resource)->toArray();
+    }
 }

src/fwidm/dwdHourlyCrawler/model/DWDCompactParameter.php

@@ -0,0 +1,31 @@
+<?php
+/**
+ * User: Fabian Widmann
+ * Date: 30.11.17
+ * Time: 15:37
+ */
+
+namespace FWidm\DWDHourlyCrawler\Transformer;
+
+
+use FWidm\DWDHourlyCrawler\Model\DWDCompactParameter;
+use League\Fractal\TransformerAbstract;
+
+class CompactParameterTransformer extends TransformerAbstract
+{
+    public function transform(DWDCompactParameter $parameter)
+    {
+        return [
+            'station_id' => $parameter->getStationID(),
+            'description' => $parameter->getDescription(),
+            'classification' => $parameter->getClassification(),
+            'distance' => $parameter->getDistance(),
+            'lon' => $parameter->getLongitude(),
+            'lat' => $parameter->getLatitude(),
+            'date' => $parameter->getDate()->toIso8601String(),
+            'value' => $parameter->getValue(),
+            'type' => $parameter->getType(),
+        ];
+    }
+
+}