Add ended and invited flags

.gitignore

@@ -3,3 +3,4 @@ vendor/
 composer.lock
 composer.phar
 phpunit.xml
+.idea/

README.md

@@ -52,8 +52,12 @@ Eloquent boolean & timestamp flagged attributes behavior. Enhance eloquent model
 | `HasApprovedFlag` | Classic | `is_approved` | Boolean | `HasApprovedAt` |
 | `HasClosedAt` | Inverse | `closed_at` | Timestamp | `HasClosedFlag` |
 | `HasClosedFlag` | Inverse | `is_closed` | Boolean | `HasClosedAt` |
+| `HasEndedAt` | Inverse | `ended_at` | Timestamp | `HasEndedFlag` |
+| `HasEndededFlag` | Inverse | `is_ended` | Boolean | `HasEndedAt` |
 | `HasExpiredAt` | Inverse | `expired_at` | Timestamp | `HasExpiredFlag` |
 | `HasExpiredFlag` | Inverse | `is_expired` | Boolean | `HasExpiredAt` |
+| `HasInvitedAt` | Classic | `invited_at` | Timestamp | `HasInvitedFlag` |
+| `HasInvitedFlag` | Classic | `is_invited` | Boolean | `HasInvitedAt` |
 | `HasKeptFlag` | Classic | `is_kept` | Boolean | - |
 | `HasPublishedAt` | Classic | `published_at` | Timestamp | `HasPublishedFlag` |
 | `HasPublishedFlag` | Classic | `is_published` | Boolean | `HasPublishedAt` |

composer.json

@@ -33,7 +33,8 @@
         "closed",
         "opened",
         "expiry",
