Allow configuring required address comonents

[MarcMichalsky]

This is a real KISS solution. And to be honest, I am not exceedingly proud of it. But it works and I think its simple nature makes it easily understandable for everyone.

I understand this PR as a voluntary act of mine to improve this cool open source software. It's just an offer and I do not demand you to pull it. So, there's no need to send a bill. 😬

fix #47

[MarcMichalsky]

What's that part for exactly?

de.systopia.twingle/api/v3/TwingleDonation/Submit.php

Lines 332 to 334 in 4659b53

	if ($address_param != $address_component) {
	unset($params[$address_param]);
	}

[jensschuppe]

This removes e.g. the user_street element from the $params array, since its value is being set to the internal CiviCRM parameter name (street_address) and the original parameter (user_street) is not needed anymore.

[MarcMichalsky]

This removes e.g. the user_street element from the $params array, since its value is being set to the internal CiviCRM parameter name (street_address) and the original parameter (user_street) is not needed anymore.

But the condition is always true because the array is hard coded.

EDIT: Okay, I got it, it's always true but for the gender_id.

[jensschuppe]

But the condition is always true because the array is hard coded.

It is. I think I imagined new parameters could have the same name and the code would be prepared for it. Consider it a foresighted clean-up ;-)

[bjendres]

@jensschuppe, any objections to pulling this? It looks sensible and @mariav0 confirmed that it works for her... And afaik there's no other address parameters submitted by twingle.

[jensschuppe]

@bjendres I haven't merged it yet, because

• it changes current behavior (someone might rely on addresses containing country only)
• we should therefore think about making this configurable per profile
• we should maybe flip the logic (if nothing else than country instead of not everything but country - with "everything" being hard-coded; i.e. use an array_diff() or similar)
• it does not check for empty address parameters (only for whether they exist with array_key_exists()

[MarcMichalsky]

@jensschuppe

it does not check for empty address parameters (only for whether they exist with array_key_exists()

As far as I know, Twingle does not submit empty fields. But I can check this, if you want.

[MarcMichalsky]

Okay, I checked it: Twingle does submit empty address data fields. So we should include another check

[jensschuppe]

@MarcMichalsky Could you rebase this on the current master since #53 changed some code in the TwingleDonation.submit API code and I'd like that to not interfere with your work.

[MarcMichalsky]

Okay, that should be it.
I have made the required address components configurable in the profile.

The check for empty address parameters is already done here:

de.systopia.twingle/api/v3/TwingleDonation/Submit.php

Lines 324 to 336 in 1975639

	foreach (array(
	'user_street' => 'street_address',
	'user_postal_code' => 'postal_code',
	'user_city' => 'city',
	'user_country' => 'country',
	) as $address_param => $address_component) {
	if (!empty($params[$address_param])) {
	$params[$address_component] = $params[$address_param];
	if ($address_param != $address_component) {
	unset($params[$address_param]);
	}
	}
	}

[MarcMichalsky]

Sorry, I had a knot in my brain here. 🧠

[jensschuppe]

I did some slight changes in 6779349 and merged to master. This should be backwards-compatible due to the new configuration option. However, it defaults to requiring street, postal code, city and country for new profiles, but that seems reasonable to me.

@MarcMichalsky you might want to re-run your tests on that, but the code looks good to me. I went ahead merging it in order to move on towards a pre-release.