From 1c6b5e2cc53ecbf908cce104fa149780474f0e0f Mon Sep 17 00:00:00 2001
From: Michael Chrisco <michaelc@cvtrust.org>
Date: Thu, 6 Oct 2016 13:22:17 -0700
Subject: [PATCH] Add PHPDocs and create/forceCreate methods

---
 composer.json              |  2 +-
 spec/ReadOnlyTraitSpec.php | 23 +++++++++----
 src/ReadOnlyTrait.php      | 70 +++++++++++++++++++++++++++++++++++---
 3 files changed, 83 insertions(+), 12 deletions(-)

diff --git a/composer.json b/composer.json
index 9df4a86..9b74f43 100644
--- a/composer.json
+++ b/composer.json
@@ -11,7 +11,7 @@
       "php": ">=5.5.9"
     },
     "require-dev": {
-        "crysalead/kahlan": "^2.4",
+        "kahlan/kahlan": "^2.4",
         "illuminate/database": ">=5.2.0"
     }
 }
diff --git a/spec/ReadOnlyTraitSpec.php b/spec/ReadOnlyTraitSpec.php
index c6a13cb..3af4774 100644
--- a/spec/ReadOnlyTraitSpec.php
+++ b/spec/ReadOnlyTraitSpec.php
@@ -7,6 +7,22 @@ class User extends Illuminate\Database\Eloquent\Model {
 }
 
 describe("User", function() {
+  describe("::create()", function(){
+
+    it("is expected to return false", function() {
+        $user = new User;
+        expect($user->create([]))->toBe(false);
+        unset($user);
+    });
+ });
+ describe("::forceCreate()", function(){
+
+   it("is expected to return false", function() {
+       $user = new User;
+       expect($user->forceCreate([]))->toBe(false);
+       unset($user);
+   });
+});
   describe("::save()", function(){
 
     it("is expected to return false", function() {
@@ -64,13 +80,6 @@ describe("User", function() {
         unset($user);
     });
    });
-  describe("::test()", function(){
-    it("is expected to return false", function() {
-        $user = new User;
-        expect($user->test())->toBe(false);
-        unset($user);
-    });
-   });
 });
 
 
diff --git a/src/ReadOnlyTrait.php b/src/ReadOnlyTrait.php
index 6c5b719..e215329 100644
--- a/src/ReadOnlyTrait.php
+++ b/src/ReadOnlyTrait.php
@@ -1,39 +1,101 @@
 <?php
 namespace MichaelAChrisco\ReadOnly;
 trait ReadOnlyTrait {
+  /**
+   * returns false on create
+   * @method create
+   * @param  array $attributes
+   * @return false
+   */
+  static function create(array $attributes = []){
+    return false;
+  }
+
+/**
+ * returns false on forceCreate
+ * @method forceCreate
+ * @param  array       $attributes
+ * @return false
+ */
+  static function forceCreate(array $attributes){
+    return false;
+  }
+
+  /**
+   * returns false on save
+   * @method save
+   * @param  array $options
+   * @return false
+   */
   public function save(array $options = []){
     return false;
   }
 
+/**
+ * returns false on update
+ * @method update
+ * @param  [type] $attributes
+ * @param  [type] $options
+ * @return false
+ */
   public function update(array $attributes = [], array $options = []){
     return false;
   }
 
+/**
+ * returns false on firstOrCreate
+ * @method firstOrCreate
+ * @param  array         $arr
+ * @return false
+ */
   static function firstOrCreate(array $arr){
     return false;
   }
 
+/**
+ * returns false on firstOrNew
+ * @method firstOrNew
+ * @param  array      $arr
+ * @return false
+ */
   static function firstOrNew(array $arr){
     return false;
   }
 
+/**
+ * returns false on delete
+ * @method delete
+ * @return false
+ */
   public function delete(){
     return false;
   }
 
+/**
+ * returns false on destroy
+ * @method destroy
+ * @param  mixed  $ids
+ * @return false
+ */
   static function destroy($ids){
     return false;
   }
 
+/**
+ * returns false on restore
+ * @method restore
+ * @return false
+ */
   public function restore(){
     return false;
   }
 
+/**
+ * returns false on forceDelete
+ * @method forceDelete
+ * @return false
+ */
   public function forceDelete(){
     return false;
   }
-
-  public function test(){
-    return false;
-  }
 }