Allow override of default address formatter

[lukeholder]

Description

Allows replacement of the default formatter that is used by the Addresses service.

Custom Formatter class:

<?php

namespace modules;

use CommerceGuys\Addressing\AddressInterface;

class MyFormatter extends \CommerceGuys\Addressing\Formatter\DefaultFormatter
{
    public function format(AddressInterface $address, array $options = []): string
    {
        return parent::format($address, $options) . $address->phone;
    }
}

Inject into app config:

app.php

'components' => [
    'addresses' => [
        'class' => \craft\services\Addresses::class,
        'formatter' => new \modules\MyFormatter(
            new \CommerceGuys\Addressing\AddressFormat\AddressFormatRepository(),
            new \CommerceGuys\Addressing\Country\CountryRepository(),
            new \CommerceGuys\Addressing\Subdivision\SubdivisionRepository()
        )
    ],
],

Related issues and discussions

Craft:

#12615

Commerce issues:

craftcms/commerce#3152
craftcms/commerce#3082

[bossanova808]

What are the odds of this one going in fairly soon?

[brandonkelly]

@bossanova808 Just merged into the 4.5 branch.

If you want to start testing Craft 4.5 (still in development), you can change your craftcms/cms constraint in composer.json to 4.5.x-dev as 4.5.0 and run composer update.

[peteeveleigh]

Is there an estimated release date for 4.5? Are we talking days/weeks/months?
We could really use that address card formatter asap.

[brandonkelly]

@peteeveleigh Maybe a month or so. It’s pretty stable though, and there’s no new migrations (yet, at least), so if you really need a feature, it should be safe to switch over to the 4.5 branch. To do so change your craftcms/cms requirement in composer.json to 4.5.x-dev as 4.5.0-alpha and run composer update.

[peteeveleigh]

@brandonkelly Thanks for the update

[jonleverrier]

Something to take note of in the example code above. This will add the phone field to all addresses, even those that appear in PDF's (Invoices etc)