Hub

Hub provides team collaboration features: threaded conversations, messaging, @mentions, reactions, and scheduled reminders. It integrates with the Link package for team invites.

Features

Threads: Create threaded discussions attached to any resource.
Messages: Post messages with reply threading and @mentions.
Reactions: Emoji reactions on messages.
Reminders: Schedule reminders with repeat intervals (daily, weekly, monthly).
Invites: Generate invite links via the Link package.
Analytics: Track engagement, message trends, and contributor activity.

Installation

Hub is a package that requires installation before use.

Install the Package

php dock package:install Hub --packages

This will automatically:

Run the migration for Hub tables.
Register the HubServiceProvider.
Publish the configuration file.

Configuration

Configuration file: App/Config/hub.php

return [
    'max_message_length' => 10000,
    'max_attachments_per_message' => 10,
    'max_members_per_thread' => 100,
    'default_notifications_enabled' => true,
    'mention_pattern' => '/@(\w+)/',
    'reminder_advance_minutes' => 15,
    'max_snooze_count' => 5,
    'retention_days' => 365,
];

Basic Usage

Creating Threads

use Hub\Hub;

$user = $this->auth->user();

// Create a thread attached to a project
$thread = Hub::thread()
    ->on($project)
    ->title('Sprint Planning')
    ->members([$user1->id, $user2->id])
    ->by($user->id)
    ->create();

Posting Messages

use Hub\Hub;

// Post a message
$message = Hub::message()
    ->in($thread)
    ->from($user->id)
    ->body('Hey @jane, can you review this?')
    ->send();

// Reply to a message
Hub::message()
    ->replyTo($message)
    ->from($user2->id)
    ->body('Done! ✅')
    ->send();

Reactions

use Hub\Hub;

// Add a reaction
Hub::react($message, '👍', $userId);

// Toggle reaction (removes if exists, adds if not)
Hub::toggleReaction($message, '❤️', $userId);

// Remove a reaction
Hub::removeReaction($message, '👍', $userId);

Reminders

use Hub\Hub;

// Create a reminder for tomorrow
$reminder = Hub::reminder()
    ->for($user->id)
    ->message('Follow up on client proposal')
    ->tomorrow(9, 0)  // 9:00 AM
    ->create();

// Create a weekly recurring reminder
Hub::reminder()
    ->for($userId)
    ->about($project)
    ->message('Weekly standup')
    ->inHours(24)
    ->weekly()
    ->create();

// Snooze a reminder
$reminder->snooze(15);  // 15 minutes

// Complete a reminder
$reminder->complete();

Team Invites (Link Integration)

use Hub\Hub;

// Create an invite link for a thread
$link = Hub::invite($thread, 'newmember@company.com');

// Get the shareable URL
$url = $link->signedUrl();

Model Helpers

Thread Model

$thread = Hub::find($refid);

$thread->hasMember($userId);      // Check membership
$thread->getMember($userId);      // Get member record
$thread->getMessageCount();       // Total messages
$thread->getUnreadCount($userId); // Unread for user
$thread->pin();                   // Pin thread
$thread->unpin();                 // Unpin thread

Message Model

$message = Hub::findMessage($refid);

$message->isReply();               // Is this a reply?
$message->hasReaction($uid, '👍'); // User reacted?
$message->getReactionCounts();     // {emoji: count}
$message->pin();                   // Pin message

Reminder Model

$reminder = Hub::findReminder($refid);

$reminder->isDue();       // Is reminder due?
$reminder->repeats();     // Does it repeat?
$reminder->snooze(15);    // Snooze 15 minutes
$reminder->complete();    // Mark complete
$reminder->cancel();      // Cancel reminder

Thread Member

$member = $thread->getMember($userId);

$member->isOwner();      // Is owner?
$member->isAdmin();      // Is admin?
$member->canManage();    // Can manage members?
$member->markAsRead();   // Mark thread read
$member->toggleNotifications();  // Toggle notifications

Events

Hub dispatches events for notifications and integrations:

Event	Payload	Use Case
`MessagePosted`	message, threadId, userId	Notify thread members
`UserMentioned`	mention, message, userId	Send @mention notification
`ReminderDue`	reminder, userId	Send reminder notification
`ThreadCreated`	thread, createdBy	Notify invited members

Example Event Listener

use Hub\Events\UserMentioned;
use Hub\Notifications\MentionNotification;
use Notify\Notify;
use Helpers\Data;

class SendMentionNotification
{
    public function handle(UserMentioned $event): void
    {
        $user = User::find($event->mentionedUserId);

        Notify::email(MentionNotification::class, Data::make([
            'email' => $user->email,
            'name' => $user->name,
            'mentioner_name' => $event->message->user->name,
            'thread_title' => $event->message->thread->title,
            'message_preview' => $event->message->body,
        ]));
    }
}

Analytics

use Hub\Hub;

$analytics = Hub::analytics();

// Active threads with message counts
$active = $analytics->getActiveThreads(30);

// Daily message volume
$trends = $analytics->getMessageTrends(30);

// Engagement metrics
$metrics = $analytics->getEngagementMetrics();
// Returns: total_threads, total_messages, active_users, avg_messages_per_thread

// Top contributors
$contributors = $analytics->getTopContributors(10);

