Code for optional fields #301

Signed-off-by: James Cole <thegrumpydictator@gmail.com>

app/Models/TransactionJournal.php

@@ -14,10 +14,13 @@ namespace FireflyIII\Models;
 use Auth;
 use Carbon\Carbon;
 use Crypt;
+use FireflyIII\Support\CacheProperties;
 use FireflyIII\Support\Models\TransactionJournalSupport;
 use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Database\Eloquent\SoftDeletes;
+use Log;
+use Preferences;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 use Watson\Validating\ValidatingTrait;
 
@@ -171,6 +174,18 @@ class TransactionJournal extends TransactionJournalSupport
         return $this->belongsToMany('FireflyIII\Models\Category');
     }
 
+    /**
+     * @param string $name
+     *
+     * @return bool
+     */
+    public function deleteMeta(string $name):bool
+    {
+        $this->transactionJournalMeta()->where('name', $name)->delete();
+
+        return true;
+    }
+
     /**
      *
      * @param $value
@@ -188,19 +203,38 @@ class TransactionJournal extends TransactionJournalSupport
 
     /**
      *
-     * @param string $fieldName
+     * @param string $name
      *
      * @return string
      */
-    public function getMeta($fieldName)
+    public function getMeta(string $name)
     {
-        foreach ($this->transactionjournalmeta as $meta) {
-            if ($meta->name == $fieldName) {
-                return $meta->data;
-            }
+        $value = null;
+        $cache = new CacheProperties;
+        $cache->addProperty('journal-meta');
+        $cache->addProperty($this->id);
+        $cache->addProperty($name);
+
+        if ($cache->has()) {
+            return $cache->get();
         }
 
-        return '';
+        Log::debug(sprintf('Looking for journal #%d meta field "%s".', $this->id, $name));
+        $entry = $this->transactionJournalMeta()->where('name', $name)->first();
+        if (!is_null($entry)) {
+            $value = $entry->data;
+            // cache:
+            $cache->store($value);
+        }
+
+        // convert to Carbon if name is _date
+        if (!is_null($value) && substr($name, -5) === '_date') {
+            $value = new Carbon($value);
+            // cache:
+            $cache->store($value);
+        }
+
+        return $value;
     }
 
     /**
@@ -354,6 +388,38 @@ class TransactionJournal extends TransactionJournalSupport
         $this->attributes['encrypted']   = true;
     }
 
+    /**
+     * @param string $name
+     * @param        $value
+     *
+     * @return TransactionJournalMeta
+     */
+    public function setMeta(string $name, $value): TransactionJournalMeta
+    {
+        if (is_null($value)) {
+            $this->deleteMeta($name);
+
+            return new TransactionJournalMeta();
+        }
+
+        if ($value instanceof Carbon) {
+            $value = $value->toW3cString();
+        }
+
+        Log::debug(sprintf('Going to set "%s" with value "%s"', $name, json_encode($value)));
+        $entry = $this->transactionJournalMeta()->where('name', $name)->first();
+        if (is_null($entry)) {
+            $entry = new TransactionJournalMeta();
+            $entry->transactionJournal()->associate($this);
+            $entry->name = $name;
+        }
+        $entry->data = $value;
+        $entry->save();
+        Preferences::mark();
+
+        return $entry;
+    }
+
     /**
      * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
      */
@@ -370,6 +436,14 @@ class TransactionJournal extends TransactionJournalSupport
         return $this->belongsTo('FireflyIII\Models\TransactionCurrency');
     }
 
+    /**
+     * @return HasMany
+     */
+    public function transactionJournalMeta(): HasMany
+    {
+        return $this->hasMany('FireflyIII\Models\TransactionJournalMeta');
+    }
+
     /**
      * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
      */
@@ -378,22 +452,6 @@ class TransactionJournal extends TransactionJournalSupport
         return $this->belongsTo('FireflyIII\Models\TransactionType');
     }
 
-    /**
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
-     */
-    public function transactiongroups()
-    {
-        return $this->belongsToMany('FireflyIII\Models\TransactionGroup');
-    }
-
-    /**
-     * @return HasMany
-     */
-    public function transactionjournalmeta(): HasMany
-    {
-        return $this->hasMany('FireflyIII\Models\TransactionJournalMeta');
-    }
-
     /**
      * @return \Illuminate\Database\Eloquent\Relations\HasMany
      */
@@ -409,4 +467,5 @@ class TransactionJournal extends TransactionJournalSupport
     {
         return $this->belongsTo('FireflyIII\User');
     }
+
 }