Jump to content
MoritzLost

TrelloWire - Turn your pages into Trello cards

Recommended Posts

TrelloWire

This is a module that allows you to automatically create Trello cards for ProcessWire pages and update them when the pages are updated. This allows you to setup connected workflows. Card properties and change handling behaviour can be customized through the extensive module configuration. Every action the module performs is hookable, so you can modify when and how cards are created as much as you need to. The module also contains an API-component that makes it easy to make requests to the Trello API and build your own connected ProcessWire-Trello workflows.

Features

  • All the things the module can do for you without any custom code:
    • Create a new card on Trello whenever a page is added or published (you can select applicable templates).
    • Configure the target board, target list, name and description for new cards.
    • Add default labels and checklists to the card.
    • Update the card whenever the page is updated (optional).
    • When the status of the card changes (published / unpublished, hidden / unhidden, trashed / restored or deleted), move the card to a different list or archive or delete it (configurable).
  • You can extend this through hooks in many ways:
    • Modifiy when and how cards are created.
    • Modify the card properties (Target board & list, title, description, et c.) before they are sent to Trello.
    • Create your own workflows by utilizing an API helper class with many convenient utility methods to access the Trello API directly.

Feedback & Future Plans

Let me know what you think! In particular:

  • If you find any bugs report them here or on Github, I'll try to fix them.
  • This module was born out of a use-case for a client project where we manage new form submissions through Trello. I'm not sure how many use-cases there are for this module. If you do use it, tell me about it!
  • The Trello API is pretty extensive, I'll try to add some more helper methods to the TrelloWireApi class (let me know if you need anything in particular).
  • I'll think about how the module can support different workflows that include Twig – talk to me if you have a use-case!
  • Next steps could be a dashboard to manage pages that are connected to a Trello card, or a new section in the settings tab to manage the Trello connection. But it depends on whether there is any interest in this 🙂

Links

Module configuration

TrelloWireFullPage.thumb.png.000845648085ad2934da6f34074974e7.png

  • Like 13
  • Thanks 1

Share this post


Link to post
Share on other sites

This sounds great, even though I don't use trello 🙂 A short screencast would be great to get a quick impression 🙂 

  • Like 3

Share this post


Link to post
Share on other sites
28 minutes ago, bernhard said:

This sounds great, even though I don't use trello 🙂 A short screencast would be great to get a quick impression 🙂 

And some background on why you built this would be really interesting too! Looks great!

  • Like 3

Share this post


Link to post
Share on other sites
1 hour ago, bernhard said:

This sounds great, even though I don't use trello 🙂 A short screencast would be great to get a quick impression 🙂 

Thanks! I was hoping the screenshot would do that 😆 Maybe I can give the screencast a go this weekend ... though I'm just now realizing I don't even have a headset any more 😅

1 hour ago, elabx said:

And some background on why you built this would be really interesting too! Looks great!

Lockdown because of Covid-19 mostly 😅

No but really, the README on Github has two examples, and the first one is basically the client project that started this off. This project is a lead generation platform with multiple contact / data collection forms. Our client's team manages all requests on a Trello board. This works really well once everybody is used to it, they use many custom labels and lists to organize all requests / leads. Currently all the new leads are entered manually, but after the relaunch every request will create both a ProcessWire page and a Trello card for the lead. After additional data is entered through one of the forms, the cards are updates with more information and appropriate labels. This is what the status change handling options are for; if the ProcessWire page is trashed, the Trello card can be archived and so on ...

  • Like 2
  • Thanks 1

Share this post


Link to post
Share on other sites

