Merge pull request #24 from cybercog/feature/implement-all-helpers

Implement all helpers common methods

Author: Pe Ell

CHANGELOG.md

@@ -2,6 +2,21 @@
 
 All notable changes to `laravel-eloquent-flag` will be documented in this file.
 
+## [3.7.0] - 2017-01-14
+
+### Added
+
+- `setKeptOnUpdate` property in `HasKeptFlagBehavior` to control events.
+
+### Changed
+
+- `HasAcceptedAtHelpers` methods implemented.
+- `HasAcceptedFlagHelpers` methods implemented.
+- `HasActiveFlagHelpers` methods implemented.
+- `HasKeptFlagHelpers` methods implemented.
+- `HasPublishedAtHelpers` methods implemented.
+- `HasPublishedFlagHelpers` methods implemented.
+
 ## [3.6.0] - 2017-01-14
 
 ### Added
@@ -106,6 +121,7 @@ All notable changes to `laravel-eloquent-flag` will be documented in this file.
 
 - `is_active` boolean flag added.
 
+[3.7.0]: https://github.com/cybercog/laravel-eloquent-flag/compare/3.6.0...3.7.0
 [3.6.0]: https://github.com/cybercog/laravel-eloquent-flag/compare/3.5.0...3.6.0
 [3.5.0]: https://github.com/cybercog/laravel-eloquent-flag/compare/3.4.0...3.5.0
 [3.4.0]: https://github.com/cybercog/laravel-eloquent-flag/compare/3.3.0...3.4.0

README.md

@@ -22,7 +22,7 @@ Eloquent boolean & timestamp flagged attributes behavior. Enhance eloquent model
 
 ## Available flags list
 
-| Trait name | Logic | Database columns | Flag type | Conflict |
+| Trait name | Logic | Database column | Flag type | Conflict |
 | ---------- | ----- | ---------------- | --------- | -------- |
 | `HasAcceptedAt` | Classic | `accepted_at` | Timestamp | `HasAcceptedFlag` |
 | `HasAcceptedFlag` | Classic | `is_accepted` | Boolean | `HasAcceptedAt` |

src/Traits/Classic/HasAcceptedAtHelpers.php

@@ -11,12 +11,80 @@
 
 namespace Cog\Flag\Traits\Classic;
 
+use Carbon\Carbon;
+
 /**
  * Class HasAcceptedAtHelpers.
  *
  * @package Cog\Flag\Traits\Classic
  */
 trait HasAcceptedAtHelpers
 {
-    //
+    /**
+     * Set accepted flag.
+     *
+     * @return static
+     */
+    public function setAcceptedFlag()
+    {
+        $this->accepted_at = Carbon::now();
+
+        return $this;
+    }
+
+    /**
+     * Unset accepted flag.
+     *
+     * @return static
+     */
+    public function unsetAcceptedFlag()
+    {
+        $this->accepted_at = null;
+
+        return $this;
+    }
+
+    /**
+     * If entity is accepted.
+     *
+     * @return bool
+     */
+    public function isAccepted()
+    {
+        return !is_null($this->accepted_at);
+    }
+
+    /**
+     * If entity is rejected.
+     *
+     * @return bool
+     */
+    public function isRejected()
+    {
+        return !$this->isAccepted();
+    }
+
+    /**
+     * Mark entity as accepted.
+     *
+     * @return void
+     */
+    public function accept()
+    {
+        $this->setAcceptedFlag()->save();
+
+        // :TODO: Fire an event here
+    }
+
+    /**
+     * Mark entity as rejected.
+     *
+     * @return void
+     */
+    public function reject()
+    {
+        $this->unsetAcceptedFlag()->save();
+
+        // :TODO: Fire an event here
+    }
 }

src/Traits/Classic/HasAcceptedFlagHelpers.php

@@ -18,5 +18,71 @@
  */
 trait HasAcceptedFlagHelpers
 {
-    //
+    /**
+     * Set accepted flag.
+     *
+     * @return static
+     */
+    public function setAcceptedFlag()
+    {
+        $this->is_accepted = true;
+
+        return $this;
+    }
+
+    /**
+     * Unset accepted flag.
+     *
+     * @return static
+     */
+    public function unsetAcceptedFlag()
+    {
+        $this->is_accepted = false;
+
+        return $this;
+    }
+
+    /**
+     * If entity is accepted.
+     *
+     * @return bool
+     */
+    public function isAccepted()
+    {
+        return (bool) $this->is_accepted;
+    }
+
+    /**
+     * If entity is rejected.
+     *
+     * @return bool
+     */
+    public function isRejected()
+    {
+        return !$this->isAccepted();
+    }
+
+    /**
+     * Mark entity as accepted.
+     *
+     * @return void
+     */
+    public function accept()
+    {
+        $this->setAcceptedFlag()->save();
+
+        // :TODO: Fire an event here
+    }
+
+    /**
+     * Mark entity as rejected.
+     *
+     * @return void
+     */
+    public function reject()
+    {
+        $this->unsetAcceptedFlag()->save();
+
+        // :TODO: Fire an event here
+    }
 }

