laravel-notification-channels/trello

Trello Notifications driver

1.3.0 2020-09-09 23:28 UTC

Requires

• php: >=7.2.5
• guzzlehttp/guzzle: ~6.0
• illuminate/notifications: ~6.0 || ~7.0 || ~8.0
• illuminate/support: ~6.0 || ~7.0 || ~8.0

Requires (Dev)

• mockery/mockery: ^1.0
• orchestra/database: ~4.0 || ~5.0 || ~6.0
• orchestra/testbench: ~4.2 || ~5.0 || ~6.0
• phpunit/phpunit: 8.*

MIT

• Marcel Pociot

README

This package makes it easy to create Trello cards with Laravel 6.x, 7.x & 8.x.

Contents

• Installation
  • Setting up the Trello service
• Usage
  • Available Message methods
• Changelog
• Testing
• Security
• Contributing
• Credits
• License

Installation

You can install the package via composer:

composer require laravel-notification-channels/trello

Setting up the Trello service

Add your Trello REST API Key to your config/services.php:

// config/services.php
...
'trello' => [
    'key' => env('TRELLO_API_KEY'),
],
...

Usage

Now you can use the channel in your via() method inside the notification:

use NotificationChannels\Trello\TrelloChannel;
use NotificationChannels\Trello\TrelloMessage;
use Illuminate\Notifications\Notification;

class ProjectCreated extends Notification
{
    public function via($notifiable)
    {
        return [TrelloChannel::class];
    }

    public function toTrello($notifiable)
    {
        return TrelloMessage::create()
            ->name("Trello Card Name")
            ->description("This is the Trello card description")
            ->top()
            ->due('tomorrow');
    }
}

In order to let your Notification know which Trello user and Trello list you are targeting, add the routeNotificationForTrello method to your Notifiable model.

This method needs to return an array containing the access token of the authorized Trello user (if it's a private board) and the list ID of the Trello list to add the card to.

public function routeNotificationForTrello()
{
    return [
        'token' => 'NotifiableToken',
        'idList' => 'TrelloListId',
    ];
}

Available methods

• name(''): Accepts a string value for the Trello card name.
• description(''): Accepts a string value for the Trello card description.
• top(): Moves the Trello card to the top.
• bottom(): Moves the Trello card to the bottom.
• position(''): Accepts an integer for a specific Trello card position.
• due(''): Accepts a string or DateTime object for the Trello card due date.

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Security

If you discover any security related issues, please email [e-mail] instead of using the issue tracker.

Contributing

Please see CONTRIBUTING for details.

Credits

• Marcel Pociot
• All Contributors

License

The MIT License (MIT). Please see License File for more information.