Oh wow! I discovered Trello just last week (yes, more free time during lockdown...). We were planning to use it as a project management tool for my (non-tech) team to enriched the content of the website (yes, again, lockdown...). Basically, I created some lists : "to do", "done", "added to website". The module will allow me to create the page (unpublished) with an automated checklist (text, image, translations), so people will choose one card, assign to self and work on the subject. When everything will be checked, they will move to "done", until I added the new content to the website (I'm the only one having backend access and I want it stay like this).

So for now, it's working. And I like the fact I could add some automatic text without having to copy manually. Could I ask something? I'm not sure I understand what is wirePopulateStringTags
Do I can use this to pull out the creation date or the child pages?
Can it could be possible to add a trigger on "publishing" a page in status change handling?
And last question. I guess via a hook, I should be able to create a button to automating card creation for existing pages?

Thanks a lot!

Mel

  • Like 1

Share this post


Link to post
Share on other sites

Hi @mel47, I'm happy to hear that!

13 hours ago, mel47 said:

So for now, it's working. And I like the fact I could add some automatic text without having to copy manually. Could I ask something? I'm not sure I understand what is wirePopulateStringTags
Do I can use this to pull out the creation date or the child pages?

Yes, you can! You can use this to output fields from the page to the Trello card. For example, by default the card body contains a link to the page: {httpUrl}, this will be the page's url after parsing. You can use both custom fields as well as system fields. For example:

**Page title: {title}**

Page content:

{body}

Page was created at {created}

This approach is somewhat limited. For example, the {created} placeholder will output the raw timestamp, and as far as I'm aware there's no way to change that to a proper date format. But that's why all methods are hookable. For example, if you want to append the (properly formatted) creation date to the body of all cards (when they are created or updated), you can hook TrelloWireCard::setBody:

<?php
// site/ready.php
namespace ProcessWire;

wire()->addHookBefore('TrelloWireCard::setBody', function (HookEvent $e) {
    $body = $e->arguments(0);
    $card = $e->object;
    if ($card->page) {
        $body .= sprintf("\n\nCreated at: %s", date('Y-m-d', $card->page->created));
        $e->arguments(0, $body);
    }
});

You can hook different methods of TrelloWire or TrelloWireCard depending on when you want to modify the cards, there's a complete list of hookable methods in the README.

 

13 hours ago, mel47 said:

Can it could be possible to add a trigger on "publishing" a page in status change handling?

Currently the only things you can do through the module configuration when a page is published is (1) create a new card for this page or (b) restore the card associated with this page if it was previously archived. It's also possible to update the card whenever the page is saved, though that doesn't differentiate between status changes.

If you want to perform a specific action after a page is published (like, for example, tick one of the checklist items), you can do that through hooks and use the TrelloWireApi class to perform the action through the Trello API. If you need some help with that let me know what you want to do!

Quote

And last question. I guess via a hook, I should be able to create a button to automating card creation for existing pages?

Yes, you can create cards manually in your template files. In that case, I would first deactivate the automatic card creation through the configuration. Then you can create cards manually:

// replace with a check for your button
if ($buttonWasClicked) {
    $TrelloWire = $modules->get('TrelloWire');
    $page = wire('page');
    $card = $TrelloWire->buildCardData($page);
    // dont create cards for pages that are already associated with a card
    if (!$card->id) {
        $TrelloWire->createCardForPage($card, $page);
    }
}

Let me know if it's working for you! Something on my To-Do list for this module is to add some "recipes" for stuff like that 🙂

6 hours ago, bernhard said:

That's the old version of https://processwire.com/api/ref/wire-text-tools/populate-placeholders/ and it does what it says: Populate placeholders in a string with corresponding variables (thx for reminding me about that! 😄 ).

I think both methods are equivalent, wirePopulateStringTags just passes through to the populatePlaceholders method. Some of those methods are really well hidden in the documentation, those are super handy and should definitely be more visible!

  • Like 1

Share this post


Link to post
Share on other sites

Hi

Thanks for the answer. For now, I was able to create the button for existing pages. However I'm stuck with triggering after publishing a page. I want to move to a different list.

I'm there now, but I'm missing the part concerning retrieval of the lists. I tried different things but no success, I'm still learning hooks and API, I don't understand everything... 

$this->pages->addHookAfter('publishReady', function(HookEvent $event) {
    $processor = $event->object; 
    $page = $event->arguments('page');
    
    if($page->template != 'content') return;
    
    $TrelloWire = $processor->wire('modules')->get('TrelloWire');
    $card = $TrelloWire->buildCardData($page);
    
    $TrelloWire->moveCard($card->id, ?????);  
});

Thanks for any help

Mel

Share this post


Link to post
Share on other sites
17 hours ago, mel47 said:

I'm there now, but I'm missing the part concerning retrieval of the lists. I tried different things but no success, I'm still learning hooks and API, I don't understand everything... 

You need to know the ID of the list you want to move the card to. To get all lists of a board, you need to know the ID of that board first. In general, you can check the Trello API docs and perform the query you need using the TrelloWireApi class included in the module.

Take note that all the API methods are defined on the TrelloWireApi class, not TrelloWire itself. So you need to use $TrelloWire->api()->moveCard()!

For this particular case, the TrelloWireApi class has a helper method to retrieve both boards and lists associated with your account:

// get the module and the api helper class
$TrelloWire = wire('modules')->get('TrelloWire');
$TrelloWireApi = $TrelloWire->api();

// this will return an array of boards (with name and id)
$boards = $TrelloWireApi->boards();

// alternatively, you can use the target board defined through the module configuration
$boardId = $TrelloWire->TargetBoard;

// this returns an array of lists on the board
$lists = $TrelloWireApi->lists($boardId);

Once of you have the array of lists, take note of it's ID, this is what you need to move a card to it. You can do this dynamically by searching through the array and search for the correct name or whatever, but I'd just dump the array of lists, grab the ID you need and put it in a constant somewhere 🙂 This also saves an API call each time, and those actually have a noticable impact on performance because of network overhead.

$targetId = 'some-id'; // get this ID from the lists() method above!
$TrelloWireApi->moveCard($card->id, $targetId);

Let me know if something isn't working for you!

  • Thanks 1

Share this post


Link to post
Share on other sites

Thanks! Got it! Put it here if someone needed.

const ADDED_BOARD = '';  //put here the id as previously described by MoritzLost

$this->pages->addHookAfter('publishReady', function(HookEvent $event) {

    $processor = $event->object; 
    $page = $event->arguments('page');

    if($page->template != 'content') return;
    
    $TrelloWire = wire('modules')->get('TrelloWire');
	$TrelloWireApi = $TrelloWire->api();
    
    $card = $TrelloWire->buildCardData($page);
    	
	if ($card->id) {
   			 $TrelloWireApi->moveCard($card->id, ADDED_BOARD);
   			 $page->message($this->_('Moved Trello card to "Added" Board'));
	}
});

Mel

  • Like 1

Share this post


Link to post
Share on other sites

@mel47 Great 🤙 Though I think you have mixed up boards and lists; The method TrelloWireApi::moveCard only moves a card to a different list (within the same or a different board). So your constant ADDED_BOARD should probably be named ADDED_LIST instead to avoid confusion!

Share this post


Link to post
Share on other sites

Oups, too newbie with Trello... but it do what I wanted!

  • Like 1

Share this post


Link to post
Share on other sites

Hello @MoritzLost

Found a bug. If you let empty "body" in config, I get this error. Put any text and problem solved.
Except that, everything working fine so far!
Thanks.

image.thumb.png.3c771e518d12cd5275c35a1398764f42.png

Share this post


Link to post
Share on other sites

@mel47 Thanks for the report! I have just pushed a fix for the issue in release 1.0.1. The title and body arguments to TrelloWireApi::createCard() are now nullable, and the body defaults to an empty string if not set. This also means that the Hook for TrelloWireCard::setBody now gets called even if the body is empty, which it wouldn't previously. I have also added a Changelog.

Let me know if you find any more bugs!

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By d'Hinnisdaël
      Happy new year, everybody 🥬
      I've been sitting on this Dashboard module I made for a client and finally came around to cleaning it up and releasing it to the wider public. This is how it looks.
      ProcessWire Dashboard

      If anyone is interested in trying this out, please go ahead! I'd love to get some feedback on it. If this proves useful and survives some real-world testing, I'll add this to the module directory.
      Download
      You can find the latest release on Github.
      Documentation
      Check out the documentation to get started. This is where you'll find information about included panel types and configuration options.
      Custom Panels
      My goal was to make it really simple to create custom panels. The easiest way to do that is to use the panel type template and have it render a file in your templates folder. This might be enough for 80% of all use cases. For anything more complex (FormBuilder submissions? Comments? Live chat?), you can add new panel types by creating modules that extend the DashboardPanel base class. Check out the documentation on custom panels or take a look at the HelloWorld panel to get started. I'm happy to merge any user-created modules into the main repo if they might be useful to more than a few people.
       Disclaimer
      This is a pre-release version. Please treat it as such — don't install it on production sites. Just making sure 🍇
      Roadmap
      These are the things I'm looking to implement myself at some point. The wishlist is a lot longer, but those are the 80/20 items that I probably won't regret spending time on.
      Improve documentation & add examples ⚙️ Panel types Google Analytics ⚙️ Add new page  🔥 Drafts 🔥 At a glance / Page counter 404s  Layout options Render multiple tabs per panel panel groups with heading and spacing between ✅ panel wrappers as grid item (e.g. stacked notices) ✅ Admin themes support AdminThemeReno and AdminThemeDefault ✅ Shortcuts panel add a table layout with icon, title & summary ✅ Chart panel add default styles for common chart types ✅ load chart data from JS file (currently passed as PHP array) Collection panel support image columns ✅ add buttons: view all & add new ✅
    • By Pip
      Hi everyone!
      I'm trying out the Login/Register module for my site. Noted that the module assigns the newly registered user to login-register role. 
      Once you modify the login-register role's permissions, particularly adding page-edit, the new member role will be set to guest. 
      Thing is I'd like to grant my new users the power to create their own pages. Any advice? 
      Thanks. 
    • By Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-07-03 -- SnipWire 0.8.7 (beta) released! Fixes some small bugs and adds an indicator for TEST mode 2020-04-06 -- SnipWire 0.8.6 (beta) released! Adds support for Snipcart subscriptions and also fixes some problems 2020-03-21 -- SnipWire 0.8.5 (beta) released! Improves SnipWires webhooks interface and provides some other fixes and additions 2020-03-03 -- SnipWire 0.8.4 (beta) released! Improves compatibility for Windows based Systems. 2020-03-01 -- SnipWire 0.8.3 (beta) released! The installation and uninstallation process has been heavily revised. 2020-02-08 -- SnipWire 0.8.2 (beta) released! Added a feature to change the cart and catalogue currency by GET, POST or SESSION param 2020-02-03 -- SnipWire 0.8.1 (beta) released! All custom classes moved into their own namespaces. 2020-02-01 -- SnipWire is now available via ProcessWire's module directory! 2020-01-30 -- SnipWire 0.8.0 (beta) first public release! (module just submitted to the PW modules directory) 2020-01-28 -- added Custom Order Fields feature (first SnipWire release version is near!) 2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Multi currency support Custom order and cart fields Process refunds and send customer notifications from within the ProcessWire backend Process Abandoned Carts + sending messages to customers from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  

       
      ---- INITIAL POST FROM 2019-05-25 ----
       
    • By Sten
      Hello
      Till now I hacked something with the twig template but it works no more with new PW versions so I look forward to create a module. I am working on a site in multiple languages : French, English, Italian, German, Spanish, Portuguese, Hebrew, Russian. The new posts are entered in any language with a field for language. Till now, I got twig files to get the translations with constants defined for each part of the pages.
      So I'd like to create a module to include theses files added according to the url /fr/en/...
      Have you some observations to do before I begin about the direction to take ?
      Thank you
    • By ukyo
      Mystique Module for ProcessWire CMS/CMF
      Github repo : https://github.com/trk/Mystique
      Mystique module allow you to create dynamic fields and store dynamic fields data on database by using a config file.
      Requirements
      ProcessWire 3.0 or newer PHP 7.0 or newer FieldtypeMystique InputfieldMystique Installation
      Install the module from the modules directory:
      Via Composer:
      composer require trk/mystique Via git clone:
      cd your-processwire-project-folder/ cd site/modules/ git clone https://github.com/trk/Mystique.git Module in live reaction with your Mystique config file
      This mean if you remove a field from your config file, field will be removed from edit screen. As you see on youtube video.
      Using Mystique with your module or use different configs path, autoload need to be true for modules
      Default configs path is site/templates/configs/, and your config file name need to start with Mystique. and need to end with .php extension.
      Adding custom path not supporting anymore !
      // Add your custom path inside your module class`init` function, didn't tested outside public function init() { $path = __DIR__ . DIRECTORY_SEPARATOR . 'configs' . DIRECTORY_SEPARATOR; Mystique::add($path); } Mystique module will search site/modules/**/configs/Mystique.*.php and site/templates/Mystique.*.php paths for Mystique config files.
      All config files need to return a PHP ARRAY like examples.
      Usage almost same with ProcessWire Inputfield Api, only difference is set and showIf usage like on example.
      <?php namespace ProcessWire; /** * Resource : testing-mystique */ return [ 'title' => __('Testing Mystique'), 'fields' => [ 'text_field' => [ 'label' => __('You can use short named types'), 'description' => __('In file showIf working like example'), 'notes' => __('Also you can use $input->set() method'), 'type' => 'text', 'showIf' => [ 'another_text' => "=''" ], 'set' => [ 'showCount' => InputfieldText::showCountChars, 'maxlength' => 255 ], 'attr' => [ 'attr-foo' => 'bar', 'attr-bar' => 'foo' ] ], 'another_text' => [ 'label' => __('Another text field (default type is text)') ] ] ]; Example:
      site/templates/configs/Mystique.seo-fields.php <?php namespace ProcessWire; /** * Resource : seo-fields */ return [ 'title' => __('Seo fields'), 'fields' => [ 'window_title' => [ 'label' => __('Window title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'attr' => [ 'placeholder' => __('Enter a window title') ] ], 'navigation_title' => [ 'label' => __('Navigation title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'showIf' => [ 'window_title' => "!=''" ], 'attr' => [ 'placeholder' => __('Enter a navigation title') ] ], 'description' => [ 'label' => __('Description for search engines'), 'type' => Mystique::TEXTAREA, 'useLanguages' => true ], 'page_tpye' => [ 'label' => __('Type'), 'type' => Mystique::SELECT, 'options' => [ 'basic' => __('Basic page'), 'gallery' => __('Gallery'), 'blog' => __('Blog') ] ], 'show_on_nav' => [ 'label' => __('Display this page on navigation'), 'type' => Mystique::CHECKBOX ] ] ]; Searching data on Mystique field is limited. Because, Mystique saving data to database in json format. When you make search for Mystique field, operator not important. Operator will be changed with %= operator.
      Search example
      $navigationPages = pages()->find('my_mystique_field.show_on_nav=1'); $navigationPages = pages()->find('my_mystique_field.page_tpye=gallery');
×
×
  • Create New...