You are here

Home » API reference » Address 8 » ZoneDefaultFormatter.php

class ZoneDefaultFormatter in Address 8

Plugin implementation of the 'address_zone_default' formatter.

Plugin annotation


@FieldFormatter(
  id = "address_zone_default",
  label = @Translation("Default"),
  field_types = {
    "address_zone"
  }
)

Hierarchy

Expanded class hierarchy of ZoneDefaultFormatter

File

src/Plugin/Field/FieldFormatter/ZoneDefaultFormatter.php, line 29

Namespace

Drupal\address\Plugin\Field\FieldFormatter
View source 
class ZoneDefaultFormatter extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * The address format repository.
   *
   * @var \CommerceGuys\Addressing\AddressFormat\AddressFormatRepositoryInterface
   */
  protected $addressFormatRepository;

  /**
   * The country repository.
   *
   * @var \CommerceGuys\Addressing\Country\CountryRepositoryInterface
   */
  protected $countryRepository;

  /**
   * The subdivision repository.
   *
   * @var \CommerceGuys\Addressing\Subdivision\SubdivisionRepositoryInterface
   */
  protected $subdivisionRepository;

  /**
   * Constructs a ZoneDefaultFormatter object.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Any third party settings.
   * @param \CommerceGuys\Addressing\AddressFormat\AddressFormatRepositoryInterface $address_format_repository
   *   The address format repository.
   * @param \CommerceGuys\Addressing\Country\CountryRepositoryInterface $country_repository
   *   The country repository.
   * @param \CommerceGuys\Addressing\Subdivision\SubdivisionRepositoryInterface $subdivision_repository
   *   The subdivision repository.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, AddressFormatRepositoryInterface $address_format_repository, CountryRepositoryInterface $country_repository, SubdivisionRepositoryInterface $subdivision_repository) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->addressFormatRepository = $address_format_repository;
    $this->countryRepository = $country_repository;
    $this->subdivisionRepository = $subdivision_repository;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('address.address_format_repository'), $container
      ->get('address.country_repository'), $container
      ->get('address.subdivision_repository'));
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    if (!empty($items)) {
      $elements = [
        '#type' => 'container',
        '#cache' => [
          'contexts' => [
            'languages:' . LanguageInterface::TYPE_INTERFACE,
          ],
        ],
      ];
      foreach ($items as $delta => $item) {
        $elements[$delta] = $this
          ->viewElement($item->value, $langcode);
      }
    }
    return $elements;
  }

  /**
   * Builds a renderable array for a single zone item.
   *
   * @param \CommerceGuys\Addressing\Zone\Zone $zone
   *   The zone.
   * @param string $langcode
   *   The language that should be used to render the field.
   *
   * @return array
   *   A renderable array.
   */
  protected function viewElement(Zone $zone, $langcode) {
    $countries = $this->countryRepository
      ->getList();
    $element = [
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'zone',
        ],
      ],
    ];
    if ($label = $zone
      ->getLabel()) {
      $element['label'] = [
        '#type' => 'item',
        '#attributes' => [
          'class' => [
            'label',
          ],
        ],
        '#plain_text' => $label,
      ];
    }
    foreach ($zone
      ->getTerritories() as $index => $territory) {
      $country_code = $territory
        ->getCountryCode();
      $address_format = $this->addressFormatRepository
        ->get($country_code);
      $labels = LabelHelper::getFieldLabels($address_format);
      $element['territories'][$index] = [
        '#type' => 'container',
        '#attributes' => [
          'class' => [
            'zone-territory',
          ],
        ],
      ];
      $element['territories'][$index]['country'] = [
        '#type' => 'item',
        '#title' => $this
          ->t('Country'),
        '#attributes' => [
          'class' => [
            'country',
          ],
        ],
        '#plain_text' => $countries[$country_code],
      ];
      if ($administrative_area = $territory
        ->getAdministrativeArea()) {
        $administrative_areas = $this->subdivisionRepository
          ->getList([
          $country_code,
        ]);
        $administrative_area_name = $administrative_area;
        if (isset($administrative_areas[$administrative_area])) {
          $administrative_area_name = $administrative_areas[$administrative_area];
        }
        $element['territories'][$index]['administrative_area'] = [
          '#type' => 'item',
          '#title' => $labels[AddressField::ADMINISTRATIVE_AREA],
          '#attributes' => [
            'class' => [
              'administrative-area',
            ],
          ],
          '#plain_text' => $administrative_area_name,
        ];
      }
      if ($locality = $territory
        ->getLocality()) {
        $localities = $this->subdivisionRepository
          ->getList([
          $country_code,
          $administrative_area,
        ]);
        $locality_name = $locality;
        if (isset($localities[$locality])) {
          $locality_name = $localities[$locality];
        }
        $element['territories'][$index]['locality'] = [
          '#type' => 'item',
          '#title' => $labels[AddressField::LOCALITY],
          '#attributes' => [
            'class' => [
              'locality',
            ],
          ],
          '#plain_text' => $locality_name,
        ];
      }
      if ($dependent_locality = $territory
        ->getDependentLocality()) {
        $dependent_localities = $this->subdivisionRepository
          ->getList([
          $country_code,
          $administrative_area,
          $locality,
        ]);
        $dependent_locality_name = $dependent_locality;
        if (isset($dependent_localities[$dependent_locality])) {
          $dependent_locality_name = $dependent_localities[$dependent_locality];
        }
        $element['territories'][$index]['dependent_locality'] = [
          '#type' => 'item',
          '#title' => $labels[AddressField::DEPENDENT_LOCALITY],
          '#attributes' => [
            'class' => [
              'dependent-locality',
            ],
          ],
          '#plain_text' => $dependent_locality_name,
        ];
      }
      if ($included_postal_codes = $territory
        ->getIncludedPostalCodes()) {
        $element['territories'][$index]['included_postal_codes'] = [
          '#type' => 'item',
          '#title' => $this
            ->t('Included postal codes'),
          '#attributes' => [
            'class' => [
              'included-postal-codes',
            ],
          ],
          '#plain_text' => $included_postal_codes,
        ];
      }
      if ($excluded_postal_codes = $territory
        ->getExcludedPostalCodes()) {
        $element['territories'][$index]['excluded_postal_codes'] = [
          '#type' => 'item',
          '#title' => $this
            ->t('Excluded postal codes'),
          '#attributes' => [
            'class' => [
              'excluded-postal-codes',
            ],
          ],
          '#plain_text' => $excluded_postal_codes,
        ];
      }
    }
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterInterface::settingsForm 24
FormatterBase::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterInterface::settingsSummary 22
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 42
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
ZoneDefaultFormatter::$addressFormatRepository protected property The address format repository.
ZoneDefaultFormatter::$countryRepository protected property The country repository.
ZoneDefaultFormatter::$subdivisionRepository protected property The subdivision repository.
ZoneDefaultFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
ZoneDefaultFormatter::viewElement protected function Builds a renderable array for a single zone item.
ZoneDefaultFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
ZoneDefaultFormatter::__construct public function Constructs a ZoneDefaultFormatter object. Overrides FormatterBase::__construct