Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/musonza/groups
A Laravel 5 user groups package
https://github.com/musonza/groups
groups laravel laravel-groups php-groups social-network
Last synced: 12 days ago
JSON representation
A Laravel 5 user groups package
- Host: GitHub
- URL: https://github.com/musonza/groups
- Owner: musonza
- License: mit
- Created: 2016-04-02T04:30:05.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-02-05T02:59:29.000Z (almost 5 years ago)
- Last Synced: 2024-07-09T12:37:01.214Z (4 months ago)
- Topics: groups, laravel, laravel-groups, php-groups, social-network
- Language: PHP
- Size: 46.9 KB
- Stars: 68
- Watchers: 9
- Forks: 15
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://travis-ci.org/musonza/groups)
[](https://packagist.org/packages/musonza/groups)
[](https://packagist.org/packages/musonza/groups)
[](https://styleci.io/repos/55277679)
# Table of content
- [Description](#description)
- [Installation](#installation)
+ Install with Composer
+ Add service provider to App
+ Add facade alias to App
+ Publish vendor with Artisan
+ Tables details
+ Make migration with Artisan
- [Usage](#usage)
+ [Groups](#groups)
* Create, Delete, Update, Users list, Add member, Join request, Accept join, Decline join, Join request list
+ [Posts](#posts)
* Create, Get, Update, Delete, Add to group, Group posts list, User posts list
+ [Comments](#comments)
* Add, Get, Update, Delete
+ [Reporting](#reporting)
* Report, Remove, Toggle , Count
+ [Likes](#likes)
* Like, Unlike, Toggle, Count
# Description
This package allows you to add user groups _(groups, comment, like ...)_ system to your Laravel 5 application.
# Installation
1. Via **Composer**, from the command line, run :
```console
composer require musonza/groups
```
2. Add the service provider to `./config/app.php` in `providers` array, like :
```php
/*
* Package Service Providers...
*/
Musonza\Groups\GroupsServiceProvider::class,
```
3. You can use the facade for shorter code.
Add this to `./config/app.php` at the end of `aliases` array :
```php
'Groups' => Musonza\Groups\Facades\GroupsFacade::class,
```
> Note : The class is bound to the ioC as Groups.
```php
$groups = App::make('Groups');
```
4. From the command line, publish the assets:
```console
php artisan vendor:publish
```
> Note : This will publish database migrations in `./database/migrations/`.
```
create_groups_table // main groups table
id
name
description
short_description
image
url
user_id
private
conversation_id
extra_info
settings
# Usage
## Groups
1. ##### Create a group
```php
$group = Groups::create($userId, $data);
```
> Note : Accepted fields in $data array :
```php
$data = [
'name' => '',
'description' => '', // optional
'short_description' => '', // optional
'image' => '', // optional
'private' => 0, // 0 (public) or 1 (private)
'extra_info' => '', // optional
'settings' => '', // optional
'conversation_id' => 0, // optional if you want to add messaging to your groups this can be useful
];
```
2. ##### Delete a group
```php
$group->delete();
```
3. ##### Update a group
```php
$group->update($updateArray);
```
4. ##### Get user instance with group relations
```php
$user = Groups::getUser($userId);
```
5. ##### Add members to group
```php
$group->addMembers([$userId, $userId2, ...]);
```
6. ##### Request to join a group
```php
$group->request($userId);
```
7. ##### Accept a group request
```php
$group->acceptRequest($userId);
```
8. ##### Decline a group request
```php
$group->declineRequest($userId);
```
9. ##### Group requests
```php
$requests = $group->requests;
```
10. ##### How many groups a user is member of
```php
$user = Groups::getUser($userId);
$count = $user->groups->count();
```
11. ##### Remove member(s) from group
```php
$group->leave([$userId, $userId2, ...]);
```
## Posts
1. ##### Create a post
```php
$post = Groups::createPost($data);
```
> Note : Acceptable values for Post $data array
```php
$data = [
'title' => '',
'user_id' => 0,
'body' => '',
'type' => '',
'extra_info' => '',
];
```
2. ##### Get post
```php
$post = Groups::post($postId);
```
3. ##### Update a post
```php
$post->update($data);
```
4. ##### Delete a post
```php
$post->delete();
```
5. ##### Add a post to a group
```php
$group->attachPost($postId);
```
6. ##### Add multiple posts to a group
```php
$group->attachPost([$postId, $postId2, ...]);
```
7. ##### Remove post from a group
```php
$group->detachPost($postId);
```
8. ##### Group posts
```php
$posts = $group->posts;
$posts = $group->posts()->paginate(5);
$posts = $group->posts()->orderBy('id', 'DESC')->paginate(5);
```
9. ##### User posts
```php
$user = Groups::getUser($userId);
$posts = $user->posts;
```
## Comments
> Note : Acceptable values for Comment $data array
```php
$data = [
'post_id' => 0,
'user_id' => 0,
'body' => '',
];
```
1. ##### Add comment
```php
$comment = Groups::addComment($data);
```
2. ##### Get comment
```
$comment = Groups::comment($commentId);
```
3. ##### Update a comment
```php
$comment->update($data);
```
4. ##### Delete a comment
```php
$comment->delete();
```
## Reporting
1. ##### Report a comment or post
```php
$comment->report($userIdOfReporter);
$post->report($userIdOfReporter);
```
2. ##### Remove a post or comment report
```php
$post->removeReport($userId);
$comment->removeReport($userId);
```
3. ##### Toggle report/unreport a post or comment
```php
$post->toggleReport($userId);
$comment->toggleReport($userId);
```
4. ##### Post or Comment Report count
```php
$commentReports = $comment->reportsCount;
$postReports = $post->reportsCount;
```
## Likes
1. ##### Like a post or comment
```php
$post->like($userId);
$comment->like($userId);
```
2. ##### Unlike a post or comment
```php
$post->unlike($userId);
$comment->unlike($userId);
```
3. ##### Toggle like/unlike a post or comment
```php
$post->toggleLike($userId);
$comment->toggleLike($userId);
```
4. ##### Post or Comment likes count
```php
$postLikes = $post->likesCount;
$commentLikes = $comment->likesCount;
```