src/Traits/Classic/HasActiveFlagHelpers.php

@@ -18,5 +18,71 @@
  */
 trait HasActiveFlagHelpers
 {
-    //
+    /**
+     * Set active flag.
+     *
+     * @return static
+     */
+    public function setActivatedFlag()
+    {
+        $this->is_active = true;
+
+        return $this;
+    }
+
+    /**
+     * Unset active flag.
+     *
+     * @return static
+     */
+    public function unsetActivatedFlag()
+    {
+        $this->is_active = false;
+
+        return $this;
+    }
+
+    /**
+     * If entity is activated.
+     *
+     * @return bool
+     */
+    public function isActivated()
+    {
+        return (bool) $this->is_active;
+    }
+
+    /**
+     * If entity is deactivated.
+     *
+     * @return bool
+     */
+    public function isDeactivated()
+    {
+        return !$this->isActivated();
+    }
+
+    /**
+     * Mark entity as active.
+     *
+     * @return void
+     */
+    public function activate()
+    {
+        $this->setActivatedFlag()->save();
+
+        // :TODO: Fire an event here
+    }
+
+    /**
+     * Mark entity as deactivated.
+     *
+     * @return void
+     */
+    public function deactivate()
+    {
+        $this->unsetActivatedFlag()->save();
+
+        // :TODO: Fire an event here
+    }
 }

src/Traits/Classic/HasApprovedAtHelpers.php

@@ -77,7 +77,7 @@ public function approve()
     }
 
     /**
-     * Mark entity as rejected.
+     * Mark entity as disapproved.
      *
      * @return void
      */

src/Traits/Classic/HasApprovedFlagHelpers.php

@@ -49,7 +49,7 @@ public function unsetApprovedFlag()
      */
     public function isApproved()
     {
-        return boolval($this->is_approved);
+        return (bool) $this->is_approved;
     }
 
     /**
@@ -75,7 +75,7 @@ public function approve()
     }
 
     /**
-     * Mark entity as rejected.
+     * Mark entity as disapproved.
      *
      * @return void
      */

src/Traits/Classic/HasKeptFlagBehavior.php

@@ -18,6 +18,13 @@
  */
 trait HasKeptFlagBehavior
 {
+    /**
+     * Set `is_kept = true` on entity update.
+     *
+     * @var bool
+     */
+    protected $setKeptOnUpdate = true;
+
     /**
      * Boot the bootHasKeptFlagBehavior trait for a model.
      *
@@ -32,7 +39,7 @@ public static function bootHasKeptFlagBehavior()
         });
 
         static::updating(function ($entity) {
-            if (!$entity->is_kept) {
+            if (!$entity->is_kept && $entity->setKeptOnUpdate) {
                 $entity->is_kept = true;
             }
         });

src/Traits/Classic/HasKeptFlagHelpers.php

@@ -23,7 +23,34 @@
 trait HasKeptFlagHelpers
 {
     /**
-     * Determine if the model instance has `is_kept` state.
+     * Set kept flag.
+     *
+     * @return static
+     */
+    public function setKeptFlag()
+    {
+        $this->is_kept = true;
+
+        return $this;
+    }
+
+    /**
+     * Unset kept flag.
+     *
+     * @return static
+     */
+    public function unsetKeptFlag()
+    {
+        $this->is_kept = false;
+        if (property_exists($this, 'setKeptOnUpdate')) {
+            $this->setKeptOnUpdate = false;
+        }
+
+        return $this;
+    }
+
+    /**
+     * If entity is kept.
      *
      * @return bool
      */
@@ -32,6 +59,40 @@ public function isKept()
         return (bool) $this->is_kept;
     }
 
+    /**
+     * If entity is unkept.
+     *
+     * @return bool
+     */
+    public function isUnkept()
+    {
+        return !$this->isKept();
+    }
+
+    /**
+     * Mark entity as kept.
+     *
+     * @return void
+     */
+    public function keep()
+    {
+        $this->setKeptFlag()->save();
+
+        // :TODO: Fire an event here
+    }
+
+    /**
+     * Mark entity as unkept.
+     *
+     * @return void
+     */
+    public function unkeep()
+    {
+        $this->unsetKeptFlag()->save();
+
+        // :TODO: Fire an event here
+    }
+
     /**
      * Get unkept models that are older than the given number of hours.
      *