Provide sub-property setters and getters for Mailchimp List Fields [#2578697]

The Mailchimp list field only provides coarse access to the subscription details: a setter and getter for the field value directly, but the subscription data actual contains structured data: a "subscription" boolean and an array of interest group preferences. The field should provide direct setters and getters for these as well.

Comment	File	Size	Author
#9	provide_subscription_field_setters_getters-2578697-9.patch	1.09 KB	wxactly
#9	7.x-4.x: PHP 5.5 & MySQL 5.5, D7 Skipped, branch did not pass for 4 weeks PHP 5.6 & MySQL 5.5, D7 Skipped, branch did not pass for 4 weeks
#4	provide_subscription_field_setters_getters-2578697-4.patch	1.13 KB	wxactly
#4
#3	provide_subscription_field_setters_getters-2578697.patch	1.13 KB	wxactly
#3
#2	provide_deep_field_setters_getters-2578697.patch	4.16 KB	gcb
#2	7.x-4.x: PHP 5.5 & MySQL 5.5, D7 Skipped, branch did not pass for 4 weeks PHP 5.6 & MySQL 5.5, D7 Skipped, branch did not pass for 4 weeks

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

1 October 2015 at 22:23

gcb created an issue. See original summary.

Comment #2

gcb

he/him

CreditAttribution: gcb at ThinkShout commented 1 October 2015 at 22:25

Status:

Active

» Needs work

File	Size
provide_deep_field_setters_getters-2578697.patch	4.16 KB
7.x-4.x: PHP 5.5 & MySQL 5.5, D7 Skipped, branch did not pass for 4 weeks PHP 5.6 & MySQL 5.5, D7 Skipped, branch did not pass for 4 weeks

Initial work on a patch attached: this needs work.

Comment #3

wxactly CreditAttribution: wxactly at ThinkShout commented 13 October 2015 at 18:29

File	Size
provide_subscription_field_setters_getters-2578697.patch	1.13 KB

Here's a patch that provides sub-property getters and setters for "subscribed" and "interest groups" without going any deeper into the nested MailChimp API structure for the groups. This enables property access, like:

$entity->field->subscribe->value();
$entity->field->interest_groups->value();

Comment #4

wxactly CreditAttribution: wxactly at ThinkShout commented 15 October 2015 at 20:59

File	Size
provide_subscription_field_setters_getters-2578697-4.patch	1.13 KB

Updated patch. MailChimp's data structure was failing validation for the "list" type, so changed to "struct".

Comment #5

nlarow CreditAttribution: nlarow as a volunteer commented 9 November 2015 at 19:12

Wxactly,

I've applied your more recent patch (I've tried and reverted all 3 in this topic to be honest..) and I was able to see the new token:variables exposed in "help/tokens".. but I'm running into a real problem actually using the new token for "field:interest_groups" in an email template as I cannot get it to output anything other than the word "Property".

Note that "field:subscribe" works and returns a true/false value... it's just the "field:interest_groups" that appear to not work..

Any input? Much appreciated.

Regards,
Nicholaus

Comment #6

nlarow CreditAttribution: nlarow as a volunteer commented 9 November 2015 at 19:24

Priority:

Normal

» Major

Comment #7

wxactly CreditAttribution: wxactly at ThinkShout commented 11 November 2015 at 18:21

@nlarow - The data structure for interest groups is a complex multi-dimensional array. Unfortunately the simple patch I added here isn't going to help you very much for using interest groups in tokens. You'll need something more like what @gcb started in his first patch... though, as he noted, it needs some serious work. If someone wants to jump in and give it another shot, I think the first patch here is a decent starting point. I actually tried to jump in and add full nested support for the multi-dimensional data structure myself, but it was just getting too complicated so I scrapped it and went the simpler route instead.

Comment #8

ruscoe CreditAttribution: ruscoe at ThinkShout for Mailchimp commented 4 October 2016 at 17:30

Status:

Needs work

» Closed (won't fix)

We're going to be ending support for the 7.x-3.x branch due to the upcoming deprecation of the v2.0 MailChimp API. If you're still interested in this feature, please feel free to reopen for the 7.x-4.x branch.

Comment #9

wxactly CreditAttribution: wxactly at ThinkShout commented 5 October 2016 at 20:03

File	Size
provide_subscription_field_setters_getters-2578697-9.patch	1.09 KB
7.x-4.x: PHP 5.5 & MySQL 5.5, D7 Skipped, branch did not pass for 4 weeks PHP 5.6 & MySQL 5.5, D7 Skipped, branch did not pass for 4 weeks

2 files were hidden/shown/deleted

File	Size
provide_subscription_field_setters_getters-2578697.patch	1.13 KB

provide_subscription_field_setters_getters-2578697-4.patch	1.13 KB

#4 is still relevant, so I re-rolled this patch. This is an easy win which adds sub-property getters and setters for "subscribed" boolean and "interest groups" struct:

$entity->field->subscribe->value();
$entity->field->interest_groups->value();

Comment #10

wxactly CreditAttribution: wxactly at ThinkShout commented 5 October 2016 at 20:05

Version:	7.x-3.x-dev	» 7.x-4.x-dev
Status:	Closed (won't fix)	» Needs review

Comment #11

samuel.mortenson

he/him

English

CreditAttribution: samuel.mortenson commented 22 April 2019 at 21:21

Status:

Needs review

» Closed (won't fix)

We’re in maintenance-mode for the Drupal 7 releases of Mailchimp, so only bug fixes can be committed going forward. Any new features should be developed for the Drupal 8 releases of Mailchimp. Thanks!