actions, traits

Author: goshasafonov

src/Actions/.gitkeep

@@ -0,0 +1,41 @@
+<?php
+
+namespace Yuges\Groupable\Actions;
+
+use Yuges\Groupable\Models\Group;
+use Illuminate\Support\Collection;
+use Yuges\Groupable\Config\Config;
+use Yuges\Groupable\Interfaces\Groupable;
+
+class AttachGroupsAction
+{
+    public function __construct(
+        protected Groupable $groupable
+    ) {
+    }
+
+    public static function create(Groupable $groupable): self
+    {
+        return new static($groupable);
+    }
+
+    /**
+     * @param Collection<array-key, Group> $groups
+     */
+    public function execute(Collection $groups): Groupable
+    {
+        $ids = $groups
+            ->map(function (Group $group) {
+                return $group->id;
+            })
+            ->filter(function (mixed $value) {
+                return (bool) $value;
+            });
+
+        $groups = Config::getGroupClass(Group::class)::query()->getQuery()->whereIn('id', $ids)->get();
+
+        $this->groupable->groups()->sync($groups->pluck('id'), false);
+
+        return $this->groupable;
+    }
+}

src/Actions/AttachGroupsAction.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Yuges\Groupable\Actions;
+
+use Yuges\Groupable\Models\Group;
+use Illuminate\Support\Collection;
+use Yuges\Groupable\Interfaces\Groupable;
+
+class DetachGroupsAction
+{
+    public function __construct(
+        protected Groupable $groupable
+    ) {
+    }
+
+    public static function create(Groupable $groupable): self
+    {
+        return new static($groupable);
+    }
+
+    /**
+     * @param Collection<array-key, Group> $groups
+     */
+    public function execute(Collection $groups): Groupable
+    {
+        $ids = $groups
+            ->map(function (Group $group) {
+                return $group->id;
+            })
+            ->filter(function (mixed $value) {
+                return (bool) $value;
+            });
+
+        $this->groupable->groups()->detach($ids);
+
+        return $this->groupable;
+    }
+}

src/Actions/DetachGroupsAction.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Yuges\Groupable\Actions;
+
+use Yuges\Groupable\Models\Group;
+use Illuminate\Support\Collection;
+use Yuges\Groupable\Interfaces\Groupable;
+
+class SyncGroupsAction
+{
+    public function __construct(
+        protected Groupable $groupable
+    ) {
+    }
+
+    public static function create(Groupable $groupable): self
+    {
+        return new static($groupable);
+    }
+
+    /**
+     * @param Collection<array-key, Group> $groups
+     */
+    public function execute(Collection $groups): Groupable
+    {
+        $ids = $groups
+            ->map(function (Group $group) {
+                return $group->id;
+            })
+            ->filter(function (mixed $value) {
+                return (bool) $value;
+            });
+
+        $this->groupable->groups()->sync($ids);
+
+        return $this->groupable;
+    }
+}

src/Actions/SyncGroupsAction.php

@@ -7,7 +7,11 @@
 use Illuminate\Support\Collection;
 use Yuges\Groupable\Models\Groupable;
 use Yuges\Groupable\Observers\GroupObserver;
+use Yuges\Groupable\Actions\SyncGroupsAction;
+use Yuges\Groupable\Actions\AttachGroupsAction;
+use Yuges\Groupable\Actions\DetachGroupsAction;
 use Yuges\Groupable\Observers\GroupableObserver;