// Reaction distribution
$reactions = $analytics->getReactionDistribution();

// Reminder metrics
$reminders = $analytics->getReminderMetrics();
// Returns: total, completed, pending, snoozed, completion_rate

Package Integrations

Link Package

Hub uses Link for team invites:

$link = Hub::invite($thread, 'user@example.com');

When the invite is used (validated via Link::validate()), add the user to the thread:

$link = Link::validate($token);
if ($link->canJoin()) {
    $link->linkable
        ->addMember($newUserId)
        ->asGuest()
        ->add();
}

Support Package

Attach threads to support tickets for internal team discussions:

use Hub\Hub;
use Support\Support;

// Create a thread on a support ticket
$ticket = Support::findTicket($ticketId);

$thread = Hub::thread()
    ->on($ticket)
    ->title("Internal: {$ticket->subject}")
    ->members([$agent1->id, $agent2->id])
    ->by($user->id)
    ->create();

Slot Package

Add discussion threads to bookings for coordination:

use Hub\Hub;
use Slot\Slot;

// Create a thread for a booking
$booking = Slot::booking($bookingId);

$thread = Hub::thread()
    ->on($booking)
    ->title("Booking Discussion: {$booking->schedule->name}")
    ->members([$booking->user_id, $booking->host_id])
    ->create();

Mail Notifications

Hub sends notifications using Mail::send() with built-in notification classes:

use Helpers\Data;
use Hub\Events\UserMentioned;
use Hub\Notifications\MentionNotification;
use Mail\Mail;

class SendMentionNotification
{
    public function handle(UserMentioned $event): void
    {
        $user = User::find($event->mentionedUserId);

        Mail::send(new MentionNotification(Data::make([
            'email' => $user->email,
            'mentioner_name' => $event->message->user->name,
            'thread_title' => $event->message->thread->title,
            'message_preview' => Str::limit($event->message->body, 100),
        ])));
    }
}

Available notifications:

MentionNotification - For @mentions
ReminderNotification - For due reminders
MessagePostedNotification - For new messages

Audit Package

Log thread and message activity:

use Audit\Audit;

Audit::make()
    ->event('hub.message.posted')
    ->on($message)
    ->by($userId)
    ->log();

Service API Reference

Hub (Facade)

Method	Description
`thread()`	Returns `ThreadBuilder`
`message()`	Returns `MessageBuilder`
`reminder()`	Returns `ReminderBuilder`
`react($message, $emoji, $userId)`	Add reaction
`invite($thread, $email)`	Create invite via Link
`find($refid)`	Find thread by refid
`findMessage($refid)`	Find message by refid
`findReminder($refid)`	Find reminder by refid
`analytics()`	Returns `HubAnalytics`

ThreadBuilder

Method	Description
`on($model)`	Attach to resource
`title($title)`	Set thread title
`members([$ids])`	Set member IDs
`addMember($id)`	Add single member
`pinned()`	Pin the thread
`by($userId)`	Set creator
`create()`	Create thread

MessageBuilder

Method	Description
`in($thread)`	Set target thread
`replyTo($message)`	Reply to message
`from($userId)`	Set sender
`body($text)`	Set message body
`mentions([$ids])`	Set explicit mentions
`pinned()`	Pin message
`send()`	Post message

ReminderBuilder

Method	Description
`for($userId)`	Set reminder recipient
`about($model)`	Attach to resource
`message($text)`	Set reminder text
`at($datetime)`	Set specific time
`inMinutes(n)`	Set relative time
`inHours(n)`	Set relative time
`tomorrow(h, m)`	Set tomorrow at time
`daily() / weekly()`	Set repeat interval
`create()`	Create reminder

Automation

The Hub package automatically registers its reminder dispatcher in the framework's central scheduler.

// packages/Hub/Schedules/HubSchedule.php
namespace Hub\Schedules;
 
use Cron\Interfaces\Schedulable;
use Cron\Schedule;
 
class HubSchedule implements Schedulable
{
    public function schedule(Schedule $schedule): void
    {
        $schedule->task()
            ->signature('hub:remind')
            ->everyThirtyMinutes();
    }
}

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Hub

Features

Installation

Install the Package

Configuration

Basic Usage

Creating Threads

Posting Messages

Reactions

Reminders

Team Invites (Link Integration)

Model Helpers

Thread Model

Message Model

Reminder Model

Thread Member

Events

Example Event Listener

Analytics

Package Integrations

Link Package

Support Package

Slot Package

Mail Notifications

Audit Package

Service API Reference

Hub (Facade)

ThreadBuilder

MessageBuilder

ReminderBuilder

Automation

FilesExpand file tree

hub.md

Latest commit

History

hub.md

File metadata and controls

Hub

Features

Installation

Install the Package

Configuration

Basic Usage

Creating Threads

Posting Messages

Reactions

Reminders

Team Invites (Link Integration)

Model Helpers

Thread Model

Message Model

Reminder Model

Thread Member

Events

Example Event Listener

Analytics

Package Integrations

Link Package

Support Package

Slot Package

Mail Notifications

Audit Package

Service API Reference

Hub (Facade)

ThreadBuilder

MessageBuilder

ReminderBuilder

Automation