PHPackages                             etsh/groupable - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. etsh/groupable

ActiveLibrary[Utility & Helpers](/categories/utility)

etsh/groupable
==============

A laravel package for grouping content - like a simplified Organic Groups for Laravel.

1.0.0(9y ago)2114[2 issues](https://github.com/etsh/groupable/issues)MITPHP

Since Oct 31Pushed 8y ago2 watchersCompare

[ Source](https://github.com/etsh/groupable)[ Packagist](https://packagist.org/packages/etsh/groupable)[ RSS](/packages/etsh-groupable/feed)WikiDiscussions master Synced yesterday

READMEChangelog (1)DependenciesVersions (2)Used By (0)

Groupable
=========

[](#groupable)

Groupable is a Laravel package for grouping content.

It takes its inspiration from the Drupal community - think of it as a simplified Organic Groups for Laravel.

Introduction
------------

[](#introduction)

The idea of Groupable is to turn any Eloquent model into a group which can be 'joined' by users and act as a container for 'content'.

Addtionally, users may be given additional group roles on a group-by-group basis.

Groupable works by adding traits to the models within your application that you wish to adopt this group like behaviour.

### The Traits

[](#the-traits)

Groupable provides three traits which can be added to your models:

- The `IsGroup` trait is added to a model which you would like to be treated as a group.
- The `IsGroupable` trait is added to models which you would like to be treated as group content.
- The `JoinsGroups` trait is added to your User model.

In fact, only the `IsGroup` trait is necessary in order to obtain group funtionality. However, the `IsGroupable` and `JoinsGroups` traits provide useful group related functionality to your user model and groupable content types.

### Helper methods

[](#helper-methods)

Groupable includes a class called `Groupable` which offers internal helper methods. You likely won't need to use this class unless you intend to modify the code within this project yourself.

### Database Structure

[](#database-structure)

Groupable requires 3 tables to be added to your schema and includes database migrations out of the box.

There is no need to publish these migrations to your project as the accompanying service provider points to the migrations folder within your Composer vendor folder.

The table structure is as follows:

```
groupables:
    id
    group_id
    group_type
    groupable_id
    groupable_type
    created_at
    updated_at

groupable_roles:
    id
    group_id
    group_type
    user_id
    role
    created_at
    updated_at

groupable_members:
    id
    group_id
    group_type
    user_id
    created_at
    updated_at

```

Installation
------------

[](#installation)

Installation is via composer:

```
composer require etsh\groupable
```

Then be sure to include the `GroupableServiceProvider` in you a `app` config file:

```
Etsh\Groupable\GroupableServiceProvider::class
```

Finally, run the migrations:

```
art migrate
```

Instructions: Setup
-------------------

[](#instructions-setup)

### Creating a Group

[](#creating-a-group)

Simply `use` the `IsGroup` trait in the model that you wish to become a group:

```
use Etsh\Groupable\Traits\IsGroup;

class Group extends Model
{
    use IsGroup
```

Then create the properties `$groupable_models` and `$groupable_roles`:

```
    protected $groupable_models = [
        GroupableContent::class,
    ];

    protected $groupable_roles = [
        'admin',
    ];

    ...
```

`$groupable_models` should be an array containing the fully-qualified class name of the models which should be allowed to be grouped within this group. Groupable will throw an exception if you attempt to add a content type not specified here to the group.

`$groupable_roles` should be an array containing the names of additional roles that you wish members to be grantable to members of this group.

### Creating Groupable content

[](#creating-groupable-content)

Only models specified within the `$groupable_models` property on your group model may be added to a given group.

To add additional functionality use the `IsGroupable` trait on the model that represents your groupable content.

```
use Etsh\Groupable\Traits\IsGroup;

class Group extends Model
{
    use IsGroupable
```

### Allowing users to join groups

[](#allowing-users-to-join-groups)

It's possible to join users to groups without using the 'CanJoinGroups' trait, however it provides some useful helper functions.

Include it in your user model like so:

```
use Etsh\Groupable\Traits\CanJoinGroups;

class User extends Authenticatable
{
    use CanJoinGroups;
```

Instructions: Usage
-------------------

[](#instructions-usage)

These instructions assume that you have used the `IsGroupable` trait in your groupable models and the `JoinsTeams` trait on your user model.

### Add and remove group content

[](#add-and-remove-group-content)

Content can be added to a group like this:

```
$group->addContent($groupable_content);
```

And removed like this:

```
$group->removeContent($groupable_content);
```

### Retrieve group content

[](#retrieve-group-content)

You can retrieve all group content like this:

```
$group->content();
```

Which returns a Laravel collection containing each content model.

You can also make your content requests more specific by passing an array of required types to the content() method:

```
$group->content([GroupableContentType1::class, GroupableContentType2::class]);
```

### Join and leave a group

[](#join-and-leave-a-group)

Users can be joined to groups like this:

```
$group->join($user);
```

And removed like this:

```
$group->leave($user);
```

### Retrieve group members

[](#retrieve-group-members)

You can retrieve all group members like this:

```
$group->members();
```

Which returns a Laravel collection containing each user model.

You can also retrieve all group members with a given role:

```
$group->membersByRole('admin');
```

### Checking whether a user is a group member

[](#checking-whether-a-user-is-a-group-member)

You can check whether a user is a member of a given group like this:

```
$user->belongsToGroup($group);
```

### Grant and revoke special group roles

[](#grant-and-revoke-special-group-roles)

You will probably want to grant some users special priveleges within your groups and this can be done in the following ways:

Users can be granted group roles like this:

```
$group->grant($user, $role);
```

And those roles can be revoked like this:

```
$group->revoke($user, $role);
```

The available roles can be defined on a group by group basis and should be expressed by adding the required roles to the `$groupable_roles` property on the group model.

### Checking whether a user has a group role

[](#checking-whether-a-user-has-a-group-role)

You can check whether a group member has a given group role like this:

```
$user->hasGroupRole($group, $role);
```

### Seeing which group roles a user has

[](#seeing-which-group-roles-a-user-has)

You can see all roles a user has for a given group like this:

```
$user->groupRoles($group);
```

### Checking which content types may be added to a group

[](#checking-which-content-types-may-be-added-to-a-group)

You can check which content types may be added to a group like this:

```
$group->types();
```

### Checking which roles are available within a group

[](#checking-which-roles-are-available-within-a-group)

You can check which roles are available within a group like this:

```
$group->roles();
```

### Finding the other groups that groupable content belongs to

[](#finding-the-other-groups-that-groupable-content-belongs-to)

You can retrieve a collection containing the other groups that a piece of groupable content belongs to like this:

```
$groupable_content->groups();
```

###  Health Score

24

—

LowBetter than 31% of packages

Maintenance0

Infrequent updates — may be unmaintained

Popularity13

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

3530d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/17261499?v=4)[etsh](/maintainers/etsh)[@etsh](https://github.com/etsh)

---

Top Contributors

[![simonhunt](https://avatars.githubusercontent.com/u/2714455?v=4)](https://github.com/simonhunt "simonhunt (27 commits)")

---

Tags

laravelpackagegroupgroupable

### Embed Badge

![Health badge](/badges/etsh-groupable/health.svg)

```
[![Health](https://phpackages.com/badges/etsh-groupable/health.svg)](https://phpackages.com/packages/etsh-groupable)
```

###  Alternatives

[fresns/fresns

Cross-platform general-purpose multiple content forms social network service software.

4841.5k](/packages/fresns-fresns)[creasi/laravel-nusa

A Laravel package that aim to provide Indonesia' Administrative Data

997.9k2](/packages/creasi-laravel-nusa)[wujunze/money-wrapper

MoneyPHP Wrapper

103.8k](/packages/wujunze-money-wrapper)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)