-        "expired"
+        "expired",
+        "ended"
     ],
     "authors": [
         {

src/Scopes/Classic/InvitedAtScope.php

@@ -0,0 +1,128 @@
+<?php
+
+/*
+ * This file is part of Laravel Eloquent Flag.
+ *
+ * (c) Anton Komarev <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Cog\Flag\Scopes\Classic;
+
+use Carbon\Carbon;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Scope;
+
+/**
+ * Class InvitedAtScope.
+ *
+ * @package Cog\Flag\Scopes\Classic
+ */
+class InvitedAtScope implements Scope
+{
+    /**
+     * All of the extensions to be added to the builder.
+     *
+     * @var array
+     */
+    protected $extensions = ['Invite', 'Uninvite', 'WithUninvited', 'WithoutUninvited', 'OnlyUninvited'];
+
+    /**
+     * Apply the scope to a given Eloquent query builder.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $builder
+     * @param \Illuminate\Database\Eloquent\Model $model
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function apply(Builder $builder, Model $model)
+    {
+        if (method_exists($model, 'shouldApplyInvitedAtScope') && !$model->shouldApplyInvitedAtScope()) {
+            return $builder;
+        }
+
+        return $builder->whereNotNull('invited_at');
+    }
+
+    /**
+     * Extend the query builder with the needed functions.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $builder
+     * @return void
+     */
+    public function extend(Builder $builder)
+    {
+        foreach ($this->extensions as $extension) {
+            $this->{"add{$extension}"}($builder);
+        }
+    }
+
+    /**
+     * Add the `invite` extension to the builder.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $builder
+     * @return void
+     */
+    protected function addInvite(Builder $builder)
+    {
+        $builder->macro('invite', function (Builder $builder) {
+            $builder->withUninvited();
+
+            return $builder->update(['invited_at' => Carbon::now()]);
+        });
+    }
+
+    /**
+     * Add the `uninvite` extension to the builder.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $builder
+     * @return void
+     */
+    protected function addUninvite(Builder $builder)
+    {
+        $builder->macro('uninvite', function (Builder $builder) {
+            return $builder->update(['invited_at' => null]);
+        });
+    }
+
+    /**
+     * Add the `withUninvited` extension to the builder.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $builder
+     * @return void
+     */
+    protected function addWithUninvited(Builder $builder)
+    {
+        $builder->macro('withUninvited', function (Builder $builder) {
+            return $builder->withoutGlobalScope($this);
+        });
+    }
+
+    /**
+     * Add the `withoutUninvited` extension to the builder.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $builder
+     * @return void
+     */
+    protected function addWithoutUninvited(Builder $builder)
+    {
+        $builder->macro('withoutUninvited', function (Builder $builder) {
+            return $builder->withoutGlobalScope($this)->whereNotNull('invited_at');
+        });
+    }
+
+    /**
+     * Add the `onlyUninvited` extension to the builder.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $builder
+     * @return void
+     */
+    protected function addOnlyUninvited(Builder $builder)
+    {
+        $builder->macro('onlyUninvited', function (Builder $builder) {
+            return $builder->withoutGlobalScope($this)->whereNull('invited_at');
+        });
+    }
+}

src/Scopes/Classic/InvitedFlagScope.php

@@ -0,0 +1,127 @@
+<?php
+
+/*
+ * This file is part of Laravel Eloquent Flag.
+ *
+ * (c) Anton Komarev <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Cog\Flag\Scopes\Classic;
+
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Scope;
+
+/**
+ * Class InvitedFlagScope.
+ *
+ * @package Cog\Flag\Scopes\Classic
+ */
+class InvitedFlagScope implements Scope
+{
+    /**
+     * All of the extensions to be added to the builder.
+     *
+     * @var array
+     */
+    protected $extensions = ['Invite', 'Uninvite', 'WithUninvited', 'WithoutUninvited', 'OnlyUninvited'];
+
+    /**
+     * Apply the scope to a given Eloquent query builder.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $builder
+     * @param \Illuminate\Database\Eloquent\Model $model
+     * @return \Illuminate\Database\Eloquent\Builder
+     */
+    public function apply(Builder $builder, Model $model)
+    {
+        if (method_exists($model, 'shouldApplyInvitedFlagScope') && !$model->shouldApplyInvitedFlagScope()) {
+            return $builder;
+        }
+
+        return $builder->where('is_invited', 1);
+    }
+
+    /**
+     * Extend the query builder with the needed functions.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $builder
+     * @return void
+     */
+    public function extend(Builder $builder)
+    {
+        foreach ($this->extensions as $extension) {
+            $this->{"add{$extension}"}($builder);
+        }
+    }
+
+    /**
+     * Add the `invite` extension to the builder.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $builder
+     * @return void
+     */
+    protected function addInvite(Builder $builder)
+    {
+        $builder->macro('invite', function (Builder $builder) {
+            $builder->withUninvited();
+
+            return $builder->update(['is_invited' => 1]);
+        });
+    }
+
+    /**
+     * Add the `uninvite` extension to the builder.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $builder
+     * @return void
+     */
+    protected function addUninvite(Builder $builder)
+    {
+        $builder->macro('uninvite', function (Builder $builder) {
+            return $builder->update(['is_invited' => 0]);
+        });
+    }
+
+    /**
+     * Add the `withUninvited` extension to the builder.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $builder
+     * @return void
+     */
+    protected function addWithUninvited(Builder $builder)
+    {
+        $builder->macro('withUninvited', function (Builder $builder) {
+            return $builder->withoutGlobalScope($this);
+        });
+    }
+
+    /**
+     * Add the `withoutUninvited` extension to the builder.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $builder
+     * @return void
+     */
+    protected function addWithoutUninvited(Builder $builder)
+    {
+        $builder->macro('withoutUninvited', function (Builder $builder) {
+            return $builder->withoutGlobalScope($this)->where('is_invited', 1);
+        });
+    }
+
+    /**
+     * Add the `onlyUninvited` extension to the builder.
+     *
+     * @param \Illuminate\Database\Eloquent\Builder $builder
+     * @return void
+     */
+    protected function addOnlyUninvited(Builder $builder)
+    {
+        $builder->macro('onlyUninvited', function (Builder $builder) {
+            return $builder->withoutGlobalScope($this)->where('is_invited', 0);
+        });
+    }
+}