SimBrief integration #405 (#635)

* SimBrief integration #405 * Add briefing as API response; add acars_xml field #405
2020-03-23 09:31:35 -04:00
parent 04b9e37e1d
commit 9e5386264f
70 changed files with 6816 additions and 192 deletions
--- a/app/Models/SimBrief.php
+++ b/app/Models/SimBrief.php
@@ -0,0 +1,98 @@
+<?php
+
+namespace App\Models;
+
+use App\Contracts\Model;
+use Illuminate\Support\Collection;
+
+/**
+ * @property string      $id        The Simbrief OFP ID
+ * @property int         $user_id   The user that generated this
+ * @property string      $flight_id Optional, if attached to a flight, removed if attached to PIREP
+ * @property string      $pirep_id  Optional, if attached to a PIREP, removed if attached to flight
+ * @property string      $acars_xml
+ * @property string      $ofp_xml
+ * @property string      $ofp_html
+ * @property Collection  $images
+ * @property Collection  $files
+ * @property Flight      $flight
+ * @property User        $user
+ * @property SimBriefXML $xml
+ * @property string      $acars_flightplan_url
+ */
+class SimBrief extends Model
+{
+    public $table = 'simbrief';
+    public $incrementing = false;
+
+    protected $fillable = [
+        'id',
+        'user_id',
+        'flight_id',
+        'pirep_id',
+        'acars_xml',
+        'ofp_xml',
+        'created_at',
+        'updated_at',
+    ];
+
+    /** @var \App\Models\SimBriefXML Store a cached version of the XML object */
+    private $xml_instance;
+
+    /**
+     * Return a SimpleXML object of the $ofp_xml
+     *
+     * @return \App\Models\SimBriefXML|null
+     */
+    public function getXmlAttribute(): SimBriefXML
+    {
+        if (empty($this->attributes['ofp_xml'])) {
+            return null;
+        }
+
+        if (!$this->xml_instance) {
+            $this->xml_instance = simplexml_load_string(
+                $this->attributes['ofp_xml'],
+                SimBriefXML::class
+            );
+        }
+
+        return $this->xml_instance;
+    }
+
+    /**
+     * Returns a list of images
+     */
+    public function getImagesAttribute(): Collection
+    {
+        return $this->xml->getImages();
+    }
+
+    /**
+     * Return all of the flight plans
+     */
+    public function getFilesAttribute(): Collection
+    {
+        return $this->xml->getFlightPlans();
+    }
+
+    /*
+     * Relationships
+     */
+
+    public function flight()
+    {
+        if (!empty($this->attributes['flight_id'])) {
+            return $this->belongsTo(Flight::class, 'flight_id');
+        }
+
+        if (!empty($this->attributes['pirep_id'])) {
+            return $this->belongsTo(Pirep::class, 'pirep_id');
+        }
+    }
+
+    public function user()
+    {
+        return $this->belongsTo(User::class, 'user_id');
+    }
+}