Join forces with Webform Tokens

OK, looks like I will be contributing something towards this because I just discovered that Webform Rules breaks filling in PDFs with Webform submissions (I think we are clashing on the webform namespace). Step 1 for me is to change the Webform Rules token namespace to satisfy the immediate client need. I'll post the patch, though I can't imagine that's in your interest to commit...still, maybe it'll spark conversation.

Next step would be to tell Webform Rules to use Webform Tokens tokens if available (otherwise fall back to its own, which will be re-namespaced) and to write the appropriate Rules integration (and calling of token_replace for the same.

Gradually the native support can be phased out, or perhaps this could go in a new branch...your call...just suggestions.

OK, I actually did the whole thing. Rules now replaces the tokens properly, and Webform Rules has a hard dependency on Webform Tokens.

I had to change the data structure to conform to what Webform Tokens expects. You're welcome to submit a patch changing said data structure to Webform Tokens...but I think that the structure that webform_get_submission uses is a pretty good one to bank on, and that's why we went with it in Webform Tokens (see Fill PDF's token_replace for webform for an example of another consumer).

This should definitely go in a new branch if you're game for that so that it doesn't mess up people using Webform Rules tokens. Or you could write hook_token_info_alter() and hook_tokens_alter() if backward compatibility is big...but it seems like a lot of work for little gain. I think someone could contribute that patch if they needed the old token structure in the new branch.

Potential issues that I can see:

1. I noticed you had some formatting code in your version of token replacement. I didn't take time to understand that, but if you can tell me what that was about, maybe I or Liam can put it into Webform Tokens.
2. You did some data massaging to turn the $submission object into field-name-indexed arrays. I'm guessing you did this to make rules that use the $data object more portable. Unfortunately, that structure was making Webform Tokens's token replacement fail, so I moved those to a webform_rules property on the $data object. So people using PHP code will have to use that in order to have portable configuration...for now.

Hope this helps! And I eagerly look forward to having a second module using Webform Tokens :) - keep in touch...when we work this out I can mention Webform Rules on the WT project page.

Yeah, re-namespacing yours to webform-submission would also do the trick. Then you could implement webform in hook_rules_data_info() if module_exists('webform_tokens') is true, as well as the other integration points I added/modified.

So coming back around to this...I think your approach is fine. Also, note that the new Webform 4.x branch has its own Token implementation. Fill PDF is planning to detect Webform version and still support Webform 3.x (which has none) via Webform Tokens and use native Webform tokens for 4.x (perhaps initially providing an integration layer for tokens Webform might not have implemented yet, and deprecating it once they do).

Anyway, about to apply this patch again so will RTBC it if it doesn't conflict with Webform Tokens.

This works fine; I say commit it if you agree.

What do you mean? You merge them, so yours will continue working. Migration can be manual, but the patch won't break the tokens.

If you mean the Webform 4.x tokens, then I think that's a separate issue to tackle. So let me know.

We addressed this on the Webform Tokens side: #1934340: Conflict with Webform Rules: Re-namespace Webform Tokens tokens

You shouldn't need this anymore with the latest FillPDF and Webform Tokens versions. it's all fixed.