musonza / groups
Laravel 5 user groups package
Installs: 3 086
Dependents: 0
Suggesters: 0
Security: 0
Stars: 68
Watchers: 9
Forks: 15
Open Issues: 5
Requires
- laravel/framework: ~5.5.0|~5.6.0|~5.7.0|~5.8.0|^6.0.0
Requires (Dev)
- mockery/mockery: ^1.0.0
- orchestra/database: ~3.3.0|~3.4.2|^3.5.0|~3.7.0
- orchestra/testbench: ~3.3.0|~3.4.2|^3.5.0|~3.7.0
- phpunit/phpunit: ^5.7|6.2|^7.0
This package is auto-updated.
Last update: 2024-11-05 13:12:28 UTC
README
Table of content
- Description
- 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
- Groups
- Create, Delete, Update, Users list, Add member, Join request, Accept join, Decline join, Join request list
- Posts
- Create, Get, Update, Delete, Add to group, Group posts list, User posts list
- Comments
- Add, Get, Update, Delete
- Reporting
- Report, Remove, Toggle , Count
- Likes
- Like, Unlike, Toggle, Count
- Groups
Description
This package allows you to add user groups (groups, comment, like ...) system to your Laravel 5 application.
Installation
- Via Composer, from the command line, run :
composer require musonza/groups
- Add the service provider to
./config/app.php
inproviders
array, like :
/* * Package Service Providers... */ Musonza\Groups\GroupsServiceProvider::class,
- You can use the facade for shorter code.
Add this to
./config/app.php
at the end ofaliases
array :
'Groups' => Musonza\Groups\Facades\GroupsFacade::class,
Note : The class is bound to the ioC as Groups.
$groups = App::make('Groups');
- From the command line, publish the assets:
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 :
$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 ];
$group->delete();
$group->update($updateArray);
$user = Groups::getUser($userId);
$group->addMembers([$userId, $userId2, ...]);
$group->request($userId);
$group->acceptRequest($userId);
$group->declineRequest($userId);
$requests = $group->requests;
$user = Groups::getUser($userId); $count = $user->groups->count();
$group->leave([$userId, $userId2, ...]);
Posts
$post = Groups::createPost($data);
Note : Acceptable values for Post $data array
$data = [ 'title' => '', 'user_id' => 0, 'body' => '', 'type' => '', 'extra_info' => '', ];
$post = Groups::post($postId);
$post->update($data);
$post->delete();
$group->attachPost($postId);
$group->attachPost([$postId, $postId2, ...]);
$group->detachPost($postId);
$posts = $group->posts; $posts = $group->posts()->paginate(5); $posts = $group->posts()->orderBy('id', 'DESC')->paginate(5);
$user = Groups::getUser($userId); $posts = $user->posts;
Comments
Note : Acceptable values for Comment $data array
$data = [ 'post_id' => 0, 'user_id' => 0, 'body' => '', ];
$comment = Groups::addComment($data);
$comment = Groups::comment($commentId);
$comment->update($data);
$comment->delete();
Reporting
$comment->report($userIdOfReporter); $post->report($userIdOfReporter);
$post->removeReport($userId); $comment->removeReport($userId);
$post->toggleReport($userId); $comment->toggleReport($userId);
$commentReports = $comment->reportsCount; $postReports = $post->reportsCount;
Likes
$post->like($userId); $comment->like($userId);
$post->unlike($userId); $comment->unlike($userId);
$post->toggleLike($userId); $comment->toggleLike($userId);
$postLikes = $post->likesCount; $commentLikes = $comment->likesCount;