michele-angioni/message-board

A message board package for Laravel.

v2.0.2 2016-04-12 18:23 UTC

Requires

• php: >=5.5.9
• graham-campbell/throttle: ^5.0
• laravel/framework: ~5.1
• laravelcollective/html: ~5.1
• league/fractal: 0.13.*
• mews/purifier: ~2.0
• michele-angioni/support: ~2.10
• tymon/jwt-auth: 0.5.*

Requires (Dev)

• mockery/mockery: ^0.9
• orchestra/testbench: ~3.0
• phpunit/phpunit: ~4.1
• sami/sami: dev-master

MIT

• Michele Angioni

• notifications
• laravel
• message board

README

Message Board is a Laravel 5 package which assigns a message board to each User, where posts and comments can be posted.

Bans and a permission system are provided out of the box. Social features such as "likes" are included as well.

The package comes bundled with a highly customizable full featured API, which needs to be enabled in the config file, to let your application use Message Board through asynchronous calls without having to write your own API.

Documentation

Check our wiki for full documentation.

Quick examples

Retrieve a User Posts

MessageBoard::getOrderedUserPosts($user);

Create a new Post

public function store(Request $request)
{
	[...]
	
	$user = User::findOrFail($request->get('id_user'));
	
	MessageBoard::createPost($user, Auth::user(), null, $text);

	[...]				
}

Create a Like

public function postLikeStore($idPost, Request $request)
{
	[...]
	
	MessageBoard::createLike(Auth::user()->getKey(), $idPost, 'post');

	[...]				
}

Ban a User

public function banUser($idUser, Request $request)
{
	[...]
	
	$user = User::findOrFail($idUser);
	
	MessageBoard::banUser($user, $request->get('days'), $request->get('reason'));
	
	[...]
}

Read all User Notifications

public function readNotifications()
{
	$user = Auth::user();
	
	$user->readAllNotifications();				
}

Contribution guidelines

Support follows PSR-1 and PSR-4 PHP coding standards, and semantic versioning.

Please report any issue you find in the issues page.

Use development branch for pull requests.

License

Message Board is free software distributed under the terms of the MIT license.