class GreatBritainEventSubscriber in Address 8

Adds a county field and a predefined list of counties for Great Britain.

Counties are not provided by the library because they're not used for addressing. However, sites might want to add them for other purposes.

Hierarchy

• class \Drupal\address_test\EventSubscriber\GreatBritainEventSubscriber implements \Symfony\Component\EventDispatcher\EventSubscriberInterface

1 string reference to 'GreatBritainEventSubscriber'

address_test.services.yml in tests/modules/address_test/address_test.services.yml

tests/modules/address_test/address_test.services.yml

1 service uses GreatBritainEventSubscriber

address_test.great_britain_subscriber in tests/modules/address_test/address_test.services.yml

Drupal\address_test\EventSubscriber\GreatBritainEventSubscriber

File

tests/modules/address_test/src/EventSubscriber/GreatBritainEventSubscriber.php, line 17

Namespace

Drupal\address_test\EventSubscriber

class GreatBritainEventSubscriber implements EventSubscriberInterface {

  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() {
    $events[AddressEvents::ADDRESS_FORMAT][] = [
      'onAddressFormat',
    ];
    $events[AddressEvents::SUBDIVISIONS][] = [
      'onSubdivisions',
    ];
    return $events;
  }

  /**
   * Alters the address format for Great Britain.
   *
   * @param \Drupal\address\Event\AddressFormatEvent $event
   *   The address format event.
   */
  public function onAddressFormat(AddressFormatEvent $event) {
    $definition = $event
      ->getDefinition();
    if ($definition['country_code'] == 'GB') {
      $definition['format'] = $definition['format'] . "\n%administrativeArea";
      $definition['administrative_area_type'] = AdministrativeAreaType::COUNTY;
      $definition['subdivision_depth'] = 1;
      $event
        ->setDefinition($definition);
    }
  }

  /**
   * Provides the subdivisions for Great Britain.
   *
   * Note: Provides just the Welsh counties. A real subscriber would include
   * the full list, sourced from the CLDR "Territory Subdivisions" listing.
   *
   * @param \Drupal\address\Event\SubdivisionsEvent $event
   *   The subdivisions event.
   */
  public function onSubdivisions(SubdivisionsEvent $event) {

    // For administrative areas $parents is an array with just the country code.
    // Otherwise it also contains the parent subdivision codes. For example,
    // if we were defining cities in California, $parents would be ['US', 'CA'].
    $parents = $event
      ->getParents();
    if ($event
      ->getParents() != [
      'GB',
    ]) {
      return;
    }
    $definitions = [
      'country_code' => $parents[0],
      'parents' => $parents,
      'subdivisions' => [
        // Key by the subdivision code, which is the value that's displayed on
        // the formatted address. Could be an abbreviation (e.g 'CA' for
        // California) or a full name like below.
        // If it's an abbreviation, define a 'name' in the subarray, to be used
        // in the address widget dropdown.
        'Anglesey' => [],
        // You can optionally define an ISO 3166-2 code for each subdivision.
        'Blaenau Gwent' => [
          'iso_code' => 'GB-BGW',
        ],
        'Bridgend' => [],
        'Caerphilly' => [],
        'Cardiff' => [],
        'Carmarthenshire' => [],
        'Ceredigion' => [],
        'Conwy' => [],
        'Denbighshire' => [],
        'Flintshire' => [],
        'Gwynedd' => [],
        'Merthyr Tydfil' => [],
        'Monmouthshire' => [],
        'Neath Port Talbot' => [],
        'Newport' => [],
        'Pembrokeshire' => [],
        'Powys' => [],
        'Rhondda Cynon Taf' => [],
        'Swansea' => [],
        'Tarfaen' => [],
        'Vale of Glamorgan' => [],
        'Wrexham' => [],
      ],
    ];
    $event
      ->setDefinitions($definitions);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
GreatBritainEventSubscriber::getSubscribedEvents	public static	function	Returns an array of event names this subscriber wants to listen to.
GreatBritainEventSubscriber::onAddressFormat	public	function	Alters the address format for Great Britain.
GreatBritainEventSubscriber::onSubdivisions	public	function	Provides the subdivisions for Great Britain.