+use Yuges\Groupable\Interfaces\Groupable as GroupableInterface;
 
 class Config extends \Yuges\Package\Config\Config
 {
@@ -64,4 +68,46 @@ public static function getGroupableObserverClass(mixed $default = null): string
     {
         return self::get('models.Groupable.observer', $default);
     }
+
+    public static function getSyncGroupsAction(
+        GroupableInterface $groupable,
+        mixed $default = null
+    ): SyncGroupsAction
+    {
+        return self::getSyncGroupsActionClass($default)::create($groupable);
+    }
+
+    /** @return class-string<SyncGroupsAction> */
+    public static function getSyncGroupsActionClass(mixed $default = null): string
+    {
+        return self::get('actions.sync', $default);
+    }
+
+    public static function getAttachGroupsAction(
+        GroupableInterface $groupable,
+        mixed $default = null
+    ): AttachGroupsAction
+    {
+        return self::getAttachGroupsActionClass($default)::create($groupable);
+    }
+
+    /** @return class-string<AttachGroupsAction> */
+    public static function getAttachGroupsActionClass(mixed $default = null): string
+    {
+        return self::get('actions.attach', $default);
+    }
+
+    public static function getDetachGroupsAction(
+        GroupableInterface $groupable,
+        mixed $default = null
+    ): DetachGroupsAction
+    {
+        return self::getDetachGroupsActionClass($default)::create($groupable);
+    }
+
+    /** @return class-string<DetachGroupsAction> */
+    public static function getDetachGroupsActionClass(mixed $default = null): string
+    {
+        return self::get('actions.detach', $default);
+    }
 }

src/Config/Config.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Yuges\Groupable\Interfaces;
+
+use Yuges\Groupable\Models\Group;
+use Illuminate\Support\Collection;
+use Illuminate\Database\Eloquent\Relations\MorphToMany;
+
+interface Groupable
+{
+    public function groups(): MorphToMany;
+
+    public function group(Group $group): static;
+
+    public function ungroup(Group $group): static;
+
+    public function attachGroup(Group $group): static;
+
+    public function attachGroups(Collection $groups): static;
+
+    public function detachGroup(Group $group): static;
+
+    public function detachGroups(Collection $groups): static;
+
+    public function syncGroups(Collection $groups): static;
+}

src/Interfaces/.gitkeep

@@ -5,6 +5,7 @@
 use Yuges\Package\Models\Model;
 use Yuges\Groupable\Config\Config;
 use Yuges\Sluggable\Traits\HasSlug;
+use Yuges\Groupable\Traits\HasParent;
 use Yuges\Sluggable\Options\SlugOptions;
 use Yuges\Sluggable\Interfaces\Sluggable;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
@@ -16,7 +17,7 @@
  */
 class Group extends Model implements Sluggable
 {
-    use HasFactory, HasSlug;
+    use HasFactory, HasParent, HasSlug;
 
     protected $table = 'groups';
 

src/Interfaces/Groupable.php

@@ -0,0 +1,79 @@
+<?php
+
+namespace Yuges\Groupable\Traits;
+
+use Yuges\Groupable\Models\Group;
+use Illuminate\Support\Collection;
+use Yuges\Groupable\Config\Config;
+use Yuges\Groupable\Models\Groupable;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\MorphToMany;
+
+/**
+ * @property Collection<array-key, Group> $groups
+ */
+trait HasGroups
+{
+    public function groups(): MorphToMany
+    {
+        /** @var Model $this */
+        return $this
+            ->morphToMany(Config::getGroupClass(Group::class), 'groupable')
+            ->using(Config::getGroupableClass(Groupable::class))
+            ->withTimestamps();
+    }
+
+    public function group(Group $group): static
+    {
+        return $this->attachGroup($group);
+    }
+
+    public function ungroup(Group $group): static
+    {
+        return $this->detachGroup($group);
+    }
+
+    public function attachGroup(Group $group): static
+    {
+        $this->attachGroups(Collection::make([$group]));
+
+        return $this;
+    }
+
+    /**
+     * @param Collection<array-key, Group> $groups
+     */
+    public function attachGroups(Collection $groups): static
+    {
+        Config::getAttachGroupsAction($this)->execute($groups);
+
+        return $this;
+    }
+
+    public function detachGroup(Group $group): static
+    {
+        $this->detachGroups(Collection::make([$group]));
+
+        return $this;
+    }
+
+    /**
+     * @param Collection<array-key, Group> $groups
+     */
+    public function detachGroups(Collection $groups): static
+    {
+        Config::getDetachGroupsAction($this)->execute($groups);
+
+        return $this;
+    }
+
+    /**
+     * @param Collection<array-key, Group> $groups
+     */
+    public function syncGroups(Collection $groups): static
+    {
+        Config::getSyncGroupsAction($this)->execute($groups);
+
+        return $this;
+    }
+}