Recurly_CurrencyList should implement Iterator interface

[quicksketch]

Right now I can't find a way to see which currencies are inside the Recurly_CurrencyList class. Because $currencies is declared as private, there's no way I can get a list of which currencies are in the list. I suppose I could caste to a string and then explode on commas, but that seems awfully hackish.

I think it would be best if Recurly_CurrencyList implemented the Iterator interface (http://us.php.net/manual/en/class.iterator.php), so you could do things like this:

<?php
foreach ($plan->unit_amount_in_cents as $currency_code => $currency) {
  print $currency->amount() . ' ' . $currency_code
}
?>

Which would print out

50.00 USD
40.00 EUR
30.00 GBP
etc.

[kainosnoema]

@quicksketch that would probably be useful to have, but remember that the only currencies provided will be ones supported by your site. This info can be obtained by logging into your Recurly account. Simply iterating over the currency strings ('USD', 'EUR', 'GBP', etc) and accessing the values in the Recurly_CurrencyList using ArrayAccess like so: $plan->unit_amount_in_cents['USD'] is almost as easy as the example you gave above.

Thanks for the suggestion though, we'll add it to our to-do list. You're welcome to submit a pull-request if you'd like to get it in quickly.

[quicksketch]

This info can be obtained by logging into your Recurly account.

Right, but if you're building integration with a CMS (Drupal in this case), I have no idea what currencies the users of my Drupal module will be using. I suppose I could ask them to list the currencies manually in an administrative interface, but that seems unnecessary considering the Recurly API.

As an interesting workaround I found that calling reset() on the object will give me the array of currencies that I can loop over. I can't say I understand why this works though. To prevent problems with Iterator is actually implemented, I added a ternary operator, since reset() on an actual array would give you the first item, not the array itself.

<?php
$currencies = in_array('Iterator', class_implements($plan->unit_amount_in_cents)) ? $plan->unit_amount_in_cents : reset($plan->unit_amount_in_cents);
foreach ($currencies as $currency) {
  print $currency->amount() . ' ' . $currency->currencyCode;
}
?>

EDIT: Updated example with ternary.

[kainosnoema]

@quicksketch great example of a use-case where having an iterable list is important. I think that's something we'd like to support.

I can't for the life of me understand why reset() gives you an array, but would it be possible to check whether Recurly_CurrencyList implements Iterator before calling reset() on it? That would allow you to ensure forwards compatibility when we fix that.

[quicksketch]

but would it be possible to check whether Recurly_CurrencyList implements Iterator before calling reset() on it?

Yep! I thought the same thing after posting my comment. I updated it so that others don't blindly copy/paste the previous version.

[kainosnoema]

@quicksketch pull #33 has a great solution to this, and I've asked @nicholasrawlings if he wouldn't mind adding the fix to Recurly_CurrencyList as well.

[kainosnoema]

Just pulled in commits from pull #33, which fixes this.