Development snapshot.

Author: judgej

composer.json

@@ -29,7 +29,7 @@
                 "Academe\\Laravel\\ContextualNotes\\ServiceProvider"
             ],
             "aliases": {
-                "AcademeContextualNotes": "Academe\\Laravel\\ContextualNotes\\Facade"
+                "ContextualNotes": "Academe\\Laravel\\ContextualNotes\\Facade"
             }
         }
     }

config/academe-contextual-notes.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * academe-contextual-log
+ * academe-contextual-notes
  */
 
 return [
@@ -11,4 +11,16 @@
     'notables' => [
         'table' => 'contextual_notables',
     ],
+
+    /**
+     * Array of relationship names and classes for the relationship from
+     * a note to a model.
+     * With the example below configured, this will give you a collection of
+     * users that are attached to a note (usually zero or one):
+     *
+     * $note->users;
+     */
+    'models' => [
+        'users' => App\User::class,
+    ],
 ];

database/migrations/2018_02_08_002524_create_notes.php

@@ -19,8 +19,11 @@ public function up()
             $table->bigIncrements('id');
             $table->timestamps();
 
+            // Note level.
+            $table->string('level', 60)->nullable();
+
             // Just a simple message for now.
-            $table->string('message', 255);
+            $table->text('message');
         });
     }
 

src/Models/Note.php

@@ -4,65 +4,96 @@
 
 /**
  * TODO: author
- * TODO: severity
+ * TODO: severity/level
  */
 
 use Illuminate\Database\Eloquent\Model;
+use Log;
 
 class Note extends Model
 {
     protected $fillable = [
+        'level',
         'message',
     ];
 
+    protected $attributes = [
+        'message' => '',
+    ];
+
     public function getTable()
     {
         return config('academe-contextual-notes.notes.table', 'notes');
     }
 
+    /**
+     * Relationship.
+     */
+    public function models($model)
+    {
+        return $this->morphedByMany(
+            $model instanceof Model ? get_class($model) : $model,
+            'notable',
+            config('academe-contextual-notes.notables.table', 'notables')
+        );
+    }
+
     /**
      * Add this note to a single model.
      *
      * @param Model $model any eloquent mndel
      * @return TBC
      */
-    public function addToModel(Model $model)
+    public function attachModel(Model $model)
     {
-        return $this->morphedByMany(
-            $model,
-            'notable',
-            config('academe-contextual-notes.notables.table', 'notables')
-        )->save($model);
+        return $this->models($model)->save($model);
     }
 
     /**
      * Add this note to a list of models.
-     * TODO: more flexibility of the types of lists that can be provided
+     * TODO: more flexibility of the types of lists that can be provided, or
+     * even support varidiac (?) parameters.
      *
      * @param array $models eloquent mndels, of the same or different types
-     * @return null
+     * @return self
      */
-    public function addToModels(array $models)
+    public function attach($models)
     {
+        if (! is_array($models) && ! $models instanceof \Traversable) {
+            $models = [$models];
+        }
+
         foreach ($models as $model) {
-            $this->addToModel($model);
+            if ($model instanceof Model) {
+                $this->attachModel($model);
+            }
         }
+
+        return $this;
     }
 
+    /**
+     * Reverse relationship, defined by config.
+     */
     public function __call($method, $arguments)
     {
-        // Just trying this out.
-        // The method name and model mapping would be set by configuration.
-        // The same functionaility would be in the __get() magic method too.
+        $mapping = config('academe-contextual-notes.models', []);
 
-        if ($method === 'bankTransactions') {
+        if (array_key_exists($method, $mapping)) {
             return $this->morphedByMany(
-                'Consilience\Bluejay\Ledger\Models\BankTransaction',
+                $mapping[$method],
                 'notable',
                 config('academe-contextual-notes.notables.table', 'notables')
             );
         }
 
         return parent::__call($method, $arguments);
     }
+
+    /**
+     * Write a log entry for this note, to the default log.
+     */
+    public function withLog()
+    {
+    }
 }

src/Service.php

@@ -6,12 +6,63 @@
  *
  */
 
+use Academe\Laravel\ContextualNotes\Models\Note;
+
 class Service
 {
-    //protected $helper;
+    public function createLevel($level, $message, array $context = [])
+    {
+        $note = new Note([
+            'level' => $level,
+            'message' => $message,
+        ]);
+
+        $note->save();
+
+        if (! empty($context)) {
+            $note->attach($context);
+        }
+
+        return $note;
+    }
+
+    public function emergency($message, array $context = [])
+    {
+        return $this->createLevel('emergency', $message, $context);
+    }
+
+    public function alert($message, array $context = [])
+    {
+        return $this->createLevel('alert', $message, $context);
+    }
+
+    public function critical($message, array $context = [])
+    {
+        return $this->createLevel('critical', $message, $context);
+    }
+
+    public function error($message, array $context = [])
+    {
+        return $this->createLevel('error', $message, $context);
+    }
+
+    public function warning($message, array $context = [])
+    {
+        return $this->createLevel('warning', $message, $context);
+    }
+
+    public function notice($message, array $context = [])
+    {
+        return $this->createLevel('notice', $message, $context);
+    }
+
+    public function info($message, array $context = [])
+    {
+        return $this->createLevel('info', $message, $context);
+    }
 
-    public function __construct()
+    public function debug($message, array $context = [])
     {
-        //$this->helper = new Helper();
+        return $this->createLevel('debug', $message, $context);
     }
 }

src/Traits/HasNotes.php

@@ -6,12 +6,14 @@
  *
  */
 
+use Academe\Laravel\ContextualNotes\Models\Note;
+
 trait HasNotes
 {
-    public function notes()
+    public function contextualNotes()
     {
         return $this->morphToMany(
-            'Academe\Laravel\ContextualNotes\Models\Note',
+            Note::class,
             'notable',
             config('academe-contextual-notes.notables.table', 'notables')
         );