address-8.x-1.x-dev/src/Plugin/views/field/Subdivision.php

<?php

namespace Drupal\address\Plugin\views\field;

use CommerceGuys\Addressing\Locale;
use CommerceGuys\Addressing\Subdivision\SubdivisionRepositoryInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\views\Plugin\views\field\FieldPluginBase;
use Drupal\views\ResultRow;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Displays the subdivision.
 *
 * @ingroup views_field_handlers
 *
 * @ViewsField("subdivision")
 */
class Subdivision extends FieldPluginBase {

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

  /**
   * Constructs a Subdivision object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The id of the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \CommerceGuys\Addressing\Subdivision\SubdivisionRepositoryInterface $subdivision_repository
   *   The subdivision repository.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, SubdivisionRepositoryInterface $subdivision_repository) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);

    $this->subdivisionRepository = $subdivision_repository;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static(
      $configuration,
      $plugin_id,
      $plugin_definition,
      $container->get('address.subdivision_repository')
    );
  }

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['display_name'] = ['default' => TRUE];

    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    $form['display_name'] = [
      '#type' => 'checkbox',
      '#title' => $this->t('Display the subdivision name instead of the subdivision code'),
      '#default_value' => !empty($this->options['display_name']),
    ];
    parent::buildOptionsForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function render(ResultRow $values) {
    $value = $this->getValue($values);
    if (empty($value) || empty($this->options['display_name'])) {
      return $this->sanitizeValue($value);
    }

    $entity = $this->getEntity($values);
    /** @var \Drupal\address\AddressInterface $address */
    $address = $entity->{$this->definition['field_name']}->first();
    $code = '';
    $parents = [];
    switch ($this->definition['property']) {
      case 'administrative_area':
        $code = $address->getAdministrativeArea();
        $parents = [
          $address->getCountryCode(),
        ];
        break;

      case 'locality':
        $code = $address->getLocality();
        $parents = [
          $address->getCountryCode(),
          $address->getAdministrativeArea(),
        ];
        break;

      case 'dependent_locality':
        $code = $address->getDependentLocality();
        $parents = [
          $address->getCountryCode(),
          $address->getAdministrativeArea(),
          $address->getLocality(),
        ];
        break;

    }
    /** @var \CommerceGuys\Addressing\Subdivision\Subdivision $subdivision */
    $subdivision = $this->subdivisionRepository->get($code, $parents);
    if ($subdivision) {
      $use_local_name = Locale::matchCandidates($address->getLocale(), $subdivision->getLocale());
      $value = $use_local_name ? $subdivision->getLocalName() : $subdivision->getName();
    }

    return $this->sanitizeValue($value);
  }

}